MUserRenderOperation Class Reference

This reference page is linked to from the following overview topics: Rendering Overrides, 3.6 Render Loop Overrides.



Detailed Description

Class which defines a user defined rendering operation.

#include <MViewport2Renderer.h>

Inheritance diagram for MUserRenderOperation:

List of all members.

Public Member Functions

 MUserRenderOperation (const MString &name)
 Constructor for named user render operation.
virtual ~MUserRenderOperation ()
 Default destructor for a user render operation.
virtual const MCameraOverridecameraOverride ()
 Query for a camera override.
virtual MStatus execute (const MDrawContext &drawContext)=0
 Each user operation is responsible for "executing" itself.

Constructor & Destructor Documentation

MUserRenderOperation ( const MString name)

Constructor for named user render operation.

Parameters:
[in]nameName of render operation

Member Function Documentation

const MCameraOverride * cameraOverride ( ) [virtual]

Query for a camera override.

The default implementation returns that there is no override.

Returns:
Reference to the camera override. NULL if there is no override.
MStatus execute ( const MDrawContext drawContext) [pure virtual]

Each user operation is responsible for "executing" itself.

Parameters:
[in]drawContextHardware draw context information

Refer the the documentation for MRenderOverride::startOperationIterator() which describes when this method will be invoked.

Returns:
Status code
Status Codes:

MUserRenderOperation MUserRenderOperation MUserRenderOperation MUserRenderOperation MUserRenderOperation MUserRenderOperation MUserRenderOperation MUserRenderOperation MUserRenderOperation MUserRenderOperation
MUserRenderOperation MUserRenderOperation MUserRenderOperation MUserRenderOperation MUserRenderOperation MUserRenderOperation MUserRenderOperation MUserRenderOperation MUserRenderOperation MUserRenderOperation