MFnInstancer Class Reference
MFnInstancer Class Reference
#include <MFnInstancer.h>
Class Description
Particle Instancer object access class.
Class for obtaining information about a particle instancer node.
Examples:
Inheritance diagram for MFnInstancer:
Public Member Functions | |
| virtual MFn::Type | type () const |
| Function set type. | |
| virtual | ~MFnInstancer () |
| Destructor. More... | |
| MFnInstancer () | |
| Default constructor. | |
| MFnInstancer (MObject &object, MStatus *ReturnStatus=NULL) | |
| Constructor. More... | |
| MFnInstancer (const MDagPath &object, MStatus *ret=NULL) | |
| Constructor. More... | |
| int | particleCount () const |
| Returns the number of particles feeding the active instancer. More... | |
| int | instancesForParticle (int p, MDagPathArray &paths, MMatrix &instancerMatrix, MStatus *ReturnStatus=NULL) const |
| Returns the DAG paths and instancer matrix for all instances generated by a specified particle. More... | |
| MStatus | allInstances (MDagPathArray &paths, MMatrixArray &matrices, MIntArray &particlePathStartIndices, MIntArray &pathIndices) const |
| Returns information about all instances generated by a particular particle instancer node. More... | |
| MFnInstancer (const MObject &object, MStatus *ret=NULL) | |
| Constructor. More... | |
| Public Member Functions inherited from MFnDagNode | |
| virtual | ~MFnDagNode () |
| Destructor. More... | |
| MFnDagNode () | |
| Class Constructor. More... | |
| MFnDagNode (MObject &object, MStatus *ret=NULL) | |
| This method is not available in Python. More... | |
| MFnDagNode (const MDagPath &object, MStatus *ret=NULL) | |
| Class Constructor. More... | |
| MObject | create (const MTypeId &typeId, MObject &parent=MObject::kNullObj, MStatus *ReturnStatus=NULL) |
| Creates a new DAG node with the given type tag. More... | |
| MObject | create (const MTypeId &typeId, const MString &name, MObject &parent=MObject::kNullObj, MStatus *ReturnStatus=NULL) |
| Creates a new DAG node with the given type tag. More... | |
| MObject | create (const MString &type, MObject &parent=MObject::kNullObj, MStatus *ReturnStatus=NULL) |
| Creates a new DAG node with the given type tag. More... | |
| MObject | create (const MString &type, const MString &name, MObject &parent=MObject::kNullObj, MStatus *ReturnStatus=NULL) |
| Creates a new DAG node with the given type tag. More... | |
| unsigned int | parentCount (MStatus *ReturnStatus=NULL) const |
| Determines the number of parent Nodes of the Node. More... | |
| MObject | parent (unsigned int i, MStatus *ReturnStatus=NULL) const |
| Queries the DAG Node attached to the Function Set for the parent Node corresponding to the given index. More... | |
| MStatus | addChild (MObject &child, unsigned int index=kNextPos, bool keepExistingParents=false) |
| Makes the given DAG Node a child of the DAG Node to which this instance of the Function Set is attached. More... | |
| MStatus | removeChild (MObject &child) |
| Removes the given DAG Node from the parent. More... | |
| MStatus | removeChildAt (unsigned int index) |
| Removes the child at the given index from the parent. More... | |
| unsigned int | childCount (MStatus *ReturnStatus=NULL) const |
| Determines the number of child Nodes of the Node. More... | |
| MObject | child (unsigned int i, MStatus *ReturnStatus=NULL) const |
| Queries the DAG Node attached to the Function Set for the child Node corresponding to the given index. More... | |
| MObject | dagRoot (MStatus *ReturnStatus=NULL) |
| Determines the root of the first DAG Path to the DAG Node attached to the Function Set. More... | |
| bool | hasParent (const MObject &node, MStatus *ReturnStatus=NULL) const |
| Determines whether or not the given Node is a parent of the DAG Node attached to the Function Set. More... | |
| bool | hasChild (const MObject &node, MStatus *ReturnStatus=NULL) const |
| Determines whether or not the given Node is a child of the DAG Node attached to the Function Set. More... | |
| bool | isChildOf (const MObject &node, MStatus *ReturnStatus=NULL) const |
| Determines whether or not the DAG Node attached to the Function Set is a child of the given node. More... | |
| bool | isParentOf (const MObject &node, MStatus *ReturnStatus=NULL) const |
| Determines whether or not the DAG Node attached to the Function Set is a parent of the given node. More... | |
| bool | inUnderWorld (MStatus *ReturnStatus=NULL) const |
| Determines whether or not the DAG Node is an underworld node. More... | |
| bool | inModel (MStatus *ReturnStatus=NULL) const |
| Determines whether or not the DAG Node is in the model. More... | |
| bool | isInstanceable (MStatus *ReturnStatus=NULL) const |
| Returns true if the DAG node can be instanced, and false otherwise. More... | |
| MStatus | setInstanceable (const bool how) |
| Sets whether or not the DAG node is instanceable. More... | |
| bool | isInstanced (bool indirect=true, MStatus *ReturnStatus=NULL) const |
| Determines whether the DAG Node attached to the Function Set is directly or indirectly instanced. More... | |
| bool | isInstancedAttribute (const MObject &attr, MStatus *ReturnStatus=NULL) const |
| Returns true if the specified attribute is instanced. More... | |
| unsigned int | instanceCount (bool total, MStatus *ReturnStatus=NULL) const |
| Determines the number of times the Node attached to the Function Set is instanced. More... | |
| MObject | duplicate (bool instance=false, bool instanceLeaf=false, MStatus *ReturnStatus=NULL) const |
| This method duplicates the DAG hierarchy rooted at the current node. More... | |
| MStatus | getPath (MDagPath &path) const |
| Returns a DAG Path to the DAG Node attached to the Function Set. More... | |
| MStatus | getAllPaths (MDagPathArray &paths) const |
| Determines all DAG Paths to the DAG Node attached to the Function Set. More... | |
| MString | fullPathName (MStatus *ReturnStatus=NULL) const |
| Return a string representing the full path from the root of the dag to this object. More... | |
| MString | partialPathName (MStatus *ReturnStatus=NULL) const |
| Return a string representing the partial path from the root of the dag to this object. More... | |
| MMatrix | transformationMatrix (MStatus *ReturnStatus=NULL) const |
| Returns the object space transformation matrix for this DAG node. More... | |
| bool | isIntermediateObject (MStatus *ReturnStatus=NULL) const |
| Returns true if this object is an intermediate in a geometry calculation. More... | |
| MStatus | setIntermediateObject (bool isIntermediate) |
| Sets whether this object is an intermediate in a geometry calculation. More... | |
| int | objectColor (MStatus *ReturnStatus=NULL) const |
| This method is obsolete. More... | |
| MStatus | setObjectColor (int color) |
| Sets the index for the current user defined inactive color used by the node. More... | |
| bool | usingObjectColor (MStatus *ReturnStatus=NULL) const |
| MStatus | setUseObjectColor (bool useObjectColor) |
| MObjectColorType | objectColorType (MStatus *ReturnStatus=NULL) const |
| Determines whether or not the user defined inactive color will be used for the node, or whether the default inactive color will be used. More... | |
| MStatus | setObjectColorType (MObjectColorType type) |
| Sets whether or not the user defined inactive object color will be used. More... | |
| MStatus | setObjectColor (const MColor &color) |
| Sets the color value for the current user defined inactive color used by the node. More... | |
| MColor | objectColorRGB (MStatus *ReturnStatus=NULL) const |
| Determines the RGB color for the current user defined inactive color used by the node. More... | |
| int | objectColorIndex (MStatus *ReturnStatus=NULL) const |
| Determines the index for the current user defined inactive color used by the node. More... | |
| MColor | hiliteColor (MStatus *ReturnStatus=NULL) const |
| Determines the current hilite color used by the node. More... | |
| bool | usingHiliteColor (MStatus *ReturnStatus=NULL) const |
| Determines whether or not the hilite color will be used for the node. More... | |
| MColor | dormantColor (MStatus *ReturnStatus=NULL) const |
| Determines the dormant color used by this node. More... | |
| MColor | activeColor (MStatus *ReturnStatus=NULL) const |
| Determines the active color used by this node. More... | |
| bool | drawOverrideEnabled (MStatus *ReturnStatus=NULL) const |
| Determines whether or not draw override is turned on for this node. More... | |
| bool | drawOverrideIsReference (MStatus *ReturnStatus=NULL) const |
| Determines whether or not Display Type of the draw override is Reference for this node. More... | |
| bool | drawOverrideIsTemplate (MStatus *ReturnStatus=NULL) const |
| Determines whether or not Display Type of the draw override is Template for this node. More... | |
| bool | drawOverrideColor (MColor &color, MStatus *ReturnStatus=NULL) const |
| Determines the draw override color used by this node. More... | |
| MStatus | getConnectedSetsAndMembers (unsigned int instanceNumber, MObjectArray &sets, MObjectArray &comps, bool renderableSetsOnly) const |
| Returns all the sets connected to the specified instance of this DAG object. More... | |
| MBoundingBox | boundingBox (MStatus *ReturnStatus=NULL) const |
| Returns the bounding box for the dag node in object space. More... | |
| MDagPath | dagPath (MStatus *ReturnStatus=NULL) const |
| Returns the DagPath to which the Function Set is attached. More... | |
| virtual MStatus | setObject (const MDagPath &path) |
| Attaches Function Set to the DAG Node that has the given DAG Path. More... | |
| virtual MStatus | setObject (MObject &object) |
| Attaches Function Set to given DAG Node. More... | |
| MObject | model (MStatus *ReturnStatus=NULL) const |
| This method is obsolete. More... | |
| MFnDagNode (const MObject &object, MStatus *ret=NULL) | |
| No script support. More... | |
| virtual MStatus | setObject (const MObject &object) |
| No script support. More... | |
| Public Member Functions inherited from MFnDependencyNode | |
| virtual | ~MFnDependencyNode () |
| Destructor. | |
| MFnDependencyNode () | |
| Default constructor. | |
| MFnDependencyNode (MObject &object, MStatus *ReturnStatus=NULL) | |
| Constructor. More... | |
| MObject | create (const MTypeId &typeId, MStatus *ReturnStatus=NULL) |
| Creates a new dependency node with the given type tag. More... | |
| MObject | create (const MTypeId &typeId, const MString &name, MStatus *ReturnStatus=NULL) |
| Creates a new dependency node with the given type tag. More... | |
| MObject | create (const MString &type, MStatus *ReturnStatus=NULL) |
| Creates a new dependency node with the given type. More... | |
| MObject | create (const MString &type, const MString &name, MStatus *ReturnStatus=NULL) |
| Creates a new dependency node with the given type. More... | |
| MTypeId | typeId (MStatus *ReturnStatus=NULL) const |
| Returns the type id of this node. More... | |
| MString | typeName (MStatus *ReturnStatus=NULL) const |
| Returns the type name of this node. More... | |
| MString | name (MStatus *ReturnStatus=NULL) const |
| Returns the name of this node. More... | |
| MString | absoluteName (MStatus *ReturnStatus=NULL) const |
| Returns the absolute name of this node. More... | |
| MString | pluginName (MStatus *ReturnStatus=NULL) const |
| Returns the name of the plug-in this MFnDependendencyNode was defined in. More... | |
| MString | setName (const MString &name, bool createNamespace=false, MStatus *ReturnStatus=NULL) |
| Sets the name of this node. More... | |
| MUuid | uuid (MStatus *ReturnStatus=NULL) const |
| Returns the node's UUID. More... | |
| void | setUuid (const MUuid &uuid, MStatus *ReturnStatus=NULL) |
| Sets the node's UUID. More... | |
| MStatus | getConnections (MPlugArray &array) const |
| Get all of the current connections to this node as an array of plugs. More... | |
| unsigned int | attributeCount (MStatus *ReturnStatus=NULL) const |
| Returns the number of attributes that this node has. More... | |
| MObject | attribute (unsigned int index, MStatus *ReturnStatus=NULL) const |
| Finds the attribute of this node at the given index. More... | |
| MObject | reorderedAttribute (unsigned int index, MStatus *ReturnStatus=NULL) const |
| Some nodes, such as the various animCurve nodes, require that their attributes be set in a specific order for proper operation. More... | |
| MObject | attribute (const MString &attrName, MStatus *ReturnStatus=NULL) const |
| Finds the attribute of this node that has the given name. More... | |
| MAttrClass | attributeClass (const MObject &attr, MStatus *ReturnStatus=NULL) const |
| Returns the class (normal, dynamic, extension) of the specified attribute. More... | |
| MStatus | getAffectedAttributes (const MObject &attr, MObjectArray &affectedAttributes) const |
| Returns an array of attributes that are affected by the attribute passed in. More... | |
| MStatus | getAffectedByAttributes (const MObject &attr, MObjectArray &affectedByAttributes) const |
| Returns an array of attributes that affect the attribute passed in, attr. More... | |
| MPlug | findPlug (const MObject &attr, bool wantNetworkedPlug, MStatus *ReturnStatus=NULL) const |
| Attempt to find a plug for the given attribute. More... | |
| MPlug | findPlug (const MString &attrName, bool wantNetworkedPlug, MStatus *ReturnStatus=NULL) const |
| Attempt to find a plug for the given attribute. More... | |
| MPlug | findPlug (const MObject &attr, MStatus *ReturnStatus=NULL) const |
| This method is obsolete. More... | |
| MPlug | findPlug (const MString &attrName, MStatus *ReturnStatus=NULL) const |
| This method is obsolete. More... | |
| MStatus | addAttribute (const MObject &attr) |
| Add a new dynamic attibute to this node. More... | |
| MStatus | removeAttribute (const MObject &attr) |
| Remove a dynamic attribute from a node. More... | |
| MPxNode * | userNode (MStatus *ReturnStatus=NULL) const |
| If the function set's node is a plug-in node, then this method will extract the MPxNode pointer from it. More... | |
| bool | isFromReferencedFile (MStatus *ReturnStatus=NULL) const |
| Indicates whether or not this node came from a referenced file. More... | |
| bool | isShared (MStatus *ReturnStatus=NULL) const |
| Indicates whether or not this node is shared. More... | |
| bool | isTrackingEdits (MStatus *ReturnStatus=NULL) const |
| Returns whether or not edits on the given node are being tracked by the generalized edit system. More... | |
| bool | hasUniqueName (MStatus *ReturnStatus=NULL) const |
| Indicates whether or not this node's name is unique within the scene. More... | |
| MString | parentNamespace (MStatus *ReturnStatus=NULL) const |
| Returns the name of the namespace in which this node resides. More... | |
| bool | isLocked (MStatus *ReturnStatus=NULL) const |
| Indicates whether or not this node is locked. More... | |
| MStatus | setLocked (bool locked) |
| Locks or unlocks this node. More... | |
| bool | isNewAttribute (const MObject &attr, MStatus *ReturnStatus=NULL) const |
| Indicates whether or not the specified attribute was added to this node within the current scene. More... | |
| MStatus | setFlag (unsigned int flag, bool state) |
| Sets the state of the specified flag for the node. More... | |
| bool | isFlagSet (unsigned int flag, MStatus *ReturnStatus=NULL) const |
| Retrieves the current state of the specified flag for a node. More... | |
| bool | isDefaultNode (MStatus *ReturnStatus=NULL) const |
| Returns true if the node is a default node. More... | |
| MStatus | setDoNotWrite (bool flag) |
| Use this method to mark the "do not write" state of this node. More... | |
| bool | canBeWritten (MStatus *ReturnStatus=NULL) const |
| Returns the do not write state of the node. More... | |
| bool | hasAttribute (const MString &name, MStatus *ReturnStatus=NULL) const |
| Returns true if the node already has an attribute with the given name. More... | |
| MObject | getAliasAttr (bool force, MStatus *ReturnStatus=NULL) |
| Returns the node's alias attribute, which is a special attribute used to store information about the node's attribute aliases. More... | |
| bool | setAlias (const MString &alias, const MString &name, const MPlug &plug, bool add=true, MStatus *ReturnStatus=NULL) |
| Sets or removes an alias (i.e. More... | |
| bool | findAlias (const MString &alias, MObject &attrObj, MStatus *ReturnStatus=NULL) const |
| Retrieves the attribute with the given alias. More... | |
| bool | getAliasList (MStringArray &strArray, MStatus *ReturnStatus=NULL) |
| Returns a list of all attribute aliases for this node. More... | |
| MString | plugsAlias (const MPlug &plug, MStatus *ReturnStatus=NULL) |
| Returns the alias for the plug's attribute or the empty string if that attribute has no alias. More... | |
| MStatus | setIcon (const MString &filename) |
| Associates a custom icon with the node for display in the Maya UI. More... | |
| MString | icon (MStatus *ReturnStatus=NULL) const |
| Returns the custom icon filename associated with the node. More... | |
| MStatus | getExternalContent (MExternalContentInfoTable &table) const |
| Returns the external content (files) that this node depends on. More... | |
| MStatus | addExternalContentForFileAttr (MExternalContentInfoTable &table, const MObject &attr) const |
| Adds content info to the specified table from a file path attribute. More... | |
| MStatus | setExternalContentForFileAttr (const MObject &attr, const MExternalContentLocationTable &table) |
| Sets content info in the specified attribute from the table. More... | |
| MStatus | setExternalContent (const MExternalContentLocationTable &table) |
| Changes the location of external content. More... | |
| MString | setName (const MString &name, MStatus *ReturnStatus) |
| OBSOLETE FUNCTION, NO SCRIPT SUPPORT. More... | |
| MFnDependencyNode (const MObject &object, MStatus *ReturnStatus=NULL) | |
| NO SCRIPT SUPPORT. More... | |
| bool | getPlugsAlias (const MPlug &plug, MString &aliasName, MStatus *ReturnStatus=NULL) |
| NO SCRIPT SUPPORT. More... | |
| virtual const adsk::Data::Associations * | metadata (MStatus *ReturnStatus=NULL) const |
| This method is not available in Python. More... | |
| virtual MStatus | setMetadata (const adsk::Data::Associations &) |
| This method is not available in Python. More... | |
| virtual MStatus | deleteMetadata () |
| This method is not available in Python. More... | |
| virtual MStatus | validateMetadata (MString &errors) const |
| This method is not available in Python. More... | |
| MStatus | dgTimerOn () |
| Indicates that this node should collect DG timing data whenever DG timing is enabled. More... | |
| MStatus | dgTimerOff () |
| Indicates that this node should no longer collect DG timing data when DG timing is enabled. More... | |
| MdgTimerState | dgTimerQueryState (MStatus *ReturnStatus=NULL) |
| The function returns the current on/off state of the node's timer. More... | |
| MStatus | dgTimerReset () |
| The function resets the dependency graph timers and counters for this node to zero. More... | |
| double | dgTimer (const MdgTimerMetric timerMetric, const MdgTimerType timerType, MStatus *ReturnStatus=NULL) const |
| The function returns the specified timer value for the current node. More... | |
| MStatus | dgCallbacks (const MdgTimerType type, MStringArray &callbackName, MDoubleArray &value) |
| Node callbacks that occur when timing is enabled get logged with the node and can be queried via this method. More... | |
| MStatus | dgCallbackIds (const MdgTimerType type, const MString &callbackName, MCallbackIdArray &callbackId, MDoubleArray &value) |
| This method provides a further breakdown of the per-callback time returned via dgCallbacks() by returning the data on a per-callbackId basis. More... | |
| MStatus | addAttribute (const MObject &attr, MAttrClass type) |
| This method is obsolete. More... | |
| MStatus | removeAttribute (const MObject &attr, MAttrClass type) |
| This method is obsolete. More... | |
| Public Member Functions inherited from MFnBase | |
| virtual | ~MFnBase () |
| Class Destructor. More... | |
| bool | hasObj (MFn::Type) const |
| Determines whether or not the Function Set is compatible with the specified Maya Object within the API RTTI system. More... | |
| bool | hasObj (const MObject &) const |
| Determines whether or not the Function Set is compatible with the specified Maya Object within the API RTTI system. More... | |
| MObject | object (MStatus *ReturnStatus=NULL) const |
| Returns the MObject that is attached to the Function Set. More... | |
Protected Member Functions | |
| virtual const char * | className () const |
| Class name. | |
Additional Inherited Members | |
| Public Types inherited from MFnDagNode | |
| enum | { kNextPos = 0xff } |
| Anonymous enum to store constant values. More... | |
| enum | MObjectColorType { kUseDefaultColor = 0, kUseIndexColor, kUseRGBColor } |
| Enum to set how an object is colored. More... | |
| Public Types inherited from MFnDependencyNode | |
| enum | MAttrClass { kLocalDynamicAttr = 1, kNormalAttr, kExtensionAttr, kInvalidAttr } |
| Specifies the scope of the attribute. More... | |
| enum | MdgTimerState { kTimerOff, kTimerOn, kTimerUninitialized, kTimerInvalidState } |
| Possible states for the node's timer. More... | |
| enum | MdgTimerMetric { kTimerMetric_callback, kTimerMetric_compute, kTimerMetric_dirty, kTimerMetric_draw, kTimerMetric_fetch, kTimerMetric_callbackViaAPI, kTimerMetric_callbackNotViaAPI, kTimerMetric_computeDuringCallback, kTimerMetric_computeNotDuringCallback, kTimerMetrics } |
| The different timer metrics which can be queried. More... | |
| enum | MdgTimerType { kTimerType_self, kTimerType_inclusive, kTimerType_count, kTimerTypes } |
| The types of timers which can be queried. More... | |
| Static Public Member Functions inherited from MFnDependencyNode | |
| static MString | classification (const MString &nodeTypeName) |
| Retrieves the classification string for a node type. More... | |
| static unsigned int | allocateFlag (const MString pluginName, MStatus *ReturnStatus=NULL) |
| Allocates a node flag for sole use by the caller. More... | |
| static MStatus | deallocateFlag (const MString pluginName, unsigned int flag) |
| Deallocates a node flag which was previously allocated by a call to allocateFlag. More... | |
| static MStatus | deallocateAllFlags (const MString pluginName) |
| Deallocates all of the node flags which are currently allocated to the specified plugin. More... | |
| static void | enableDGTiming (bool enable) |
| Globally enables or disables the DG node timing mechanism. More... | |
| Static Public Member Functions inherited from MFnBase | |
| static const char * | className () |
| Returns the name of this class. More... | |
Constructor & Destructor Documentation
|
virtual |
Destructor.
Class destructor.
| MFnInstancer | ( | MObject & | object, |
| MStatus * | ReturnStatus = NULL |
||
| ) |
Constructor.
Class constructor that initializes the function set to the given MObject.
- Parameters
-
[in] object The MObject to attach the function set to [out] ReturnStatus the return status
- Status Codes:
- MS::kSuccess if the function set is successfully attached
- MS::kInvalidParameter if the MObject does not represent a valid Maya object or if the function set is not allowed to attach to this MObject
| MFnInstancer | ( | const MDagPath & | object, |
| MStatus * | ReturnStatus = NULL |
||
| ) |
Constructor.
Class constructor that initializes the function set to the given constant MDagPath object.
- Parameters
-
[in] object The const MDagPath to attach the function set to [out] ReturnStatus The return status
- Status Codes:
- MS::kSuccess if the function set is successfully attached
- MS::kInvalidParameter if the MObject does not represent a valid Maya object or if the function set is not allowed to attach to this MObject
| MFnInstancer | ( | const MObject & | object, |
| MStatus * | ReturnStatus = NULL |
||
| ) |
Constructor.
Class constructor that initializes the function set to the given MObject.
- Parameters
-
[in] object The MObject to attach the function set to [out] ReturnStatus the return status
- Status Codes:
- MS::kSuccess if the function set is successfully attached
- MS::kInvalidParameter if the MObject does not represent a valid Maya object or if the function set is not allowed to attach to this MObject
Member Function Documentation
| int particleCount | ( | ) | const |
Returns the number of particles feeding the active instancer.
- Returns
- See description.
| int instancesForParticle | ( | int | p, |
| MDagPathArray & | paths, | ||
| MMatrix & | instancerMatrix, | ||
| MStatus * | ReturnStatus = NULL |
||
| ) | const |
Returns the DAG paths and instancer matrix for all instances generated by a specified particle.
- Parameters
-
[in] p The index of the particle being queried. [out] paths Visible DAG paths generated by particle p [out] instancerMatrix The transformation matrix that the instancer applies to the instanced paths to produce the final particle-instanced geometry. The final world matrix of each instance can be constructed by premultiplying the path's inclusive world matrix by this matrix. [out] ReturnStatus status code
- Returns
- The number of visible paths instanced for the given particle. It is possible for no paths to be instanced for a particular particle. Note that in order to use this method, the MDagPath must be used in the constructor.
- Status Codes:
- MS::kSuccess Success
- MS::kInvalidParameter Invalid particle index or program state
| MStatus allInstances | ( | MDagPathArray & | paths, |
| MMatrixArray & | matrices, | ||
| MIntArray & | particlePathStartIndices, | ||
| MIntArray & | pathIndices | ||
| ) | const |
Returns information about all instances generated by a particular particle instancer node.
Since many particles will typically instance similar sets of paths, the information is returned in a compact representation. An array of paths is returned, representing the unique set of paths that are instanced by any particle in the system. For each particle, the routine returns a set of indices into this path array to illustrate the paths instanced at that particle. The index arrays for all particles are concatenated together, so a "start index" array is used to indicate which is the first entry in the index array for each particle. For each particle, the routine also returns the transformation matrix applied to that particle's instanced paths to generate the final particle instance transformations.
- Parameters
-
[out] paths Receives the unique set of paths instanced by any particle in the system. [out] matrices For each particle p, matrices[p] receives the matrix that the instancer applies to the paths instanced under that particle to generate the final instance transformations. [out] particlePathStartIndices Receives indices into the pathIndices array indicating where the block of indices for each particle begins. The size of this array is always one more than the number of particles in the system. For particle p, the number of paths instanced under that particle is particlePathStartIndices[p+1]-particlePathStartIndices[p]. If this number is 0, then no visible paths are instanced under that particle. So, the set pathIndices[particlePathStartIndices[p]...particlePathStartIndices[p+1]-1] gives the indices into the paths array of the visible paths instanced under particle p. [out] pathIndices Receives indices into the paths array describing the visible paths instanced under each particle. The array is a sequence of variable-sized blocks, one per particle (since each particle in the system can instance a different number of paths). The particlePathStartIndices array determines where in this array to find the path indices for a particular particle.
- Returns
- MS::kSuccess Success
- MS::kInvalidParameter Invalid parameter passed for object - Node is not accessible, does not exist or is not a valid DAG Node
The documentation for this class was generated from the following files:
- MFnInstancer.h
- MFnInstancer.cpp