pymel.core.animation.pathAnimation

pathAnimation(*args, **kwargs)

The pathAnimation command constructs the necessary graph nodes and their interconnections for a motion path animation. Motion path animation requires a curve and one or more other objects. During the animation, the objects will be moved along the 3D curve or the curveOnSurface.There are two ways to specify the moving objects: by explicitly specifying their names in the command line, orby making the objects selected (interactively, or through a MEL command).Likewise, there are two ways to specify a motion curve: by explicitly specifying the name of the motion curve in the command line (i.e. using the -c curve_name option), orby selecting the moving objects first before selecting the motion curve. I.e. if the name of the motion curve is not provided in the command line, the curve will be taken to be the last selected object in the selection list.When the end time is not specified: only one keyframe will be created either at the current time, or at the specified start time.

Flags:

• bank : b (bool) [query]

  If on, enable alignment of the up axis of the moving object(s) to the curvature of the path geometry.Default is false.When queried, this flag returns a boolean.

• bankScale : bs (float) [query]

  This flag specifies a factor to scale the amount of bank angle.Default is 1.0When queried, this flag returns a float.

• bankThreshold : bt (float) [query]

  This flag specifies the limit of the bank angle.Default is 90 degreesWhen queried, this flag returns an angle.

• curve : c (unicode) [query]

  This flag specifies the name of the curve for the path.Default is NONEWhen queried, this flag returns a string.

• endTimeU : etu (time) [query]

  This flag specifies the ending time of the animation for the u parameter.Default is NONE.When queried, this flag returns a time. Flag can have multiple arguments, passed either as a tuple or a list.

• endU : eu (float) [query]

  This flag specifies the ending value of the u parameterization for the animation.Default is the end parameterization value of the curve.When queried, this flag returns a linear.

• follow : f (bool) [query]

  If on, enable alignment of the front axis of the moving object(s).Default is false.When queried, this flag returns a boolean.

• followAxis : fa (unicode) [query]

  This flag specifies which object local axis to be aligned to the tangent of the path curve.Default is yWhen queried, this flag returns a string.

• fractionMode : fm (bool) [query]

  If on, evaluation on the path is based on the fraction of length of the path curve.Default is false.When queried, this flag returns a boolean.

• inverseFront : inverseFront (bool) [query]

  This flag specifies whether or not to align the front axis of the moving object(s) to the opposite direction of the tangent vector of the path geometry.Default is false.When queried, this flag returns a boolean.

• inverseUp : iu (bool) [query]

  This flag specifies whether or not to align the up axis of the moving object(s) to the opposite direction of the normal vector of the path geometry.Default is false.When queried, this flag returns a boolean.

• name : n (unicode) [query]

  This flag specifies the name for the new motion path node. (instead of the default name)When queried, this flag returns a string.

• startTimeU : stu (time) [query]

  This flag specifies the starting time of the animation for the u parameter.Default is the the current time.When queried, this flag returns a time.

• startU : su (float) [query]

  This flag specifies the starting value of the u parameterization for the animation.Default is the start parameterization value of the curve.When queried, this flag returns a linear.

• upAxis : ua (unicode) [query]

  This flag specifies which object local axis to be aligned a computed up direction.Default is zWhen queried, this flag returns a string.

• useNormal : un (bool) [create,query,edit]

  This flag is now obsolete. Use -wut/worldUpType instead.

• worldUpObject : wuo (PyNode) [create,query,edit]

  Set the DAG object to use for worldUpType objectand objectrotation. See -wut/worldUpType for greater detail. The default value is no up object, which is interpreted as world space.

• worldUpType : wut (unicode) [create,query,edit]

  Set the type of the world up vector computation. The worldUpType can have one of 5 values: scene, object, objectrotation, vector, or normal. If the value is scene, the upVector is aligned with the up axis of the scene and worldUpVector and worldUpObject are ignored. If the value is object, the upVector is aimed as closely as possible to the origin of the space of the worldUpObject and the worldUpVector is ignored. If the value is objectrotationthen the worldUpVector is interpreted as being in the coordinate space of the worldUpObject, transformed into world space and the upVector is aligned as closely as possible to the result. If the value is vector, the upVector is aligned with worldUpVector as closely as possible and worldUpObject is ignored. Finally, if the value is normalthe upVector is aligned to the path geometry. The default worldUpType is vector.

• worldUpVector : wu (float, float, float) [create,query,edit]

  Set world up vector. This is the vector in world coordinates that up vector should align with. See -wut/worldUpType for greater detail. If not given at creation time, the default value of (0.0, 1.0, 0.0) is used.

Derived from mel command maya.cmds.pathAnimation