- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Examples

- Class List
- Class Hierarchy
- Class Members

Static Public Member Functions

# MDrawRegistry Class Reference
OpenMayaRender - API module for rendering

This reference page is linked to from the following overview topics: Extension for Autodesk Maya 2013, Scene Overrides, Transition Guide, 3.1 Registration, 3.3 Geometry Overrides, 3.4 Effect Overrides, 3.5 Shading Node Overrides, 3.6 Draw Overrides, 3.7 Sub-scene Overrides, 4.3 Customizing Geometric Data for Shaders.

Search for all occurrences

## Detailed Description

Access the registry associating node types with custom draw classes.

This class provides a means to register custom draw overrides to be used by Viewport 2.0 to draw dependency nodes.

The registry is based on classification strings. Each draw override must be registered with a classification string and any node type with a matching classification string will be drawn using the registered draw override.

`#include <MDrawRegistry.h>`

List of all members.

## Static Public Member Functions
static MStatus | registerShadingNodeOverrideCreator (const MString &drawClassification, const MString &registrantId, ShadingNodeOverrideCreator creator)
| Register an implementation of MPxShadingNodeOverride to use with nodes that have the specified, draw-specific classification string.
static MStatus | deregisterShadingNodeOverrideCreator (const MString &drawClassification, const MString &registrantId)
| Deregister an implementation of MPxShadingNodeOverride.
static MStatus | registerSurfaceShadingNodeOverrideCreator (const MString &drawClassification, const MString &registrantId, SurfaceShadingNodeOverrideCreator creator)
| Register an implementation of MPxSurfaceShadingNodeOverride to use with surface shaders that have the specified, draw-specific classification string.
static MStatus | deregisterSurfaceShadingNodeOverrideCreator (const MString &drawClassification, const MString &registrantId)
| Deregister an implementation of MPxSurfaceShadingNodeOverride.
static MStatus | registerShaderOverrideCreator (const MString &drawClassification, const MString &registrantId, ShaderOverrideCreator creator)
| Register an implementation of MPxShaderOverride to use with nodes that have the specified, draw-specific classification string.
static MStatus | deregisterShaderOverrideCreator (const MString &drawClassification, const MString &registrantId)
| Deregister an implementation of MPxShaderOverride.
static MStatus | registerGeometryOverrideCreator (const MString &drawClassification, const MString &registrantId, GeometryOverrideCreator creator)
| Register an implementation of MPxGeometryOverride to use with nodes that have the specified, draw-specific classification string.
static MStatus | deregisterGeometryOverrideCreator (const MString &drawClassification, const MString &registrantId)
| Deregister an implementation of MPxGeometryOverride.
static MStatus | registerDrawOverrideCreator (const MString &drawClassification, const MString &registrantId, DrawOverrideCreator creator)
| Register an implementation of MPxDrawOverride to use with DAG objects that have the specified, draw-specific classification string.
static MStatus | deregisterDrawOverrideCreator (const MString &drawClassification, const MString &registrantId)
| Deregister an implementation of MPxDrawOverride.
static MStatus | registerSubSceneOverrideCreator (const MString &drawClassification, const MString &registrantId, SubSceneOverrideCreator creator)
| Register an implementation of MPxSubSceneOverride to use with DAG objects that have the specified, draw-specific classification string.
static MStatus | deregisterSubSceneOverrideCreator (const MString &drawClassification, const MString &registrantId)
| Deregister an implementation of MPxSubSceneOverride.
static MStatus | registerVertexBufferGenerator (const MString &bufferName, VertexBufferGeneratorCreator creator)
| Register an implementation of MPxVertexBufferGenerator to provide custom vertex streams for shapes.
static MStatus | deregisterVertexBufferGenerator (const MString &bufferName)
| Deregister an implementation of MPxVertexBufferGenerator.
static MStatus | registerVertexBufferMutator (const MString &bufferName, VertexBufferMutatorCreator creator)
| Register an implementation of MPxVertexBufferMutator to provide custom vertex streams for shapes.
static MStatus | deregisterVertexBufferMutator (const MString &bufferName)
| Deregister an implementation of MPxVertexBufferMutator.
static MStatus | registerPrimitiveGenerator (const MString &primitiveType, PrimitiveGeneratorCreator creator)
| Register an implementation of MPxPrimitiveGenerator to generate custom primitive types for shapes.
static MStatus | deregisterPrimitiveGenerator (const MString &primitiveType)
| Deregister an implementation of MPxPrimitiveGenerator.
static MStatus | registerIndexBufferMutator (const MString &primitiveType, IndexBufferMutatorCreator creator)
| Register an implementation of MPxIndexBufferMutator to generate custom primitive types for shapes.
static MStatus | deregisterIndexBufferMutator (const MString &primitiveType)
| Deregister an implementation of MPxIndexBufferMutator.
static const char * | className ()
| Returns the name of this class.

## Member Function Documentation

MStatus registerShadingNodeOverrideCreator | ( | const MString & | drawClassification,
|  | const MString & | registrantId,
|  | ShadingNodeOverrideCreator | creator
| ) |  | `[static]`

Search for all occurrences

Register an implementation of MPxShadingNodeOverride to use with nodes that have the specified, draw-specific classification string.

For each shading node in the scene, the closest matching registered override will be used to create a shading fragment which will be joined to other fragments in the same shader graph. These fragments will eventually be turned into a complete shading effect.

For example, say the following overrides are registered under the given classification strings:

    		myShadingNodeOverride - "drawdb/shaders/myLibrary/myShader"
    		myLibraryOverride - "drawdb/shaders/myLibrary"

Then all shaders with classification string "drawdb/shaders/myLibrary/myShader" will be evaluated by myShadingNodeOverride while a shader with the classification string "drawdb/shaders/myLibrary/myShinyShader" would be evaluated by myLibraryOverride.

Note that for Viewport 2.0 to recognize a node as a shading node, it must have a classification string beginning with "drawdb/shader".

If multiple implementations are registered for the same classification, the most recently registered will be used. It is an error to try to register multiple implementations for the same classification using the same registrant id.

Parameters:

  [in] | drawClassification | The draw-specific classification string
  [in] | registrantId | Unique name to identify registration
  [in] | creator | Pointer to a function that creates the override

Returns:
  - MS::kSuccess Registration was successful
  - MS::kInvalidParameter Incorrect classification or classification already registered

Examples:
  brickShader.cpp, checkerShader.cpp, contrastShader.cpp, gammaShader.cpp, and mixtureShader.cpp.

MStatus deregisterShadingNodeOverrideCreator | ( | const MString & | drawClassification,
|  | const MString & | registrantId
| ) |  | `[static]`

Search for all occurrences

Deregister an implementation of MPxShadingNodeOverride.

Parameters:

  [in] | drawClassification | The draw-specific classification string
  [in] | registrantId | Unique name to identify registration, must match the name used to register the override.

Returns:
  - MS::kSuccess Deregistration was successful
  - MS::kInvalidParameter Incorrect classification or no matching registration

Examples:
  brickShader.cpp, checkerShader.cpp, contrastShader.cpp, gammaShader.cpp, and mixtureShader.cpp.

MStatus registerSurfaceShadingNodeOverrideCreator | ( | const MString & | drawClassification,
|  | const MString & | registrantId,
|  | SurfaceShadingNodeOverrideCreator | creator
| ) |  | `[static]`

Search for all occurrences

Register an implementation of MPxSurfaceShadingNodeOverride to use with surface shaders that have the specified, draw-specific classification string.

For each surface shading node in the scene, the closest matching registered override will be used to create a shading fragment which will be joined to other fragments in the same shader graph. These fragments will eventually be turned into a complete shading effect. This type of override should only be used with shading nodes that can be connected to Maya shading engines.

For example, say the following overrides are registered under the given classification strings:

    		myShadingNodeOverride - "drawdb/shaders/myLibrary/myShader"
    		myLibraryOverride - "drawdb/shaders/myLibrary"

Then all shaders with classification string "drawdb/shaders/myLibrary/myShader" will be evaluated by myShadingNodeOverride while a shader with the classification string "drawdb/shaders/myLibrary/myShinyShader" would be evaluated by myLibraryOverride.

Note that for Viewport 2.0 to recognize a node as a surface shading node, it must have a classification string beginning with "drawdb/shader/surface".

If multiple implementations are registered for the same classification, the most recently registered will be used. It is an error to try to register multiple implementations for the same classification using the same registrant id.

Parameters:

  [in] | drawClassification | The draw-specific classification string
  [in] | registrantId | Unique name to identify registration
  [in] | creator | Pointer to a function that creates the override

Returns:
  - MS::kSuccess Registration was successful
  - MS::kInvalidParameter Incorrect classification or classification already registered

Examples:
  depthShader.cpp, lambertShader.cpp, and phongShader.cpp.

MStatus deregisterSurfaceShadingNodeOverrideCreator | ( | const MString & | drawClassification,
|  | const MString & | registrantId
| ) |  | `[static]`

Search for all occurrences

Deregister an implementation of MPxSurfaceShadingNodeOverride.

Parameters:

  [in] | drawClassification | The draw-specific classification string
  [in] | registrantId | Unique name to identify registration, must match the name used to register the override.

Returns:
  - MS::kSuccess Deregistration was successful
  - MS::kInvalidParameter Incorrect classification or no matching registration

Examples:
  depthShader.cpp, lambertShader.cpp, and phongShader.cpp.

MStatus registerShaderOverrideCreator | ( | const MString & | drawClassification,
|  | const MString & | registrantId,
|  | ShaderOverrideCreator | creator
| ) |  | `[static]`

Search for all occurrences

Register an implementation of MPxShaderOverride to use with nodes that have the specified, draw-specific classification string.

For each shading node in the scene, the closest matching registered override will be used to create a shading effect for drawing in the viewport.

For example, say the following overrides are registered under the given classification strings:

    		myShaderOverride - "drawdb/shaders/myLibrary/myShader"
    		myLibraryOverride - "drawdb/shaders/myLibrary"

Then all shaders with classification string "drawdb/shaders/myLibrary/myShader" will be evaluated by myShaderOverride while a shader with the classification string "drawdb/shaders/myLibrary/myShinyShader" would be evaluated by myLibraryOverride.

Note that for Viewport 2.0 to recognize a node as a shading node, it must have a classification string beginning with "drawdb/shader".

If multiple implementations are registered for the same classification, the most recently registered will be used. It is an error to try to register multiple implementations for the same classification using the same registrant id.

Parameters:

  [in] | drawClassification | The draw-specific classification string
  [in] | registrantId | Unique name to identify registration
  [in] | creator | Pointer to a function that creates the override

Returns:
  - MS::kSuccess Registration was successful
  - MS::kInvalidParameter Incorrect classification or classification already registered

Examples:
  hwColorPerVertexShader.cpp, hwPhongShader.cpp, and pluginMain.cpp.

MStatus deregisterShaderOverrideCreator | ( | const MString & | drawClassification,
|  | const MString & | registrantId
| ) |  | `[static]`

Search for all occurrences

Deregister an implementation of MPxShaderOverride.

Parameters:

  [in] | drawClassification | The draw-specific classification string
  [in] | registrantId | Unique name to identify registration, must match the name used to register the override.

Returns:
  - MS::kSuccess Deregistration was successful
  - MS::kInvalidParameter Incorrect classification or no matching registration

Examples:
  hwColorPerVertexShader.cpp, hwPhongShader.cpp, and pluginMain.cpp.

MStatus registerGeometryOverrideCreator | ( | const MString & | drawClassification,
|  | const MString & | registrantId,
|  | GeometryOverrideCreator | creator
| ) |  | `[static]`

Search for all occurrences

Register an implementation of MPxGeometryOverride to use with nodes that have the specified, draw-specific classification string.

For each DAG object in the scene, the closest matching registered override will be used to generate geometry for drawing that object in Viewport 2.0.

For example, say the following overrides are registered under the given classification strings:

    		myShapeOverride - "drawdb/geometry/myLibrary/myShape"
    		myLibraryOverride - "drawdb/geometry/myLibrary"

Then all DAG objects with classification string "drawdb/geometry/myLibrary/myShape" will have draw geometry generated through myShapeOverride while DAG objects with the classification string "drawdb/geometry/myLibrary/myPointyShape" will have draw geometry generated through myLibraryOverride.

Note that for Viewport 2.0 to recognize a DAG object as a piece of drawable geometry, it must have a classification string beginning with "drawdb/geometry".

If multiple implementations are registered for the same classification, the most recently registered will be used. It is an error to try to register multiple implementations for the same classification using the same registrant id.

Parameters:

  [in] | drawClassification | The draw-specific classification string
  [in] | registrantId | Unique name to identify registration
  [in] | creator | Pointer to a function that creates an instance of the override class

Returns:
  - MS::kSuccess Registration was successful
  - MS::kInvalidParameter Incorrect classification or classification already registered

Examples:
  apiMeshShape.cpp.

MStatus deregisterGeometryOverrideCreator | ( | const MString & | drawClassification,
|  | const MString & | registrantId
| ) |  | `[static]`

Search for all occurrences

Deregister an implementation of MPxGeometryOverride.

Parameters:

  [in] | drawClassification | The draw-specific classification string
  [in] | registrantId | Unique name to identify registration, must match the name used to register the override.

Returns:
  - MS::kSuccess Deregistration was successful
  - MS::kInvalidParameter Incorrect classification or no matching registration

Examples:
  apiMeshShape.cpp.

MStatus registerDrawOverrideCreator | ( | const MString & | drawClassification,
|  | const MString & | registrantId,
|  | DrawOverrideCreator | creator
| ) |  | `[static]`

Search for all occurrences

Register an implementation of MPxDrawOverride to use with DAG objects that have the specified, draw-specific classification string.

For each DAG object in the scene whose classification string is satisfied by the registered classification string, the draw() method of the given MPxDrawOverride implementation will be called to draw the object in Viewport 2.0.

For example, say the following overrides are registered under the given classification strings:

    		myShapeDrawOverride - "drawdb/geometry/myLibrary/myShape"
    		myLibraryDrawOverride - "drawdb/geometry/myLibrary"

Then all DAG objects with classification string "drawdb/geometry/myLibrary/myShape" will be drawn through myShapeDrawOverride while DAG objects with the classification string "drawdb/geometry/myLibrary/myPointyShape" would be drawn through myLibraryDrawOverride.

Note that for Viewport 2.0 to recognize a DAG object as a piece of drawable geometry, it must have a classification string beginning with "drawdb/geometry".

If multiple implementations are registered for the same classification, the most recently registered will be used. It is an error to try to register multiple implementations for the same classification using the same registrant id.

Parameters:

  [in] | drawClassification | The draw-specific classification string
  [in] | registrantId | Unique name to identify registration
  [in] | creator | Pointer to a function that creates an instance of the draw override class

Returns:
  - MS::kSuccess Registration was successful
  - MS::kInvalidParameter Incorrect classification or classification already registered

Examples:
  footPrintNode.cpp, squareScaleManip.cpp, and swissArmyManip.cpp.

MStatus deregisterDrawOverrideCreator | ( | const MString & | drawClassification,
|  | const MString & | registrantId
| ) |  | `[static]`

Search for all occurrences

Deregister an implementation of MPxDrawOverride.

Parameters:

  [in] | drawClassification | The draw-specific classification string
  [in] | registrantId | Unique name to identify registration, must match the name used to register the override.

Returns:
  - MS::kSuccess Deregistration was successful
  - MS::kInvalidParameter Incorrect classification or no matching registration

Examples:
  footPrintNode.cpp, squareScaleManip.cpp, and swissArmyManip.cpp.

MStatus registerSubSceneOverrideCreator | ( | const MString & | drawClassification,
|  | const MString & | registrantId,
|  | SubSceneOverrideCreator | creator
| ) |  | `[static]`

Search for all occurrences

Register an implementation of MPxSubSceneOverride to use with DAG objects that have the specified, draw-specific classification string.

For each DAG object in the scene whose classification string is satisfied by the registered classification string, an instance of the registered MPxSubSceneOverride implementation will be used to display the object in Viewport 2.0.

For example, say the following overrides are registered under the given classification strings:

    		myShapeSubSceneOverride - "drawdb/subscene/myLibrary/myShape"
    		myLibrarySubSceneOverride - "drawdb/subscene/myLibrary"

Then all DAG objects with classification string "drawdb/subscene/myLibrary/myShape" will be drawn through myShapeSubSceneOverride while DAG objects with the classification string "drawdb/subscene/myLibrary/myPointyShape" would be drawn through myLibrarySubSceneOverride.

Note that for Viewport 2.0 to recognize a DAG object as a drawable sub-scene object, it must have a classification string beginning with "drawdb/subscene".

If multiple implementations are registered for the same classification, the most recently registered will be used. It is an error to try to register multiple implementations for the same classification using the same registrant id.

Parameters:

  [in] | drawClassification | The draw-specific classification string
  [in] | registrantId | Unique name to identify registration
  [in] | creator | Pointer to a function that creates an instance of the draw override class

Returns:
  - MS::kSuccess Registration was successful
  - MS::kInvalidParameter Incorrect classification or classification already registered

Examples:
  apiMeshShape.cpp.

MStatus deregisterSubSceneOverrideCreator | ( | const MString & | drawClassification,
|  | const MString & | registrantId
| ) |  | `[static]`

Search for all occurrences

Deregister an implementation of MPxSubSceneOverride.

Parameters:

  [in] | drawClassification | The draw-specific classification string
  [in] | registrantId | Unique name to identify registration, must match the name used to register the override.

Returns:
  - MS::kSuccess Deregistration was successful
  - MS::kInvalidParameter Incorrect classification or no matching registration

Examples:
  apiMeshShape.cpp.

MStatus registerVertexBufferGenerator | ( | const MString & | bufferName,
|  | VertexBufferGeneratorCreator | creator
| ) |  | `[static]`

Search for all occurrences

Register an implementation of MPxVertexBufferGenerator to provide custom vertex streams for shapes.

These vertex streams are opaque to the system so a registry is used to add buffer generators to the system. The bufferName is used to match the Name in a MVertexBufferDescriptor. A static creator function is supplied to initialize the generator.

Parameters:

  [in] | bufferName | Unique name to identify the custom stream this generator can produce.
  [in] | creator | A static function pointer used to create a new instance of the generator.

Returns:
  - MS::kSuccess Registration was successful
  - MS::kFailure A generator was already registered for this buffer name. Unregister the existing generator first if you would like to replace it.

MStatus deregisterVertexBufferGenerator | ( | const MString & | bufferName | ) | `[static]`

Search for all occurrences

Deregister an implementation of MPxVertexBufferGenerator.

Parameters:

  [in] | bufferName | Unique name to identify the custom stream this generator can produce.

Returns:
  - MS::kSuccess Deregistration was successful
  - MS::kInvalidParameter No generator was found with the given name.

MStatus registerVertexBufferMutator | ( | const MString & | bufferName,
|  | VertexBufferMutatorCreator | creator
| ) |  | `[static]`

Search for all occurrences

Register an implementation of MPxVertexBufferMutator to provide custom vertex streams for shapes.

These vertex streams are opaque to the system so a registry is used to add buffer mutators to the system. The bufferName is used to match the Name in a MVertexBufferDescriptor. A static creator function is supplied to initialize the mutator. While the MPxVertexBufferGenerator will allow plugins to CREATE vertex buffers, the MPxVertexBufferMutator will allow plugins to MODIFY the content of vertex buffers created by the application. For example it can be used to swizzle a position vertex stream (change x, y, z to z, y, x) or to swap the U & V coordinates.

Parameters:

  [in] | bufferName | Unique name to identify the custom stream this mutator can produce.
  [in] | creator | A static function pointer used to create a new instance of the mutator.

Returns:
  - MS::kSuccess Registration was successful
  - MS::kFailure A generator was already registered for this buffer name. Unregister the existing mutator first if you would like to replace it.

MStatus deregisterVertexBufferMutator | ( | const MString & | bufferName | ) | `[static]`

Search for all occurrences

Deregister an implementation of MPxVertexBufferMutator.

Parameters:

  [in] | bufferName | Unique name to identify the custom stream this mutator can produce.

Returns:
  - MS::kSuccess Deregistration was successful
  - MS::kInvalidParameter No mutator was found with the given name.

MStatus registerPrimitiveGenerator | ( | const MString & | primitiveType,
|  | PrimitiveGeneratorCreator | creator
| ) |  | `[static]`

Search for all occurrences

Register an implementation of MPxPrimitiveGenerator to generate custom primitive types for shapes.

These primitives are opaque to the system so a registry is used to add primitive generator to the system.

The primitiveType is used to match the required primitive type reported by a shader override. A static creator function is supplied to initialize the provider.

Parameters:

  [in] | primitiveType | Unique name to identify the custom primitive type this generator can produce.
  [in] | creator | A static function pointer used to create a new instance of the generator.

Returns:
  - MS::kSuccess Registration was successful
  - MS::kFailure A generator was already registered for this primitive type. Unregister the existing generator first if you would like to replace it.

MStatus deregisterPrimitiveGenerator | ( | const MString & | primitiveType | ) | `[static]`

Search for all occurrences

Deregister an implementation of MPxPrimitiveGenerator.

Parameters:

  [in] | primitiveType | Unique name to identify the custom primitive type this generator can produce.

Returns:
  - MS::kSuccess Deregistration was successful
  - MS::kInvalidParameter No generator was found with the given type.

MStatus registerIndexBufferMutator | ( | const MString & | primitiveType,
|  | IndexBufferMutatorCreator | creator
| ) |  | `[static]`

Search for all occurrences

Register an implementation of MPxIndexBufferMutator to generate custom primitive types for shapes.

These mutators are opaque to the system so a registry is used to add them to the system.

The primitiveType is used to match the required primitive type reported by a shader override. A static creator function is supplied to initialize the provider.

Parameters:

  [in] | primitiveType | Unique name to identify the custom primitive type this mutator can produce.
  [in] | creator | A static function pointer used to create a new instance of the mutator.

Returns:
  - MS::kSuccess Registration was successful
  - MS::kFailure A mutator was already registered for this primitive type. Unregister the existing mutator first if you would like to replace it.

MStatus deregisterIndexBufferMutator | ( | const MString & | primitiveType | ) | `[static]`

Search for all occurrences

Deregister an implementation of MPxIndexBufferMutator.

Parameters:

  [in] | primitiveType | Unique name to identify the custom primitive type this mutator can produce.

Returns:
  - MS::kSuccess Deregistration was successful
  - MS::kInvalidParameter No mutator was found with the given type.

const char * className | ( |  | ) | `[static]`

Search for all occurrences

Returns the name of this class.

Returns:
  The name of this class.

MDrawRegistry MDrawRegistry MDrawRegistry MDrawRegistry MDrawRegistry MDrawRegistry MDrawRegistry MDrawRegistry MDrawRegistry MDrawRegistry
MDrawRegistry MDrawRegistry MDrawRegistry MDrawRegistry MDrawRegistry MDrawRegistry MDrawRegistry MDrawRegistry MDrawRegistry MDrawRegistry