MFnAirField Class Reference
MFnAirField Class Reference
#include <MFnAirField.h>
Class Description
Function set for Air Fields.
Function set for creation, edit, and query of Air Fields.
An air field simulates the effects of moving air.
Inheritance diagram for MFnAirField:
Public Member Functions | |
| virtual MFn::Type | type () const |
| Function set type. | |
| virtual | ~MFnAirField () |
| Destructor. More... | |
| MFnAirField () | |
| Default constructor. | |
| MFnAirField (MObject &object, MStatus *ReturnStatus=NULL) | |
| Constructor. More... | |
| MFnAirField (const MDagPath &object, MStatus *ret=NULL) | |
| Constructor. More... | |
| MVector | direction (MStatus *ReturnStatus=NULL) const |
| Returns the direction the air is blowing. More... | |
| MStatus | setDirection (const MVector &airDirection) |
| Sets the direction vector for the air to blow. More... | |
| double | speed (MStatus *ReturnStatus=NULL) const |
| Returns the control setting on how quickly objects match the velocity of the air field. More... | |
| MStatus | setSpeed (double value) |
| Sets the control setting on how quickly the objects match the velocity of the air field. More... | |
| double | inheritVelocity (MStatus *ReturnStatus=NULL) const |
| Returns the amount of the moving air field's velocity that is added to the direction and magnitude of the wind. More... | |
| MStatus | setInheritVelocity (double velocity) |
| Sets the amount of the moving air field's velocity that is added to the direction and magnitude of the wind. More... | |
| bool | inheritRotation (MStatus *ReturnStatus=NULL) const |
| Returns true if the air field is rotating or parented to a rotating object, and will undergo that same rotation. More... | |
| MStatus | setInheritRotation (bool enable) |
| Enables the air field to undergo rotations and effect the direction that the air field points. More... | |
| bool | componentOnly (MStatus *ReturnStatus=NULL) const |
| Returns true if the air field will apply force only in the direction specified by the combination of its direction, speed, and inherit velocity attributes. More... | |
| MStatus | setComponentOnly (bool enable) |
| Enables the air field to apply force specified as a combination of its direction, speed, and inherit veloicty attributes. More... | |
| double | spread (MStatus *ReturnStatus=NULL) const |
| Returns a value that represents an angle which objects are affected by the air fields direction setting. More... | |
| MStatus | setSpread (double value) |
| Sets the value representing an angle which objects are affected by the air fields direction setting. More... | |
| bool | enableSpread (MStatus *ReturnStatus=NULL) const |
| Returns true if the air field is using the spread angle to define the influence of the air field. More... | |
| MStatus | setEnableSpread (bool enable) |
| Enables the air field to influence objects based on the spread angle setting. More... | |
| MFnAirField (const MObject &object, MStatus *ret=NULL) | |
| Constructor. More... | |
| Public Member Functions inherited from MFnField | |
| virtual | ~MFnField () |
| Destructor. More... | |
| MFnField () | |
| Default constructor. | |
| MFnField (MObject &object, MStatus *ReturnStatus=NULL) | |
| Constructor. More... | |
| MFnField (const MDagPath &object, MStatus *ret=NULL) | |
| Constructor. More... | |
| MStatus | getForceAtPoint (const MPointArray &point, const MVectorArray &velocity, const MDoubleArray &mass, MVectorArray &force, double deltaTime=1.0/24.0) |
| Compute the force of a field on an array of points, given their position, velocity, and mass. More... | |
| MStatus | getForceAtPoint (const MVectorArray &point, const MVectorArray &velocity, const MDoubleArray &mass, MVectorArray &force, double deltaTime=1.0/24.0) |
| Compute the force of a field on an array of points, given their position, velocity, and mass. More... | |
| double | magnitude (MStatus *ReturnStatus=NULL) const |
| Returns the strength of the field. More... | |
| MStatus | setMagnitude (double mag) |
| Sets the strength of the field. More... | |
| double | attenuation (MStatus *ReturnStatus=NULL) const |
| Returns the rate of change where the strength of the field changes as the distance between the field and the affected object increases. More... | |
| MStatus | setAttenuation (double atten) |
| Sets the rate of change where the strength of the field changes as the distance between the field and the affected object increases. More... | |
| double | maxDistance (MStatus *ReturnStatus=NULL) const |
| Returns the maximum distance from the field at which the force of the field is exerted. More... | |
| MStatus | setMaxDistance (double maxDist) |
| Sets the maximum distance from the field at which the force of the field is exerted. More... | |
| bool | perVertex (MStatus *ReturnStatus=NULL) const |
| Returns true if the field exerts its force on each individual point (cv, particle, vertex) equally. More... | |
| MStatus | setPerVertex (bool enable) |
| Enables the field to exert its force on each individual point (cv, particle, vertex) equally. More... | |
| bool | useMaxDistance (MStatus *ReturnStatus=NULL) const |
| Returns true if the field will use the maximum distance setting to determine the area of influence. More... | |
| MStatus | setUseMaxDistance (bool enable) |
| Enables the field to use the maximum distance setting to determine the area of influence. More... | |
| double | falloffCurve (const double param, MStatus *ReturnStatus=NULL) |
| Returns falloff given the param in [0,1]. More... | |
| bool | isFalloffCurveConstantOne (MStatus *ReturnStatus=NULL) |
| Returns true if falloffCurve is a constant one (default) or false if not. More... | |
| MFnField (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.
| MFnAirField | ( | 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
| MFnAirField | ( | 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
| MFnAirField | ( | 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
Returns the direction the air is blowing.
- Parameters
-
[out] ReturnStatus Status code
- Returns
- A vector representing direction.
- Status Codes:
- MS::kSuccess The method was successful.
- MS::kFailure An object error has occurred.
Sets the direction vector for the air to blow.
- Parameters
-
[in] airDirection A vector representing direction.
- Returns
- Status code
- Status Codes:
- MS::kSuccess The method was successful.
- MS::kFailure An object error has occurred.
| double speed | ( | MStatus * | ReturnStatus = NULL | ) | const |
Returns the control setting on how quickly objects match the velocity of the air field.
- Parameters
-
[out] ReturnStatus Status code
- Returns
- The value of the speed setting.
- Status Codes:
- MS::kSuccess The method was successful.
- MS::kFailure An object error has occurred.
| MStatus setSpeed | ( | double | value | ) |
Sets the control setting on how quickly the objects match the velocity of the air field.
- Parameters
-
[in] value A value representing speed. - A value of 0 is equivalent of turning the air field off.
- A value of 1 and objects will match the velocity almost instantaneously.
- Returns
- Status code
- Status Codes:
- MS::kSuccess The method was successful.
- MS::kFailure An object error has occurred.
| double inheritVelocity | ( | MStatus * | ReturnStatus = NULL | ) | const |
Returns the amount of the moving air field's velocity that is added to the direction and magnitude of the wind.
- Parameters
-
[out] ReturnStatus Status code
- Returns
- A value from 0 to 1 representing the amount of velocity added.
- Status Codes:
- MS::kSuccess The method was successful.
- MS::kFailure An object error has occurred.
| MStatus setInheritVelocity | ( | double | velocity | ) |
Sets the amount of the moving air field's velocity that is added to the direction and magnitude of the wind.
- Parameters
-
[in] velocity A value from 0 to 1 representing the amount of velocity that is added.
- Returns
- Status code
- Status Codes:
- MS::kSuccess The method was successful.
- MS::kFailure An object error has occurred.
| bool inheritRotation | ( | MStatus * | ReturnStatus = NULL | ) | const |
Returns true if the air field is rotating or parented to a rotating object, and will undergo that same rotation.
- Parameters
-
[out] ReturnStatus Status code
- Returns
- true Rotations will change the direction the air field points.
- false Rotations do not change the air field direction.
- Status Codes:
- MS::kSuccess The method was successful.
- MS::kFailure An object error has occurred.
| MStatus setInheritRotation | ( | bool | enable | ) |
Enables the air field to undergo rotations and effect the direction that the air field points.
- Parameters
-
[in] enable Flag to enable or disable rotations effects.
- Returns
- Status code
- Status Codes:
- MS::kSuccess The method was successful.
- MS::kFailure An object error has occurred.
| bool componentOnly | ( | MStatus * | ReturnStatus = NULL | ) | const |
Returns true if the air field will apply force only in the direction specified by the combination of its direction, speed, and inherit velocity attributes.
Returns false if the force is made to effect the object's velocity to match the air field's velocity.
- Parameters
-
[out] ReturnStatus Status code
- Returns
- true Force applied only in direction of attributes.
- false Force applied to match velocities.
- Status Codes:
- MS::kSuccess The method was successful.
- MS::kFailure An object error has occurred.
| MStatus setComponentOnly | ( | bool | enable | ) |
Enables the air field to apply force specified as a combination of its direction, speed, and inherit veloicty attributes.
- Parameters
-
[in] enable Flag to enable or disable combination of attributes.
- Returns
- Status code
- Status Codes:
- MS::kSuccess The method was successful.
- MS::kFailure An object error has occurred.
| double spread | ( | MStatus * | ReturnStatus = NULL | ) | const |
Returns a value that represents an angle which objects are affected by the air fields direction setting.
This value is taken into account when the Enable Spread attribute is turned on.
- Parameters
-
[out] ReturnStatus Status code
- Returns
- A value from 0 to 1 representing an angle.
- A value of 0 effects objects only exactly in front of the direction vector.
- A value of 1 effects objects in front by 180 degrees along the direction vector.
- Status Codes:
- MS::kSuccess The method was successful.
- MS::kFailure An object error has occurred.
| MStatus setSpread | ( | double | value | ) |
Sets the value representing an angle which objects are affected by the air fields direction setting.
This value is taken into account when the Enable Spread attribute is turned on.
- Parameters
-
[in] value A value representing an angle. - A value of 0 effects objects only exactly in front of the direction vector.
- A value of 1 effects objects in front by 180 degrees along the direction vector.
- Returns
- Status code
- Status Codes:
- MS::kSuccess The method was successful.
- MS::kFailure An object error has occurred.
| bool enableSpread | ( | MStatus * | ReturnStatus = NULL | ) | const |
Returns true if the air field is using the spread angle to define the influence of the air field.
- Parameters
-
[out] ReturnStatus Status code
- Returns
- true Objects are affected in the area of the spread angle.
- false Objects are affected by the max distance setting.
- Status Codes:
- MS::kSuccess The method was successful.
- MS::kFailure An object error has occurred.
| MStatus setEnableSpread | ( | bool | enable | ) |
Enables the air field to influence objects based on the spread angle setting.
- Parameters
-
[in] enable Flag to enable or disable use of the spread angle.
- Returns
- Status code
- Status Codes:
- MS::kSuccess The method was successful.
- MS::kFailure An object error has occurred.
The documentation for this class was generated from the following files:
- MFnAirField.h
- MFnAirField.cpp