pymel.core.nodetypes.MotionPath

class MotionPath(*args, **kwargs)

Axis = Enum( EnumValue('Axis', 0, 'xaxis'), EnumValue('Axis', 1, 'yaxis'), EnumValue('Axis', 2, 'zaxis'))

addAnimatedObject(objectToAnimate, modifier=None)

Add an object to be animated along this motion path.

Parameters :

objectToAnimate : PyNode

A DAG path to the animated object

modifier : MDGModifier

The object that will hold the undo information

Derived from api method maya.OpenMayaAnim.MFnMotionPath.addAnimatedObject

Undo is not currently supported for this method

getAnimatedObjects()

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

Return type:PyNode list

Derived from api method maya.OpenMayaAnim.MFnMotionPath.getAnimatedObjects

getBank()

Determines whether bank has been enabled for this motion path.

Return type:bool

Derived from api method maya.OpenMayaAnim.MFnMotionPath.bank

getBankScale()

Return the bank scale for this motion path.

Return type:float

Derived from api method maya.OpenMayaAnim.MFnMotionPath.bankScale

getBankThreshold()

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.

Return type:float

Derived from api method maya.OpenMayaAnim.MFnMotionPath.bankThreshold

getFollow()

Determines whether follow is set for this motion path node.

Return type:bool

Derived from api method maya.OpenMayaAnim.MFnMotionPath.follow

getFollowAxis()

Return the follow axis for this motion path.

Return type:MotionPath.Axis

Derived from api method maya.OpenMayaAnim.MFnMotionPath.followAxis

getInverseNormal()

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.

Return type:bool

Derived from api method maya.OpenMayaAnim.MFnMotionPath.inverseNormal

getOrientationMarker(markerNum)

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

Parameters :

markerNum : int

The number of the marker

Return type:

PyNode

Derived from api method maya.OpenMayaAnim.MFnMotionPath.getOrientationMarker

getPathObject()

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.

Return type:PyNode

Derived from api method maya.OpenMayaAnim.MFnMotionPath.pathObject

getPositionMarker(markerNum)

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

Parameters :

markerNum : int

The number of the marker

Return type:

PyNode

Derived from api method maya.OpenMayaAnim.MFnMotionPath.getPositionMarker

getUEnd()

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

Return type:float

Derived from api method maya.OpenMayaAnim.MFnMotionPath.uEnd

getUStart()

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

Return type:float

Derived from api method maya.OpenMayaAnim.MFnMotionPath.uStart

getUTimeEnd()

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

Return type:Time

Derived from api method maya.OpenMayaAnim.MFnMotionPath.uTimeEnd

getUTimeStart()

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

Return type:Time

Derived from api method maya.OpenMayaAnim.MFnMotionPath.uTimeStart

getUpAxis()

Return the up-axis for this motion path.

Return type:MotionPath.Axis

Derived from api method maya.OpenMayaAnim.MFnMotionPath.upAxis

getUseNormal()

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

Return type:bool

Derived from api method maya.OpenMayaAnim.MFnMotionPath.useNormal

numOrientationMarkers()

Returns the number of orientation markers on this motion path.

Return type:int

Derived from api method maya.OpenMayaAnim.MFnMotionPath.numOrientationMarkers

numPositionMarkers()

Returns the number of position markers on this motion path.

Return type:int

Derived from api method maya.OpenMayaAnim.MFnMotionPath.numPositionMarkers

setBank(bank)

Parameters:

[in] bank Specifies whether bank is turned on

Returns: Status Code Status Codes: MS::kSuccess Member was successful MS::kFailure An object error has occurred

Parameters :

bank : bool

Specifies whether bank is turned on

Derived from api method maya.OpenMayaAnim.MFnMotionPath.setBank

setBankScale(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.

Parameters :

bankScale : float

The new bank scale value

Derived from api method maya.OpenMayaAnim.MFnMotionPath.setBankScale

setBankThreshold(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 :

bankThreshold : float

The new bank threshold value

Derived from api method maya.OpenMayaAnim.MFnMotionPath.setBankThreshold

setFollow(on, modifier=None)

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 :

on : bool

Specifies whether follow is activated for this motion path

modifier : MDGModifier

The object that will hold the undo information

Derived from api method maya.OpenMayaAnim.MFnMotionPath.setFollow

setFollowAxis(axis)

Sets the axis of the animated object that will follow the motion path. Possible alignment parameters are kXaxis , kYaxiz , or kZaxis .

Parameters :

axis : MotionPath.Axis

Object axis to align with motion path tangent

values: ‘xaxis’, ‘yaxis’, ‘zaxis’

Derived from api method maya.OpenMayaAnim.MFnMotionPath.setFollowAxis

setInverseNormal(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 :

invert : bool

Specifies if inverse normal is used

Derived from api method maya.OpenMayaAnim.MFnMotionPath.setInverseNormal

setPathObject(pathObject, modifier=None)

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 :

pathObject : PyNode

The curve (or surface) that will be the motion path

modifier : MDGModifier

The object that will hold the undo information

Derived from api method maya.OpenMayaAnim.MFnMotionPath.setPathObject

setUEnd(end)

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

Parameters :

end : float

the new end value

Derived from api method maya.OpenMayaAnim.MFnMotionPath.setUEnd

setUStart(start)

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

Parameters :

start : float

the new start value

Derived from api method maya.OpenMayaAnim.MFnMotionPath.setUStart

setUTimeEnd(end)

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

Parameters :

end : Time

the new end time

Derived from api method maya.OpenMayaAnim.MFnMotionPath.setUTimeEnd

setUTimeStart(start)

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

Parameters :

start : Time

the new start time

Derived from api method maya.OpenMayaAnim.MFnMotionPath.setUTimeStart

setUpAxis(axis)

Set the up-axis for this motion path.

Parameters :

axis : MotionPath.Axis

Axis to be set

values: ‘xaxis’, ‘yaxis’, ‘zaxis’

Derived from api method maya.OpenMayaAnim.MFnMotionPath.setUpAxis

setUseNormal(use)

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

Parameters :

use : bool

Specifies if normal is used

Derived from api method maya.OpenMayaAnim.MFnMotionPath.setUseNormal