C++ API Reference
Public Member Functions | Static Public Member Functions | List of all members
MTopologyClusterNode Class Reference
OpenMaya - API module for common classes

Topology cluster representing a fine grain evaluation graph. More...

#include <MTopologyClusterNode.h>

Public Member Functions

MPxTopologyEvaluator evaluator (MStatus *ReturnStatus) const
 Get the evaluator responsible for this cluster node. More...
 
MEvaluationGraph ownerGraph (MStatus *ReturnStatus) const
 Get the graph that this node is a part of. More...
 
MObject asMObject (MStatus *ReturnStatus=nullptr) const
 Provide the MObject for this cluster. More...
 

Static Public Member Functions

static const char * className ()
 Returns the name of this class. More...
 

Detailed Description

Topology cluster representing a fine grain evaluation graph.

Examples:
testMTopologyEvaluator/testMTopologyEvaluator.cpp, and testMTopologyEvaluator/testMTopologyEvaluator.h.

Member Function Documentation

MPxTopologyEvaluator evaluator ( MStatus *  ReturnStatus) const

Get the evaluator responsible for this cluster node.

Parameters
[out]ReturnStatusStatus flag
Returns
The evaluator for this object.
Status Codes:
  • MS::kSuccess operation successful
  • MS::kFailure operation failed (evaluator does not exist)
MEvaluationGraph ownerGraph ( MStatus *  ReturnStatus) const

Get the graph that this node is a part of.

Parameters
[out]ReturnStatusStatus flag
Returns
The cluster node's graph.
Status Codes:
  • MS::kSuccess operation successful
  • MS::kFailure operation failed (evaluator or graph do not exist)
MObject asMObject ( MStatus *  ReturnStatus = nullptr) const

Provide the MObject for this cluster.

Note
Provides the MObject of this cluster, which can be used by MObjectHandle to uniquely identify the cluster object.
Parameters
[out]ReturnStatusStatus flag
Returns
An MObject for this cluster
Status Codes:
  • MS::kSuccess operation successful
  • MS::kFailure operation failed (evaluator or graph do not exist)
const char * className ( )
static

Returns the name of this class.

Returns
The name of this class.
The documentation for this class was generated from the following files: