MRenderOverride Class Reference

MRenderOverride Class Reference
+ Related help topics:

#include <MViewport2Renderer.h>

Class Description

Public Member Functions

 MRenderOverride (const MString &name)
 Constructor for a name render override. More...
 
virtual ~MRenderOverride ()
 Default destructor for a render override.
 
virtual MHWRender::DrawAPI supportedDrawAPIs () const
 Returns the draw API supported by this override. More...
 
virtual bool startOperationIterator ()
 In order for an override to indicate the set of operations that are to be performed it must implement overrides for the iterator methods on the override: More...
 
virtual MRenderOperationrenderOperation ()
 Return the current operation being iterated over. More...
 
virtual bool nextRenderOperation ()
 Iterate to the next operation. More...
 
const MStringname () const
 Query the name of the override. More...
 
virtual MString uiName () const
 Query the user interface name for the override. More...
 
virtual MStatus setup (const MString &destination)
 Perform any setup required before render operations are to be executed. More...
 
virtual MStatus cleanup ()
 Perform any cleanup required following the execution of render operations. More...
 
const MFrameContextgetFrameContext () const
 Return frame context. More...
 

Friends

class M3dView
 

Constructor & Destructor Documentation

MRenderOverride ( const MString name)

Constructor for a name render override.

Parameters
[in]nameName of render override

Member Function Documentation

bool startOperationIterator ( )
virtual

In order for an override to indicate the set of operations that are to be performed it must implement overrides for the iterator methods on the override:

The order that the operations are returned via these methods determines the order that the operations are invoked.

If there is a user operation (MUserRenderOperation) the execute() method for that operation will be called when the operation is invoked.

Note that the ordering will not change during one invocation of an override which is delimited by the setup() and cleanup() calls.

This particular method is called to allow the override to start iterating over a list of operations to be performed by the override.

The operations that are returned can be thought of as representing a "command list". This command list will perform in order from start to end.

Pseudo-code for the internal Maya iteration logic would look something like this:

MRenderOverride override;
if (override.startOperationIterator())
{
	--> Get operation
	MRenderOperation *op = override.renderOperation();
	while (op)
	{
		if (op)
			--> Add to "list" of operations to perform
        --> Iterate to next operation
		if (!override.nextRenderOperation())
			op = NULL;
		else
			op = override.renderOperation();
	}
}
Returns
True if there are any operations to iterate over. Note that an override with no operations will basically mean that the override draws nothing. In this case the renderer will perform it's default rendering operations.
+ Examples:
const MString & name ( ) const

Query the name of the override.

Returns
Name of the override
+ Examples:
MStatus setup ( const MString destination)
virtual

Perform any setup required before render operations are to be executed.

The default behaviour performs no actions.

An override is called once per render. The order of method calls when an override is called is as follows:

Parameters
[in]destinationString identifier which gives an indication as to where this override is being applied. Presently this will return a viewport panel name for interactive rendering.
Returns
Status code. MStatus::kSuccess is returned by default.
Status Codes:
+ Examples:
const MHWRender::MFrameContext * getFrameContext ( ) const

Return frame context.

The context is not available if called before setup() or after cleanup().

Returns
Pointer to frame context. The context should never be deleted by the plug-in as it is owned by the render override.

The documentation for this class was generated from the following files:
  • MViewport2Renderer.h
  • MViewport2Renderer.cpp