C++ API Reference
|
wire deformer function set More...
#include <MFnWireDeformer.h>
Public Member Functions | |
virtual MFn::Type | type () const |
Function set type. More... | |
virtual | ~MFnWireDeformer () |
Destructor. | |
MFnWireDeformer () | |
Default constructor. | |
MFnWireDeformer (MObject &object, MStatus *ReturnStatus=NULL) | |
Constructor. More... | |
MObject | create (MStatus *ReturnStatus=NULL) |
Creates a new wire deformer. More... | |
MStatus | addGeometry (const MObject &object) |
Adds a piece of geometry to the deformation. More... | |
MStatus | removeGeometry (const MObject &object) |
Removes a piece of geometry from the deformation. More... | |
MStatus | getAffectedGeometry (MObjectArray &objects) |
The geometry affected by this deformer is packed into the provided list of MObjects. More... | |
unsigned int | numWires (MStatus *ReturnStatus=NULL) const |
returns the number of wire curves connected to this deformer. More... | |
MStatus | addWire (const MObject &object) |
Adds a new wire curve to the deformation. More... | |
MObject | wire (unsigned int wireIndex, MStatus *ReturnStatus=NULL) |
Return the wire at the given index. More... | |
float | wireDropOffDistance (unsigned int wireIndex, MStatus *ReturnStatus=NULL) const |
Return the drop off distance of the wire at the given index. More... | |
MStatus | setWireDropOffDistance (unsigned int wireIndex, float dropOff) |
Sets the drop off distance of the wire at the given index. More... | |
float | wireScale (unsigned int wireIndex, MStatus *ReturnStatus=NULL) const |
Return the radial scale of the wire at the given index. More... | |
MStatus | setWireScale (unsigned int wireIndex, float scale) |
Sets the radial scale value of the wire at the given index. More... | |
MObject | holdingShape (unsigned int wireIndex, MStatus *ReturnStatus=NULL) const |
Returns the holding shape for the given wire. More... | |
MStatus | setHoldingShape (unsigned int wireIndex, MObject holdingCurve) |
Sets the holding shape for the given wire. More... | |
float | envelope (MStatus *ReturnStatus=NULL) const |
Returns the envelope for this deformer. More... | |
MStatus | setEnvelope (float envelope) |
Sets the envelope for this deformer. More... | |
float | rotation (MStatus *ReturnStatus=NULL) const |
Returns the rotation value for this deformer. More... | |
MStatus | setRotation (float rotation) |
Sets the rotation value for this deformer. More... | |
float | localIntensity (MStatus *ReturnStatus=NULL) const |
Returns the local intensity for this wire deformer. More... | |
MStatus | setLocalIntensity (float localIntensity) |
Sets the local intensity for this wire deformer. More... | |
float | crossingEffect (MStatus *ReturnStatus=NULL) const |
Returns the crossing effect for this wire deformer. More... | |
MStatus | setCrossingEffect (float crossingEffect) |
Sets the crossing effect for this wire deformer. More... | |
unsigned int | numDropoffLocators (unsigned int wireIndex, MStatus *ReturnStatus=NULL) const |
Returns the number of drop off locators. More... | |
MStatus | setDropoffLocator (unsigned int wireIndex, unsigned int locatorIndex, float param, float percentage) |
Sets the parameters of a drop off locator. More... | |
MStatus | getDropoffLocator (unsigned int wireIndex, unsigned int locatorIndex, float ¶m, float &percentage) |
Gets the parameters of a drop off locator. More... | |
MFnWireDeformer (const MObject &object, MStatus *ReturnStatus=NULL) | |
Constructor. 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 | uniqueName (MStatus *ReturnStatus=NULL) const |
Returns the unique 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... | |
bool | affectsAnimation (MStatus *ReturnStatus=NULL) const |
Indicates whether or not this node is allowed to animate. More... | |
MStatus | setAffectsAnimation () |
Define a node can affect animation. More... | |
MString | setName (const MString &name, MStatus *ReturnStatus) |
This method is obsolete. More... | |
MFnDependencyNode (const MObject &object, MStatus *ReturnStatus=NULL) | |
This method is not available in Python. More... | |
bool | getPlugsAlias (const MPlug &plug, MString &aliasName, MStatus *ReturnStatus=NULL) |
This method is not available in Python. 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=nullptr) 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... | |
Static Public Member Functions | |
static const char * | className () |
Returns the name of this class. More... | |
Static Public Member Functions inherited from MFnDependencyNode | |
static const char * | className () |
Returns the name of this class. 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 Public Member Functions inherited from MFnBase | |
static const char * | className () |
Returns the name of this class. More... | |
static const char * | typeString (MFn::Type) |
Returns the type string for a given type. More... | |
static bool | isValid (MFn::Type) |
Returns true if type is in the range of valid types. More... | |
Additional Inherited Members | |
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... | |
wire deformer function set
MFnWireDeformer is the function set for wire deformers. Wire deformers modify geometry based on its proximity to controlling wire curves. As the wire curves are modified, the parts of the geometry close to the curve will follow.
The wire deformer is actually a small network of dependency nodes in the dependency graph. This function set is provided to make manipulation of the network easier. The main deformer node should be given to this function set as its object.
MFnWireDeformer | ( | MObject & | object, |
MStatus * | ReturnStatus = NULL |
||
) |
MFnWireDeformer | ( | const MObject & | object, |
MStatus * | ReturnStatus = NULL |
||
) |
|
virtual |
Function set type.
Return the class type : MFn::kWire.
Reimplemented from MFnDependencyNode.
|
static |
Returns the name of this class.
Return the class name : "MFnWireDeformer".
Creates a new wire deformer.
This function set's object is set to be the new wire deformer node.
[out] | ReturnStatus | return status |
Adds a piece of geometry to the deformation.
After adding new geometry to the deformation. The new geometry will then be deformed by the existing wires.
[in] | object | the geometry |
Removes a piece of geometry from the deformation.
[in] | object | the geometry |
MStatus getAffectedGeometry | ( | MObjectArray & | objects | ) |
The geometry affected by this deformer is packed into the provided list of MObjects.
Each of the MObjects will be a DAG node that has geometry.
[out] | objects | storage for the returned array |
unsigned int numWires | ( | MStatus * | ReturnStatus = NULL | ) | const |
returns the number of wire curves connected to this deformer.
[out] | ReturnStatus | return status |
Adds a new wire curve to the deformation.
[in] | object | the new wire |
Return the wire at the given index.
The returned object will be a nurbs curve shape suitable for use with the MFnNurbsCurve function set.
[in] | wireIndex | index of wire to return |
[out] | ReturnStatus | return status |
float wireDropOffDistance | ( | unsigned int | wireIndex, |
MStatus * | ReturnStatus = NULL |
||
) | const |
Return the drop off distance of the wire at the given index.
Increasing this value will give the wire a greater area of influence.
[in] | wireIndex | index of wire to return the drop off distance for |
[out] | ReturnStatus | return status |
MStatus setWireDropOffDistance | ( | unsigned int | wireIndex, |
float | dropOff | ||
) |
Sets the drop off distance of the wire at the given index.
Increasing this value will give the wire a greater area of influence.
[in] | wireIndex | index of wire to set the drop off distance for |
[in] | dropOff | new drop off value |
float wireScale | ( | unsigned int | wireIndex, |
MStatus * | ReturnStatus = NULL |
||
) | const |
Return the radial scale of the wire at the given index.
The scale value affects how the wire modifies the geometry in its area of influence. A value of between 0.0 and 1.0 causes the wire to pull the surrounding geometry points towards itself. A value of greater than one causes the wire to repulse the geometry points around it. A value of exactly 1.0 causes the wire to neither pull nor push the points around it.
The surrounding points will always deform with the wire, The scale factor just allows the points around the wire to be radially scaled closer to or further from the wire.
[in] | wireIndex | index of wire to return the scale value for |
[out] | ReturnStatus | return status |
MStatus setWireScale | ( | unsigned int | wireIndex, |
float | scale | ||
) |
Sets the radial scale value of the wire at the given index.
The scale value affects how the wire modifies the geometry in its area of influence. A value of between 0.0 and 1.0 causes the wire to pull the surrounding geometry points towards itself. A value of greater than one causes the wire to repulse the geometry points around it. A value of exactly 1.0 causes the wire to neither pull nor push the points around it.
The surrounding points will always deform with the wire, The scale factor just allows the points around the wire to be radially scaled closer to or further from the wire.
[in] | wireIndex | index of wire to set the drop off distance for |
[in] | scale | new scale value |
Returns the holding shape for the given wire.
The holding shape may be a nurbs curve or a nurbs surface. If the given wire does not have a holding shape, then a null MObject handle will be returned.
A holding shape pins down the deforming shapes when the associated wire is moved. One possible application is to use a curve to limit the area that a wire affects.
[in] | wireIndex | index of wire to get the holding shape for |
[out] | ReturnStatus | return status |
Sets the holding shape for the given wire.
The holding shape may be a nurbs curve or a nurbs surface.
A holding shape pins down the deforming shapes when the associated wire is moved. One possible application is to use a curve to limit the area that a wire affects.
[in] | wireIndex | index of wire to set the holding shape for |
[in] | holdingShape | nurbs curve or surface to use as holding shape |
float envelope | ( | MStatus * | ReturnStatus = NULL | ) | const |
Returns the envelope for this deformer.
The envelope is a scale factor that affects the dropoff distances of all wires that belong to this deformer.
[in] | ReturnStatus | return status |
MStatus setEnvelope | ( | float | envelope | ) |
Sets the envelope for this deformer.
The envelope is a scale factor that affects the dropoff distances of all wires that belong to this deformer.
[in] | envelope | envelope value |
float rotation | ( | MStatus * | ReturnStatus = NULL | ) | const |
Returns the rotation value for this deformer.
The rotation value determines how much the tangency of the wire curve affects the deformation. When the rotation value is 0.0, the deformation will be linear. The geometry will pull straight towards the wire. When the rotation value is 1.0, the tangency of the wire curve is taken into effect. This will provide more natural deformations when the wire curve is twisted with respect to its original position. The surface will pull towards the wire in an arc rather than in a straight line.
[out] | ReturnStatus | return status |
MStatus setRotation | ( | float | rotation | ) |
Sets the rotation value for this deformer.
The rotation value determines how much the tangency of the wire curve affects the deformation. When the rotation value is 0.0, the deformation will be linear. The geometry will pull straight towards the wire. When the rotation value is 1.0, the tangency of the wire curve is taken into effect. This will provide more natural deformations when the wire curve is twisted with respect to its original position. The surface will pull towards the wire in an arc rather than in a straight line.
[in] | rotation | new rotation value |
float localIntensity | ( | MStatus * | ReturnStatus = NULL | ) | const |
Returns the local intensity for this wire deformer.
The local intensity has an effect when two wire curves are positioned close to each other. Normally, only the most deformed of the two curves will affect the surface. When the local intensity is increased, the less deformed curve will start to pull the surface back towards itself.
[out] | ReturnStatus | return status |
MStatus setLocalIntensity | ( | float | localIntensity | ) |
Sets the local intensity for this wire deformer.
The local intensity has an effect when two wire curves are positioned close to each other. Normally, only the most deformed of the two curves will affect the surface. When the local intensity is increased, the less deformed curve will start to pull the surface back towards itself.
[in] | localIntensity | New local intensity value |
float crossingEffect | ( | MStatus * | ReturnStatus = NULL | ) | const |
Returns the crossing effect for this wire deformer.
The crossing effect applies when two wire curves cross each other. Normally, the deformation is dampened so that the surface is only affected by the most deformed curve at the intersection point. When the crossing effect is increased, the effect of the wires becomes additive. So, the object will be deform more near crossing wires.
[out] | ReturnStatus | return status |
MStatus setCrossingEffect | ( | float | crossingEffect | ) |
Sets the crossing effect for this wire deformer.
The crossing effect applies when two wire curves cross each other. Normally, the deformation is dampened so that the surface is only affected by the most deformed curve at the intersection point. When the crossing effect is increased, the effect of the wires becomes additive. So, the object will be deform more near crossing wires.
[in] | crossingEffect | New crossing effect value |
unsigned int numDropoffLocators | ( | unsigned int | wireIndex, |
MStatus * | ReturnStatus = NULL |
||
) | const |
Returns the number of drop off locators.
A drop off locator allows the modification the wire curve drop off distance at a specific point on the wire curve.
[in] | wireIndex | the index of the wire curve to query |
[out] | ReturnStatus | return status |
MStatus setDropoffLocator | ( | unsigned int | wireIndex, |
unsigned int | locatorIndex, | ||
float | param, | ||
float | percentage | ||
) |
Sets the parameters of a drop off locator.
A drop off locator allows the modification the wire curve drop off distance at a specific point on the wire curve.
[in] | wireIndex | index of the wire curve |
[in] | locatorIndex | index of the locator on the given wire |
[in] | param | new param value along the curve at which to position the locator |
[in] | percentage | percentage of the drop off distance applied |
MStatus getDropoffLocator | ( | unsigned int | wireIndex, |
unsigned int | locatorIndex, | ||
float & | param, | ||
float & | percentage | ||
) |
Gets the parameters of a drop off locator.
A drop off locator allows the modification the wire curve drop off distance at a specific point on the wire curve.
[in] | wireIndex | index of the wire curve |
[in] | locatorIndex | index of the locator on the given wire |
[in] | param | storage for the param value along the curve that the locator is positioned at |
[in] | percentage | storage for the percentage value of the locator |