C++ API Reference

Motion path animation function set. More...

#include <MFnMotionPath.h>

+ Inheritance diagram for MFnMotionPath:

Public Types

enum  Axis { kXaxis, kYaxis, kZaxis }
 Available axes. 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...
 

Public Member Functions

virtual MFn::Type type () const
 Function set type. More...
 
virtual ~MFnMotionPath ()
 Destructor.
 
 MFnMotionPath ()
 Default constructor.
 
 MFnMotionPath (MObject &object, MStatus *ReturnStatus=NULL)
 Constructor. More...
 
MObject create (const MDagPath &pathObject, const MDagPath &objectToAnimate, MTime &timeStart, MTime &timeEnd, MDGModifier *modifier=NULL, MStatus *ReturnStatus=NULL)
 Create a new motion path dependency node. More...
 
MStatus setPathObject (const MDagPath &pathObject, MDGModifier *modifier=NULL)
 Set the curve or surface for this motion path. More...
 
MDagPath pathObject (MStatus *ReturnStatus=NULL)
 Return a dag path to the motion path object. More...
 
MStatus addAnimatedObject (const MDagPath &objectToAnimate, MDGModifier *modifier=NULL)
 Add an object to be animated along this motion path. More...
 
MStatus getAnimatedObjects (MDagPathArray &array)
 Returns an array of dag paths to the animated objects for this motion path. More...
 
MStatus setFollow (bool on, MDGModifier *modifier=NULL)
 Setting follow on will cause the animated object(s) local axis to be aligned with the tangent of the motion path. More...
 
bool follow (MStatus *ReturnStatus=NULL) const
 Determines whether follow is set for this motion path node. More...
 
MStatus setFollowAxis (Axis axis)
 Sets the axis of the animated object that will follow the motion path. More...
 
Axis followAxis (MStatus *ReturnStatus=NULL)
 Return the follow axis for this motion path. More...
 
MStatus setUpAxis (Axis axis)
 Set the up-axis for this motion path. More...
 
Axis upAxis (MStatus *ReturnStatus=NULL)
 Return the up-axis for this motion path. More...
 
MStatus setBank (bool bank)
 
bool bank (MStatus *ReturnStatus=NULL) const
 Determines whether bank has been enabled for this motion path. More...
 
MStatus setBankScale (double bankScale)
 Set the bank scale for this motion path. More...
 
double bankScale (MStatus *ReturnStatus=NULL)
 Return the bank scale for this motion path. More...
 
MStatus setBankThreshold (double bankThreshold)
 Set the bank threshold for this motion path. More...
 
double bankThreshold (MStatus *ReturnStatus=NULL)
 Return the bank threshold for this motion path. More...
 
MStatus setUseNormal (bool use)
 If true, enables alignment of the up axis of the animated object to the normal vector of the path geometry. More...
 
bool useNormal (MStatus *ReturnStatus=NULL)
 Determines whether the up-axis of the animated object for this motion path is aligned with the normal vector of the path geometry. More...
 
MStatus setInverseNormal (bool invert)
 If true, enable alignment of the up axis of the moving object(s) to the opposite direction of the normal vector of the path geometry. More...
 
bool inverseNormal (MStatus *ReturnStatus=NULL)
 Determines whether the up-axis of the animated object for this motion path is aligned to the opposite direction of the normal vector of the path geometry. More...
 
MStatus setUStart (double start)
 Sets the starting value of the u parameterization for the animation. More...
 
MStatus setUEnd (double end)
 Sets the end value of the u parameterization for the animation. More...
 
double uStart (MStatus *ReturnStatus=NULL)
 Returns the starting value of the u parameterization for the animation. More...
 
double uEnd (MStatus *ReturnStatus=NULL)
 Returns the end value of the u parameterization for the animation. More...
 
MStatus setUTimeStart (MTime &start)
 Sets the starting time of the animation for the u parameter. More...
 
MStatus setUTimeEnd (MTime &end)
 Sets the end time of the animation for the u parameter. More...
 
MTime uTimeStart (MStatus *ReturnStatus=NULL)
 Returns the start time of the animation for the u parameter. More...
 
MTime uTimeEnd (MStatus *ReturnStatus=NULL)
 Returns the end time of the animation for the u parameter. More...
 
unsigned int numPositionMarkers (MStatus *ReturnStatus=NULL)
 Returns the number of position markers on this motion path. More...
 
MObject getPositionMarker (unsigned int, MStatus *ReturnStatus=NULL)
 Gets the position marker where markerNum is the order in which the marker was created. More...
 
unsigned int numOrientationMarkers (MStatus *ReturnStatus=NULL)
 Returns the number of orientation markers on this motion path. More...
 
MObject getOrientationMarker (unsigned int, MStatus *ReturnStatus=NULL)
 Gets the orientation marker where markerNum is the order in which the marker was created. More...
 
 MFnMotionPath (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...
 
MPxNodeuserNode (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::Associationsmetadata (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...
 

Detailed Description

Motion path animation function set.

This class is used for constructing and manipulating motion path animation.

Motion path animation requires a curve (or surface) and one or more other objects. During the animation, the objects will be moved along the curve.

Setting "follow" for the motion path aligns the object(s) local axis to the tangent of the motion path. Banking can also be applied to objects.

Motion path markers are points along the path where the orientation and position for the object(s) travelling along the path can be specified.

Examples:
motionPathCmd/motionPathCmd.cpp.

Member Enumeration Documentation

enum Axis

Available axes.

Enumerator
kXaxis 

 

kYaxis 

 

kZaxis 

 

Constructor & Destructor Documentation

MFnMotionPath ( MObject object,
MStatus ReturnStatus = NULL 
)

Constructor.

Class constructor that initializes the function set to the given MObject.

Parameters
[in]objectThe MObject to attach the function set to
[out]ReturnStatusthe 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
MFnMotionPath ( const MObject object,
MStatus ReturnStatus = NULL 
)

Constructor.

Class constructor that initializes the function set to the given MObject.

Parameters
[in]objectThe MObject to attach the function set to
[out]ReturnStatusthe 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

MFn::Type type ( ) const
virtual

Function set type.

Return the class type : MFn::kMotionPath.

Returns
the class type.

Reimplemented from MFnDependencyNode.

OPENMAYA_MAJOR_NAMESPACE_OPEN const char * className ( )
static

Returns the name of this class.

Return the class name : "MFnMotionPath".

Returns
Name of this class.
MObject create ( const MDagPath pathObject,
const MDagPath objectToAnimate,
MTime timeStart,
MTime timeEnd,
MDGModifier modifier = NULL,
MStatus ReturnStatus = NULL 
)

Create a new motion path dependency node.

When a motion path node is created, the following defaults are set:

  • Follow OFF
  • Bank OFF
  • BankScale 1.0
  • BankThreshold 0.5 * PI
Parameters
[in]pathObjectthe curve, surface, or curve-on-surface to use as the object path
[in]objectToAnimatethe object that will follow the motion path
[in]timeStartthe time at which to start the animation
[in]timeEndthe time at which to end the animation
[in]modifierthis object will hold the undo information
[out]ReturnStatusStatus Code
Returns
The new motion path node
Status Codes:
  • MS::kSuccess Member was successful
  • MS::kLicenseFailure application not licensed for attempted operation
  • MS::kFailure An object error has occurred
Examples:
motionPathCmd/motionPathCmd.cpp.
MStatus setPathObject ( const MDagPath pathObject,
MDGModifier modifier = NULL 
)

Set the curve or surface for this motion path.

All animated objects for this motion path will follow the new path that is specified.

Parameters
[in]pathObjectThe curve (or surface) that will be the motion path
[in]modifierThe object that will hold the undo information
Returns
Status Code
Status Codes:
  • MS::kSuccess Member was successful
  • MS::kFailure An object error has occurred
MDagPath pathObject ( MStatus ReturnStatus = NULL)

Return a dag path to the motion path object.

The motion path object is the curve/surface that animated objects of this node will move along.

Parameters
[out]ReturnStatusStatus Code
Returns
The dag path of the motion path object
Status Codes:
  • MS::kSuccess Member was successful
  • MS::kFailure An object error has occurred
MStatus addAnimatedObject ( const MDagPath objectToAnimate,
MDGModifier modifier = NULL 
)

Add an object to be animated along this motion path.

Parameters
[in]objectToAnimateA DAG path to the animated object
[in]modifierThe object that will hold the undo information
Returns
Status Code
Status Codes:
  • MS::kSuccess Member was successful
  • MS::kFailure An object error has occurred
MStatus getAnimatedObjects ( MDagPathArray array)

Returns an array of dag paths to the animated objects for this motion path.

Parameters
[out]arrayStorage for the dag paths.
Returns
Status Code
Status Codes:
  • MS::kSuccess Member was successful
  • MS::kFailure An object error has occurred
MStatus setFollow ( bool  on,
MDGModifier modifier = NULL 
)

Setting follow on will cause the animated object(s) local axis to be aligned with the tangent of the motion path.

The default alignment axis is Y.

Parameters
[in]onSpecifies whether follow is activated for this motion path
[in]modifierThe object that will hold the undo information
Returns
Status Code
Status Codes:
  • MS::kSuccess Member was successful
  • MS::kFailure An object error has occurred
bool follow ( MStatus ReturnStatus = NULL) const

Determines whether follow is set for this motion path node.

Parameters
[out]ReturnStatusStatus Code
Returns
  • true Follow is turned on
  • false Follow is turned off
Status Codes:
  • MS::kSuccess Member was successful
  • MS::kFailure An object error has occurred
MStatus setFollowAxis ( MFnMotionPath::Axis  axis)

Sets the axis of the animated object that will follow the motion path.

Possible alignment parameters are kXaxis, kYaxiz, or kZaxis.

Parameters
[in]axisObject axis to align with motion path tangent
Returns
Status Code
Status Codes:
  • MS::kSuccess Member was successful
  • MS::kFailure An object error has occurred
MFnMotionPath::Axis followAxis ( MStatus ReturnStatus = NULL)

Return the follow axis for this motion path.

Parameters
[out]ReturnStatusStatus Code
Returns
The follow axis.
Status Codes:
  • MS::kSuccess Member was successful
  • MS::kFailure An object error has occurred
MStatus setUpAxis ( MFnMotionPath::Axis  axis)

Set the up-axis for this motion path.

Parameters
[in]axisAxis to be set
Returns
Status Code
Status Codes:
  • MS::kSuccess Member was successful
  • MS::kFailure An object error has occurred
MFnMotionPath::Axis upAxis ( MStatus ReturnStatus = NULL)

Return the up-axis for this motion path.

Parameters
[out]ReturnStatusStatus Code
Returns
The up-axis for this motion path
Status Codes:
  • MS::kSuccess Member was successful
  • MS::kFailure An object error has occurred
MStatus setBank ( bool  bank)
Parameters
[in]bankSpecifies whether bank is turned on
Returns
Status Code
Status Codes:
  • MS::kSuccess Member was successful
  • MS::kFailure An object error has occurred
bool bank ( MStatus ReturnStatus = NULL) const

Determines whether bank has been enabled for this motion path.

Parameters
[out]ReturnStatusStatus Code
Returns
  • true Bank is enabled
  • false Bank is disabled
Status Codes:
  • MS::kSuccess Member was successful
  • MS::kFailure An object error has occurred
MStatus setBankScale ( double  bankScale)

Set the bank scale for this motion path.

If the computed bank angles are not large enough, the user can specify the bankScale to amplify them. The default value is 1.

Positive bankScale produces inward bank angle, negative bankScale produces outward bank angle.

Parameters
[in]bankScaleThe new bank scale value
Returns
Status Code
Status Codes:
  • MS::kSuccess Member was successful
  • MS::kFailure An object error has occurred
double bankScale ( MStatus ReturnStatus = NULL)

Return the bank scale for this motion path.

Parameters
[out]ReturnStatusStatus Code
Returns
The bank scale.
Status Codes:
  • MS::kSuccess Member was successful
  • MS::kFailure An object error has occurred
MStatus setBankThreshold ( double  bankThreshold)

Set the bank threshold for this motion path.

The bank threshold is used to specify the maximum bank angle. The default value is 90 degrees.

Parameters
[in]bankThresholdThe new bank threshold value
Returns
Status Code
Status Codes:
  • MS::kSuccess Member was successful
  • MS::kFailure An object error has occurred
double bankThreshold ( MStatus ReturnStatus = NULL)

Return the bank threshold for this motion path.

The bank threshold is used to specify the maximum bank angle. The default value is 90 degrees.

Parameters
[out]ReturnStatusStatus Code
Returns
The bank threshold.
Status Codes:
  • MS::kSuccess Member was successful
  • MS::kFailure An object error has occurred
MStatus setUseNormal ( bool  use)

If true, enables alignment of the up axis of the animated object to the normal vector of the path geometry.

Parameters
[in]useSpecifies if normal is used
Returns
Status Code
Status Codes:
  • MS::kSuccess Member was successful
  • MS::kFailure An object error has occurred
bool useNormal ( MStatus ReturnStatus = NULL)

Determines whether the up-axis of the animated object for this motion path is aligned with the normal vector of the path geometry.

Parameters
[out]ReturnStatusStatus Code
Returns
  • true Normal vector is used for object alignment.
  • false Normal vector is not used for object alignment.
Status Codes:
  • MS::kSuccess Member was successful
  • MS::kFailure An object error has occurred
MStatus setInverseNormal ( bool  invert)

If true, enable alignment of the up axis of the moving object(s) to the opposite direction of the normal vector of the path geometry.

Parameters
[in]invertSpecifies if inverse normal is used
Returns
Status Code
Status Codes:
  • MS::kSuccess Member was successful
  • MS::kFailure An object error has occurred
bool inverseNormal ( MStatus ReturnStatus = NULL)

Determines whether the up-axis of the animated object for this motion path is aligned to the opposite direction of the normal vector of the path geometry.

Parameters
[out]ReturnStatusStatus Code
Returns
  • true Inverse normal vector is used for object alignment.
  • false Inverse normal vector is not used for object alignment.
Status Codes:
  • MS::kSuccess Member was successful
  • MS::kFailure An object error has occurred
MStatus setUStart ( double  start)

Sets the starting value of the u parameterization for the animation.

Parameters
[in]startthe new start value
Returns
Status Code
Status Codes:
  • MS::kSuccess Member was successful
  • MS::kFailure An object error has occurred
MStatus setUEnd ( double  end)

Sets the end value of the u parameterization for the animation.

Parameters
[in]endthe new end value
Returns
Status Code
Status Codes:
  • MS::kSuccess Member was successful
  • MS::kFailure An object error has occurred
double uStart ( MStatus ReturnStatus = NULL)

Returns the starting value of the u parameterization for the animation.

Parameters
[out]ReturnStatusStatus Code
Returns
The starting value
Status Codes:
  • MS::kSuccess Member was successful
  • MS::kFailure An object error has occurred
double uEnd ( MStatus ReturnStatus = NULL)

Returns the end value of the u parameterization for the animation.

Parameters
[out]ReturnStatusStatus Code
Returns
The end value
Status Codes:
  • MS::kSuccess Member was successful
  • MS::kFailure An object error has occurred
MStatus setUTimeStart ( MTime start)

Sets the starting time of the animation for the u parameter.

Parameters
[in]startthe new start time
Returns
Status code
Status Codes:
  • MS::kSuccess Member was successful
  • MS::kFailure An object error has occurred
MStatus setUTimeEnd ( MTime end)

Sets the end time of the animation for the u parameter.

Parameters
[in]endthe new end time
Returns
Status code
Status Codes:
  • MS::kSuccess Member was successful
  • MS::kFailure An object error has occurred
MTime uTimeStart ( MStatus ReturnStatus = NULL)

Returns the start time of the animation for the u parameter.

Parameters
[out]ReturnStatusStatus Code
Returns
The starting time
Status Codes:
  • MS::kSuccess Member was successful
  • MS::kFailure An object error has occurred
MTime uTimeEnd ( MStatus ReturnStatus = NULL)

Returns the end time of the animation for the u parameter.

Parameters
[out]ReturnStatusStatus Code
Returns
The end time
Status Codes:
  • MS::kSuccess Member was successful
  • MS::kFailure An object error has occurred
unsigned int numPositionMarkers ( MStatus ReturnStatus = NULL)

Returns the number of position markers on this motion path.

Parameters
[out]ReturnStatusStatus Code
Returns
The number of markers
Status Codes:
  • MS::kSuccess Member was successful
  • MS::kFailure An object error has occurred
MObject getPositionMarker ( unsigned int  markerNum,
MStatus ReturnStatus = NULL 
)

Gets the position marker where markerNum is the order in which the marker was created.

Parameters
[in]markerNumThe number of the marker
[out]ReturnStatusStatus Code
Returns
The position marker
Status Codes:
  • MS::kSuccess Member was successful
  • MS::kFailure An object error has occurred
unsigned int numOrientationMarkers ( MStatus ReturnStatus = NULL)

Returns the number of orientation markers on this motion path.

Parameters
[out]ReturnStatusStatus Code
Returns
The number of markers
Status Codes:
  • MS::kSuccess Member was successful
  • MS::kFailure An object error has occurred
MObject getOrientationMarker ( unsigned int  markerNum,
MStatus ReturnStatus = NULL 
)

Gets the orientation marker where markerNum is the order in which the marker was created.

Parameters
[in]markerNumThe number of the marker
[out]ReturnStatusStatus Code
Returns
The orientation marker
Status Codes:
  • MS::kSuccess Member was successful
  • MS::kFailure An object error has occurred

The documentation for this class was generated from the following files: