MRenderPassDef Class Reference
[OpenMayaRender - API module for rendering]

#include <MRenderPassDef.h>

List of all members.


Detailed Description

Render pass information.

This class provides a means to access information about a specific render pass. Initialize by passing to MRenderPassRegistry::getRenderPassDefinition(), or by calling create() to generate and register a new pass.

Public Member Functions

virtual ~MRenderPassDef ()
MPxRenderPassImplgetImplementation (const MString &renderer, MPxRenderPassImpl::PassTypeBit fbType, unsigned int numChannels, MStatus *ReturnStatus=NULL)
MPxRenderPassImplgetImplementation (const MString &renderer, MStatus *ReturnStatus=NULL)
MString getID (MStatus *ReturnStatus=NULL) const
MString getName (MStatus *ReturnStatus=NULL) const
MString getGroup (MStatus *ReturnStatus=NULL) const
MString getDescription (MStatus *ReturnStatus=NULL) const
MString getAttributeType (const MString &attributeName, MStatus *ReturnStatus=NULL) const
MStatus addFloatParameter (const MString &longName, const MString &shortName, const MString &UIName, const float &minValue, const float &maxValue, const float &defaultValue)
MStatus addDoubleParameter (const MString &longName, const MString &shortName, const MString &UIName, const double &minValue, const double &maxValue, const double &defaultValue)
MStatus addIntParameter (const MString &longName, const MString &shortName, const MString &UIName, const int &minValue, const int &maxValue, const int &defaultValue)

Friends

class MRenderPassRegistry
class MFnPlugin


Constructor & Destructor Documentation

MRenderPassDef::~MRenderPassDef (  )  [virtual]

Destructor


Member Function Documentation

MPxRenderPassImpl * MRenderPassDef::getImplementation ( const MString renderer,
MPxRenderPassImpl::PassTypeBit  fbType,
unsigned int  numChannels,
MStatus ReturnStatus = NULL 
)

Retrieve an implementation of this render pass for the given renderer. That supports the specified data type and the specified number of channels.

Arguments

  • renderer The renderer
  • fbType The base data type of the frame buffer
  • numChannels The number of components per pixel in the frame buffer
  • ReturnStatus Storage for status code
Returns:
A pointer to the pass implementation or null if no definition exists
Status Codes

MPxRenderPassImpl * MRenderPassDef::getImplementation ( const MString renderer,
MStatus ReturnStatus = NULL 
)

Retrieve an implementation of this render pass for the given renderer.

Parameters:
[in] renderer The renderer
[out] ReturnStatus Storage for status code
Returns:
A pointer to the pass implementation or null if no definition exists
Status Codes:

MString MRenderPassDef::getID ( MStatus ReturnStatus = NULL  )  const

Retrieve the pass ID for this pass.

Parameters:
[out] ReturnStatus Storage for status code
Returns:
The pass ID
Status Codes:

MString MRenderPassDef::getName ( MStatus ReturnStatus = NULL  )  const

Retrieve the pass name for this pass

Parameters:
[out] ReturnStatus Storage for status code
Returns:
The pass name
Status Codes:

MString MRenderPassDef::getGroup ( MStatus ReturnStatus = NULL  )  const

Retrieve the pass group for this pass

Parameters:
[out] ReturnStatus Storage for status code
Returns:
The pass group
Status Codes:

MString MRenderPassDef::getDescription ( MStatus ReturnStatus = NULL  )  const

Retrieve the description for this pass

Parameters:
[out] ReturnStatus Storage for status code
Returns:
The description
Status Codes:

MString MRenderPassDef::getAttributeType ( const MString attributeName,
MStatus ReturnStatus = NULL 
) const

Retrieve the type of a given render pass attribute

Parameters:
[in] attributeName The name of the render pass attribute to query.
Returns:
The type of the given attribute.

MStatus MRenderPassDef::addFloatParameter ( const MString longName,
const MString shortName,
const MString UIName,
const float &  minValue,
const float &  maxValue,
const float &  defaultValue 
)

Define a single-precision floating-point parameter for the pass

Parameters:
[in] longName The full name of the parameter
[in] shortName The short name of the parameter
[in] minValue The minimum value of the parameter
[in] maxValue The maximum value of the parameter
[in] defaultValue The default value of the parameter
Returns:
Status
Status Codes:

MStatus MRenderPassDef::addDoubleParameter ( const MString longName,
const MString shortName,
const MString UIName,
const double &  minValue,
const double &  maxValue,
const double &  defaultValue 
)

Define a double-precision floating-point parameter for the pass

Parameters:
[in] longName The full name of the parameter
[in] shortName The short name of the parameter
[in] minValue The minimum value of the parameter
[in] maxValue The maximum value of the parameter
[in] defaultValue The default value of the parameter
Returns:
Status
Status Codes:

MStatus MRenderPassDef::addIntParameter ( const MString longName,
const MString shortName,
const MString UIName,
const int &  minValue,
const int &  maxValue,
const int &  defaultValue 
)

Define an integer parameter for the pass

Parameters:
[in] longName The full name of the parameter
[in] shortName The short name of the parameter
[in] minValue The minimum value of the parameter
[in] maxValue The maximum value of the parameter
[in] defaultValue The default value of the parameter
Returns:
Status
Status Codes:


Autodesk® Maya® 2009 © 1997-2008 Autodesk, Inc. All rights reserved. Generated with doxygen 1.5.6