class MViewportRenderer

Jump to documentation

public members:

typedef enum	{///RendereruseshardwareOpenGLforrenderingkOpenGL,///RendereruseshardwareDirect3DforrenderingkDirect3D,///RendererrendersusingsoftwarekSoftware}RenderingAPI API used for rendering
typedef enum	{///OverridenothingkNoOverride,///OverridealldrawingkOverrideAllDrawing}RenderingOverride Override status
	MViewportRenderer (const MString & name ) Constructor
virtual	~MViewportRenderer () Destructor
virtual MStatus	initialize () Renderer initialization. Must be overridden.
virtual MStatus	uninitialize () Renderer de-initialization. Must be overridden.
virtual MStatus	render ( const MRenderingInfo &info ) Rendering method. Must be overridden.
virtual bool	nativelySupports ( MViewportRenderer::RenderingAPI api, float version ) Query the native rendering API's supported by this renderer. Must be overridden.
virtual bool	override ( MViewportRenderer::RenderingOverride override ) Check if override exists
MStatus	registerRenderer () const
MStatus	deregisterRenderer () const
const MString &	name () const
const MString &	UIname () const
void	setUIName (const MString & name )
MViewportRenderer::RenderingOverride	renderingOverride () const

Documentation

Description

MViewportRenderer is a class which represents a hardware viewport renderer.

Functions

MViewportRenderer:: MViewportRenderer (const MString & name )

Description

Constructor. By default the user interface name is set to be the internal name. The user is free to change the UI. The internal name cannot be changed once set.

Arguments

• name : internal name of the renderer

MViewportRenderer:: ~MViewportRenderer ()

Description

Class destructor.

MStatus MViewportRenderer:: initialize ()

Description

This method gets called to allow the renderer to perform a one time initialization. The corresponding method for cleanup is uninitialize().

Initialization is called if and only if the renderer has been registered. See register() method.

Return Value

• MStatus::kSuccess : if execution was successful.

MStatus MViewportRenderer:: uninitialize ()

Description

This method gets called to allow the renderer to perform a one time de-initialization. The corresponding method for cleanup is initialize().

Return Value

• MStatus::kSuccess : if execution was successful.

MStatus MViewportRenderer:: render ( const MRenderingInfo &info )

Description

This method gets called to allow the renderer to perform rendering. It will be called whenever the viewport to which it is registered, requires a refresh.

Return Value

• MStatus::kSuccess : if execution was successful.

bool MViewportRenderer:: override ( MViewportRenderer::RenderingOverride override )

Description

This method gets called to query the renderer to see if it has a given type of render target override.

Arguments

• override : render target override

Return Value

• true : if the renderer overrides the render target override.

MStatus MViewportRenderer:: registerRenderer () const

Description

Register the renderer. Registration should occur when the plugin is initialized. A renderer will be available for usage from 3d modeling viewports if and only if it has been registered.

Additionally, the initialization method initialize() will be made only if a renderer has been registered.

Arguments

• None

Return Value

• MStatus::kSuccess : if execution was successful.

MStatus MViewportRenderer:: deregisterRenderer () const

Description

Deregister the renderer. Deregistration should occur when the plugin is unloaded.

Arguments

• None

Return Value

• MStatus::kSuccess : if execution was successful.

const MString & MViewportRenderer:: name () const

Description

Return the internal name of the renderer

Arguments

• None

Return Value

• renderer name

const MString & MViewportRenderer:: UIname () const

Description

Return the user interface name of the renderer

Arguments

• None

Return Value

• UI renderer name

void MViewportRenderer:: setUIName (const MString & name )

Description

Set the user interface name of the renderer.

Arguments

• name : name to set

Return Value

• None.

bool MViewportRenderer:: nativelySupports ( MViewportRenderer::RenderingAPI api, float version )

Description

Query the renderer to see if the renderer can natively support a specific API and API version number. This is to provide compatibility checks between the drawing API used for the render target of this renderer, and the renderer itself.

As an example the render target may be using OpenGL natively while the renderer associated with the render target is using Direct3D. In this case the method should return false.

As an example the render target may be using Direct3D version K natively while the renderer associated with the render target is using Direct3D version L. In this case the method may return false.

Arguments

• api : rendering API natively used by the render target
• version : rendering API version of the API natively used by the render target

Return Value

• MViewportRenderer::RenderingAPI : rendering API.

MViewportRenderer::RenderingOverride MViewportRenderer:: renderingOverride () const

Description

Get the rendering API version number

Arguments

• None

Return Value

• API version number.

void MViewportRenderer:: setRenderingOverride ( RenderingOverride override )

Description

Set the rendering override for the renderer.

Arguments

• override : override value to set

Return Value

• None.

This class has no child classes.