#include <MFnWeightGeometryFilter.h>
Weight geometry filter function set.
MFnWeightGeometryFilter is the function set for weight geometry filters. Weight geometry filter nodes include clusters, cluster flexors, and user-defined deformers derived from MPxDeformerNode. The purpose of the weight geometry filter is to store the weights for each component of each geometry that is deformed. The weight geometry filter is independent of any algorithm that calculates a deformation based on the component weight values. Clusters, cluster flexors, and user-defined deformers each have their own algorithm to determine the deformation based on the component weights.
This function set provides methods for getting and setting weights on weight geometry filter nodes. In addition to getting and settings weights on components, this class provides methods for accessing the weight geometry filter's input and output geometry through its parent class, MFnGeometryFilter.
When getting and setting weights on components, it is more efficient to use the methods that take a plug index. The plug index is a sparse array index, and is the same index used in MEL scripts to index into an array of plugs.
Public Member Functions | |
virtual MFn::Type | type () const |
Function set type. | |
virtual | ~MFnWeightGeometryFilter () |
Destructor. | |
MFnWeightGeometryFilter () | |
Default constructor. | |
MFnWeightGeometryFilter (MObject &object, MStatus *ReturnStatus=NULL) | |
Constructor. More... | |
MStatus | getWeights (unsigned int index, const MObject &components, MFloatArray &weights) const |
Gets the weights of the components that correspond to the geometry at the specified plug index. More... | |
MStatus | getWeights (const MDagPath &path, const MObject &components, MFloatArray &weights) const |
Gets the weights of the components that correspond to the geometry whose DAG path is specified. More... | |
MStatus | setWeight (const MDagPath &path, unsigned int index, const MObject &components, float weight, MFloatArray *oldValues=NULL) |
Sets the weights of the specified components of the object whose DAG path is specified. More... | |
MStatus | setWeight (const MDagPath &path, const MObject &components, float weight, MFloatArray *oldValues=NULL) |
Sets the weights of the specified components of the object whose DAG path is specified. More... | |
MStatus | setWeight (const MDagPath &path, unsigned int index, const MObject &components, MFloatArray &values) |
Sets the weights of the specified components of the object whose DAG path is specified. More... | |
MStatus | setWeight (const MDagPath &path, const MObject &components, MFloatArray &values) |
Sets the weights of the specified components of the object whose DAG path is specified. More... | |
MString | weightPlugStrings (const MSelectionList &list, MStatus *ReturnStatus=NULL) const |
Sets the plugStrings argument to be a string (separated by spaces) containing the names of the plugs on this node that correspond to the components in the selection list. More... | |
MStatus | getWeightPlugStrings (const MSelectionList &list, MStringArray &plugStringArray) const |
Set the plugStringArray argument to contain the names of the plugs on this node that correspond to the components in the selection list. More... | |
MFnWeightGeometryFilter (const MObject &object, MStatus *ReturnStatus=NULL) | |
Constructor. More... | |
MStatus | getWeightPlugStrings (const MSelectionList &list, MString &plugStrings) const |
NO SCRIPT SUPPORT. More... | |
![]() | |
virtual | ~MFnGeometryFilter () |
Destructor. | |
MFnGeometryFilter () | |
Default constructor. | |
MFnGeometryFilter (MObject &object, MStatus *ReturnStatus=NULL) | |
Constructor. More... | |
MStatus | getInputGeometry (MObjectArray &objects) const |
This method returns the input geometry for the deformer by traversing the graph to find upstream shape nodes. More... | |
MStatus | getOutputGeometry (MObjectArray &objects) const |
The output geometry is packed into the provided list of MObjects. More... | |
MObject | inputShapeAtIndex (unsigned int index, MStatus *ReturnStatus=NULL) const |
Returns the input shape corresponding to the plug index. More... | |
MObject | outputShapeAtIndex (unsigned int index, MStatus *ReturnStatus=NULL) const |
Returns the output shape corresponding to the plug index. More... | |
unsigned int | indexForOutputShape (const MObject &shape, MStatus *ReturnStatus=NULL) const |
Returns the plug index for the specified output shape. More... | |
MStatus | getPathAtIndex (unsigned int index, MDagPath &path) const |
The DAG path of the output geometry at the specified plug index is put in the dagPath argument. More... | |
unsigned int | indexForGroupId (unsigned int groupId, MStatus *ReturnStatus=NULL) const |
Returns the plug index corresponding to the groupId. More... | |
unsigned int | groupIdAtIndex (unsigned int index, MStatus *ReturnStatus=NULL) const |
Returns the groupId at the specified plug index. More... | |
unsigned int | numOutputConnections (MStatus *ReturnStatus=NULL) const |
Returns the number of output geometries connected to this node. More... | |
unsigned int | indexForOutputConnection (unsigned int connectionIndex, MStatus *ReturnStatus=NULL) const |
Returns the plug index corresponding to the connection index. More... | |
MObject | deformerSet (MStatus *ReturnStatus=NULL) const |
Returns the set containing the objects that are deformed. More... | |
float | envelope (MStatus *ReturnStatus=NULL) const |
Returns the envelope value. More... | |
MStatus | setEnvelope (float envelope) |
Sets the envelope value. More... | |
MFnGeometryFilter (const MObject &object, MStatus *ReturnStatus=NULL) | |
Constructor. More... | |
![]() | |
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... | |
![]() | |
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... | |
virtual MStatus | setObject (MObject &object) |
Attaches the Function Set to the specified Maya Object. More... | |
virtual MStatus | setObject (const MObject &object) |
NO SCRIPT SUPPORT. More... | |
Protected Member Functions | |
virtual const char * | className () const |
Class name. | |
Additional Inherited Members | |
![]() | |
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 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 const char * | className () |
Returns the name of this class. More... | |
MFnWeightGeometryFilter | ( | MObject & | object, |
MStatus * | ReturnStatus = NULL |
||
) |
MFnWeightGeometryFilter | ( | const MObject & | object, |
MStatus * | ReturnStatus = NULL |
||
) |
MStatus getWeights | ( | unsigned int | index, |
const MObject & | components, | ||
MFloatArray & | weights | ||
) | const |
Gets the weights of the components that correspond to the geometry at the specified plug index.
The relationship between the weights and the components can be determined by iterating through the components using the MItGeometry iterator. The iterator iterates through the components in the same order as the weights array.
[in] | index | the plug index corresponding to the shape that has the components |
[out] | components | the components whose weights are requested |
[out] | weights | the weight values of the components |
MStatus getWeights | ( | const MDagPath & | path, |
const MObject & | components, | ||
MFloatArray & | weights | ||
) | const |
Gets the weights of the components that correspond to the geometry whose DAG path is specified.
If the plug index is already known, it is more efficient to call the other getWeights method than this one. This getWeights method calls indexForOutputShape internally to find the plug index.
The relationship between the weights and the components can be determined by iterating through the components using the MItGeometry iterator. The iterator iterates through the components in the same order as the weights array.
[in] | path | the path of the DAG object that has the components |
[in] | components | the components whose weights are requested |
[out] | weights | the weight values of the components |
MStatus setWeight | ( | const MDagPath & | path, |
unsigned int | index, | ||
const MObject & | components, | ||
float | weight, | ||
MFloatArray * | oldValues = NULL |
||
) |
Sets the weights of the specified components of the object whose DAG path is specified.
In order to undo the setWeight operation, it is necessary to save the oldValues array and call setWeight with the oldValues array at the time of undo.
[in] | path | the DAG path for the object whose components' weights are being set |
[in] | index | the plug index for the specified shape |
[in] | components | the components of the object |
[in] | weight | weight value for the components |
[in] | oldValues | an array of old values for the components |
MStatus setWeight | ( | const MDagPath & | path, |
const MObject & | components, | ||
float | weight, | ||
MFloatArray * | oldValues = NULL |
||
) |
Sets the weights of the specified components of the object whose DAG path is specified.
If the plug index is already known, it is more efficient to call the corresponding setWeight method that takes a plugIndex. This setWeight method is a convenience method which calls indexForOutputShape internally to find the plug index.
In order to undo the setWeight operation, it is necessary to save the oldValues array and call setWeight with the oldValues array at the time of undo.
[in] | path | the DAG path for the object whose components' weights are being set |
[in] | components | the components of the object |
[in] | weight | weight value for the components |
[in] | oldValues | an array of old values for the components |
MStatus setWeight | ( | const MDagPath & | path, |
unsigned int | index, | ||
const MObject & | components, | ||
MFloatArray & | values | ||
) |
Sets the weights of the specified components of the object whose DAG path is specified.
This method is useful in conjunction with the setWeight methods that return an oldValues array. This method can be called with those oldValues to restore the weights to the previous values.
[in] | path | the DAG path for the object whose components' weights are being set |
[in] | index | the plug index for the specified shape |
[in] | components | the components of the object |
[in] | values | the value array of the components |
MStatus setWeight | ( | const MDagPath & | path, |
const MObject & | components, | ||
MFloatArray & | values | ||
) |
Sets the weights of the specified components of the object whose DAG path is specified.
This method is useful in conjunction with the setWeight methods that return an oldValues array. This method can be called with those oldValues to restore the weights to the previous values.
If the plug index is already known, it is more efficient to call the corresponding setWeight method that takes a plugIndex. This setWeight method is a convenience method which calls indexForOutputShape internally to find the plug index.
[in] | path | the DAG path for the object whose components' weights are being set |
[in] | components | the components of the object |
[in] | values | the value array of the components |
MString weightPlugStrings | ( | const MSelectionList & | list, |
MStatus * | ReturnStatus = NULL |
||
) | const |
Sets the plugStrings argument to be a string (separated by spaces) containing the names of the plugs on this node that correspond to the components in the selection list.
The method can be useful in conjunction with setting keys on a number of plugs. The operation will fail if none of the items in the selection list correspond to components weighted by this cluster.
[in] | list | selection list that contains components |
[out] | ReturnStatus | Status code |
MStatus getWeightPlugStrings | ( | const MSelectionList & | list, |
MStringArray & | plugStringArray | ||
) | const |
Set the plugStringArray argument to contain the names of the plugs on this node that correspond to the components in the selection list.
The operation will fail if none of the items in the selection list correspond to components weighted by this cluster.
[in] | list | selection list that contains components |
[out] | plugStringArray | string array containing the names of the plugs on this node that correspond to the components in the selection list; each of the plugs is put in a separate string |
MStatus getWeightPlugStrings | ( | const MSelectionList & | list, |
MString & | plugStrings | ||
) | const |
NO SCRIPT SUPPORT.
Sets the plugStrings argument to be a string (separated by spaces) containing the names of the plugs on this node that correspond to the components in the selection list.
The method can be useful in conjunction with setting keys on a number of plugs. The operation will fail if none of the items in the selection list correspond to components weighted by this cluster.
Python Notes
This method is not supported in Python. See the version which returns a string.
[in] | list | selection list that contains components |
[in] | plugStrings | string containing the names of the plugs on this node that correspond to the components in the selection list |