C++ API Reference
Public Member Functions | List of all members
MGeometryRequirementsLegacy Class Reference
OpenMayaRender - API module for rendering

MGeometryRequirementsLegacy stores the collection of MGeometryRequirementsData arrays which describe a Maya surface, including per-component data such as UV mapping and colour. More...

#include <MGeometryRequirements.h>

Public Member Functions

 MGeometryRequirementsLegacy ()
 Default constructor. More...
 
 ~MGeometryRequirementsLegacy ()
 Destructor.
 
void addPosition (int dimension=3)
 Add position to the set of required elements. More...
 
void addComponentId ()
 Add component id to the set of required elements.
 
void addNormal (int dimension=3)
 Add normal to the set of required elements. More...
 
void addTexCoord (const MString &uvSetName)
 Add a texture coordinate set to the list of required elements. More...
 
void addTangent (const MString &uvSetName, int dimension=3)
 Add a tangent set to the list of required elements. More...
 
void addBinormal (const MString &uvSetName, int dimension=3)
 Add a binormal set to the list of required elements. More...
 
void addColor (const MString &colorSetName)
 Add a color set to the list of required elements. More...
 
void addFaceOffsets ()
 Add face offsets to the set of required elements. More...
 

Detailed Description

MGeometryRequirementsLegacy stores the collection of MGeometryRequirementsData arrays which describe a Maya surface, including per-component data such as UV mapping and colour.

Examples:
hlslShader/hlslShader.cpp.

Constructor & Destructor Documentation

OPENMAYA_MAJOR_NAMESPACE_OPEN MGeometryRequirementsLegacy ( )

Default constructor.

Initialized to no requirements.

Member Function Documentation

void addPosition ( int  dimension = 3)

Add position to the set of required elements.

Parameters
[in]dimensionthe size of the position requirement. Valid values are 3 and 4. Default is 3.
Examples:
hlslShader/hlslShader.cpp.
void addNormal ( int  dimension = 3)

Add normal to the set of required elements.

Parameters
[in]dimensionthe size of the normal requirement. Valid values are 3 and 4. Default is 3.
Examples:
hlslShader/hlslShader.cpp.
void addTexCoord ( const MString &  name)

Add a texture coordinate set to the list of required elements.

Parameters
[in]namethe name of the uv set to add
Examples:
hlslShader/hlslShader.cpp.
void addTangent ( const MString &  name,
int  dimension = 3 
)

Add a tangent set to the list of required elements.

Parameters
[in]namethe name of the uv set to add tangent data for
[in]dimensionthe size of the normal requirement. Valid values are 3 and 4. Default is 3.
void addBinormal ( const MString &  name,
int  dimension = 3 
)

Add a binormal set to the list of required elements.

Parameters
[in]namethe name of the uv set to add binormal data for
[in]dimensionthe size of the normal requirement. Valid values are 3 and 4. Default is 3.
void addColor ( const MString &  name)

Add a color set to the list of required elements.

Parameters
[in]namethe name of the color set to add
Examples:
hlslShader/hlslShader.cpp.
void addFaceOffsets ( )

Add face offsets to the set of required elements.

Face offsets are used internally to calculate component-indexed data such as shading group membership. Note that geometry data is cached internally, so it is important to call this method whenever you use MGeometryRequirementsLegacy if you will ever require this information.

The documentation for this class was generated from the following files: