Python API 2.0 Reference: OpenMayaAnim.MAnimControl Class Reference

OpenMayaAnim.MAnimControl Class Reference
+ Inheritance diagram for OpenMayaAnim.MAnimControl:

Static Public Member Functions

animationEndTime ()
 
animationStartTime ()
 
autoKeyMode ()
 
currentTime ()
 
globalInTangentType ()
 
globalOutTangentType ()
 
isPlaying ()
 
isScrubbing ()
 
maxTime ()
 
minTime ()
 
playBackward ()
 
playForward ()
 
playbackBy ()
 
playbackMode ()
 
playbackSpeed ()
 
setAnimationEndTime ()
 
setAnimationStartEndTime ()
 
setAnimationStartTime ()
 
setAutoKeyMode ()
 
setCurrentTime ()
 
setGlobalInTangentType ()
 
setGlobalOutTangentType ()
 
setMaxTime ()
 
setMinMaxTime ()
 
setMinTime ()
 
setPlaybackBy ()
 
setPlaybackMode ()
 
setPlaybackSpeed ()
 
setViewMode ()
 
setWeightedTangents ()
 
stop ()
 
viewMode ()
 
weightedTangents ()
 
animationEndTime ()
 
animationStartTime ()
 
autoKeyMode ()
 
currentTime ()
 
globalInTangentType ()
 
globalOutTangentType ()
 
isPlaying ()
 
isScrubbing ()
 
maxTime ()
 
minTime ()
 
playBackward ()
 
playForward ()
 
playbackBy ()
 
playbackMode ()
 
playbackSpeed ()
 
setAnimationEndTime ()
 
setAnimationStartEndTime ()
 
setAnimationStartTime ()
 
setAutoKeyMode ()
 
setCurrentTime ()
 
setGlobalInTangentType ()
 
setGlobalOutTangentType ()
 
setMaxTime ()
 
setMinMaxTime ()
 
setMinTime ()
 
setPlaybackBy ()
 
setPlaybackMode ()
 
setPlaybackSpeed ()
 
setViewMode ()
 
setWeightedTangents ()
 
stop ()
 
viewMode ()
 
weightedTangents ()
 

Static Public Attributes

int kPlaybackLoop = 1
 
int kPlaybackOnce = 0
 
int kPlaybackOscillate = 2
 
int kPlaybackViewActive = 1
 
int kPlaybackViewAll = 0
 

Detailed Description

Control over animation playback and values

Member Function Documentation

OpenMayaAnim.MAnimControl.animationEndTime ( )
static
animationEndTime() -> MTime

Return an MTime specifying the last frame of the animation, as specified by the Maya user in the Range Slider UI.
OpenMayaAnim.MAnimControl.animationEndTime ( )
static
animationEndTime() -> MTime

Return an MTime specifying the last frame of the animation, as specified by the Maya user in the Range Slider UI.
OpenMayaAnim.MAnimControl.animationStartTime ( )
static
animationStartTime() -> MTime

Return an MTime specifying the first frame of the animation, as specified by the Maya user in the Range Slider UI.
OpenMayaAnim.MAnimControl.animationStartTime ( )
static
animationStartTime() -> MTime

Return an MTime specifying the first frame of the animation, as specified by the Maya user in the Range Slider UI.
OpenMayaAnim.MAnimControl.autoKeyMode ( )
static
autoKeyMode() -> bool

Return the autoKeyMode.
OpenMayaAnim.MAnimControl.autoKeyMode ( )
static
autoKeyMode() -> bool

Return the autoKeyMode.
OpenMayaAnim.MAnimControl.currentTime ( )
static
currentTime() -> MTime

Return an MTime instance containing the current animation frame.
OpenMayaAnim.MAnimControl.currentTime ( )
static
currentTime() -> MTime

Return an MTime instance containing the current animation frame.
OpenMayaAnim.MAnimControl.globalInTangentType ( )
static
globalInTangentType() -> int

Return the current global in tangent type.
OpenMayaAnim.MAnimControl.globalInTangentType ( )
static
globalInTangentType() -> int

Return the current global in tangent type.
OpenMayaAnim.MAnimControl.globalOutTangentType ( )
static
globalOutTangentType() -> int

Return the current global out tangent type.
OpenMayaAnim.MAnimControl.globalOutTangentType ( )
static
globalOutTangentType() -> int

Return the current global out tangent type.
OpenMayaAnim.MAnimControl.isPlaying ( )
static
isPlaying() -> bool

Return a value indicating whether Maya is currently playing the animation
OpenMayaAnim.MAnimControl.isPlaying ( )
static
isPlaying() -> bool

Return a value indicating whether Maya is currently playing the animation
OpenMayaAnim.MAnimControl.isScrubbing ( )
static
isScrubbing() -> bool

Return a value indicating whether interactive scrubbing is occuring while Maya is not currently playing an animation.
OpenMayaAnim.MAnimControl.isScrubbing ( )
static
isScrubbing() -> bool

Return a value indicating whether interactive scrubbing is occuring while Maya is not currently playing an animation.
OpenMayaAnim.MAnimControl.maxTime ( )
static
maxTime() -> MTime

Return an MTime specifying the last frame of the current playback time range.
OpenMayaAnim.MAnimControl.maxTime ( )
static
maxTime() -> MTime

Return an MTime specifying the last frame of the current playback time range.
OpenMayaAnim.MAnimControl.minTime ( )
static
minTime() -> MTime

Return an MTime specifying the first frame of the current playback time range.
OpenMayaAnim.MAnimControl.minTime ( )
static
minTime() -> MTime

Return an MTime specifying the first frame of the current playback time range.
OpenMayaAnim.MAnimControl.playbackBy ( )
static
playbackBy() -> float

Return a float specifying the increment between times viewed during the playing of the animation.
OpenMayaAnim.MAnimControl.playbackBy ( )
static
playbackBy() -> float

Return a float specifying the increment between times viewed during the playing of the animation.
OpenMayaAnim.MAnimControl.playbackMode ( )
static
playbackMode() -> int

Return the playback mode currently in effect:
  MAnimControl.kPlaybackOnce         Play once then stop.
  MAnimControl.kPlaybackLoop         Play continuously.
  MAnimControl.kPlaybackOscillate    Play forwards, then backwards continuously.
OpenMayaAnim.MAnimControl.playbackMode ( )
static
playbackMode() -> int

Return the playback mode currently in effect:
  MAnimControl.kPlaybackOnce         Play once then stop.
  MAnimControl.kPlaybackLoop         Play continuously.
  MAnimControl.kPlaybackOscillate    Play forwards, then backwards continuously.
OpenMayaAnim.MAnimControl.playbackSpeed ( )
static
playbackSpeed() -> float

Return the speed with with to play the animation.
OpenMayaAnim.MAnimControl.playbackSpeed ( )
static
playbackSpeed() -> float

Return the speed with with to play the animation.
OpenMayaAnim.MAnimControl.playBackward ( )
static
playBackward() -> None

Start playing the current animation backwards.
OpenMayaAnim.MAnimControl.playBackward ( )
static
playBackward() -> None

Start playing the current animation backwards.
OpenMayaAnim.MAnimControl.playForward ( )
static
playForward() -> None

Start playing the current animation forwards.
OpenMayaAnim.MAnimControl.playForward ( )
static
playForward() -> None

Start playing the current animation forwards.
OpenMayaAnim.MAnimControl.setAnimationEndTime ( )
static
setAnimationEndTime(MTime) -> None

Set the value of the last frame in the animation.
OpenMayaAnim.MAnimControl.setAnimationEndTime ( )
static
setAnimationEndTime(MTime) -> None

Set the value of the last frame in the animation.
OpenMayaAnim.MAnimControl.setAnimationStartEndTime ( )
static
setAnimationStartEndTime(MTime, MTime) -> None

Set the values of the first and last frames in the animation.
OpenMayaAnim.MAnimControl.setAnimationStartEndTime ( )
static
setAnimationStartEndTime(MTime, MTime) -> None

Set the values of the first and last frames in the animation.
OpenMayaAnim.MAnimControl.setAnimationStartTime ( )
static
setAnimationStartTime(MTime) -> None

Set the value of the first frame in the animation.
OpenMayaAnim.MAnimControl.setAnimationStartTime ( )
static
setAnimationStartTime(MTime) -> None

Set the value of the first frame in the animation.
OpenMayaAnim.MAnimControl.setAutoKeyMode ( )
static
setAutoKeyMode(bool) -> None

Set the autoKeyMode.
OpenMayaAnim.MAnimControl.setAutoKeyMode ( )
static
setAutoKeyMode(bool) -> None

Set the autoKeyMode.
OpenMayaAnim.MAnimControl.setCurrentTime ( )
static
setMinTime(MTime) -> None

Set the current animation frame.
OpenMayaAnim.MAnimControl.setCurrentTime ( )
static
setMinTime(MTime) -> None

Set the current animation frame.
OpenMayaAnim.MAnimControl.setGlobalInTangentType ( )
static
setGlobalInTangentType(int) -> None

Set the current global in tangent type
OpenMayaAnim.MAnimControl.setGlobalInTangentType ( )
static
setGlobalInTangentType(int) -> None

Set the current global in tangent type
OpenMayaAnim.MAnimControl.setGlobalOutTangentType ( )
static
setGlobalOutTangentType(int) -> None

Set the current global out tangent type.
OpenMayaAnim.MAnimControl.setGlobalOutTangentType ( )
static
setGlobalOutTangentType(int) -> None

Set the current global out tangent type.
OpenMayaAnim.MAnimControl.setMaxTime ( )
static
setMaxTime(MTime) -> None

Set the value of the last frame of the current playback time range.
OpenMayaAnim.MAnimControl.setMaxTime ( )
static
setMaxTime(MTime) -> None

Set the value of the last frame of the current playback time range.
OpenMayaAnim.MAnimControl.setMinMaxTime ( )
static
setMinMaxTime(MTime, MTime) -> None

Set the values of the first and last frames of the playback time range.
OpenMayaAnim.MAnimControl.setMinMaxTime ( )
static
setMinMaxTime(MTime, MTime) -> None

Set the values of the first and last frames of the playback time range.
OpenMayaAnim.MAnimControl.setMinTime ( )
static
setMinTime(MTime) -> None

Set the value of the first frame of the current playback time range.
OpenMayaAnim.MAnimControl.setMinTime ( )
static
setMinTime(MTime) -> None

Set the value of the first frame of the current playback time range.
OpenMayaAnim.MAnimControl.setPlaybackBy ( )
static
setPlaybackBy(float) -> None

Specify the increment between times viewed during the playing of the animation.
OpenMayaAnim.MAnimControl.setPlaybackBy ( )
static
setPlaybackBy(float) -> None

Specify the increment between times viewed during the playing of the animation.
OpenMayaAnim.MAnimControl.setPlaybackMode ( )
static
setPlaybackMode(int) -> None

Set the current playback mode.
OpenMayaAnim.MAnimControl.setPlaybackMode ( )
static
setPlaybackMode(int) -> None

Set the current playback mode.
OpenMayaAnim.MAnimControl.setPlaybackSpeed ( )
static
setPlaybackSpeed(float) -> None

Set the desired speed factor at which the animation will play back.
OpenMayaAnim.MAnimControl.setPlaybackSpeed ( )
static
setPlaybackSpeed(float) -> None

Set the desired speed factor at which the animation will play back.
OpenMayaAnim.MAnimControl.setViewMode ( )
static
setViewMode(int) -> None

Set the current viewing mode.
Controls whether the animation is run in only the active view, or simultaneously in all views.
OpenMayaAnim.MAnimControl.setViewMode ( )
static
setViewMode(int) -> None

Set the current viewing mode.
Controls whether the animation is run in only the active view, or simultaneously in all views.
OpenMayaAnim.MAnimControl.setWeightedTangents ( )
static
setWeightedTangents(bool) -> None

Sets whether or not the tangents on the Anim Curve are weighted.
OpenMayaAnim.MAnimControl.setWeightedTangents ( )
static
setWeightedTangents(bool) -> None

Sets whether or not the tangents on the Anim Curve are weighted.
OpenMayaAnim.MAnimControl.stop ( )
static
stop() -> None

Stop playing the current animation.
OpenMayaAnim.MAnimControl.stop ( )
static
stop() -> None

Stop playing the current animation.
OpenMayaAnim.MAnimControl.viewMode ( )
static
viewMode() -> int

Return the viewing mode currently in effect:
  MAnimControl.kPlaybackViewAll      Playback in all views.
  MAnimControl.kPlaybackViewActive   Playback in only the active view.
OpenMayaAnim.MAnimControl.viewMode ( )
static
viewMode() -> int

Return the viewing mode currently in effect:
  MAnimControl.kPlaybackViewAll      Playback in all views.
  MAnimControl.kPlaybackViewActive   Playback in only the active view.
OpenMayaAnim.MAnimControl.weightedTangents ( )
static
weightedTangents() -> bool

Determine whether or not the tangents on the Anim Curve are weighted.
OpenMayaAnim.MAnimControl.weightedTangents ( )
static
weightedTangents() -> bool

Determine whether or not the tangents on the Anim Curve are weighted.