OpenMayaAnim.MAnimControl Class Reference

Inheritance diagram for OpenMayaAnim.MAnimControl:

Static Public Member Functions
def	animationEndTime ()
def	animationStartTime ()
def	autoKeyMode ()
def	currentTime ()
def	globalInTangentType ()
def	globalOutTangentType ()
def	isPlaying ()
def	isScrubbing ()
def	maxTime ()
def	minTime ()
def	playBackward ()
def	playForward ()
def	playbackBy ()
def	playbackMode ()
def	playbackSpeed ()
def	setAnimationEndTime ()
def	setAnimationStartEndTime ()
def	setAnimationStartTime ()
def	setAutoKeyMode ()
def	setCurrentTime ()
def	setGlobalInTangentType ()
def	setGlobalOutTangentType ()
def	setMaxTime ()
def	setMinMaxTime ()
def	setMinTime ()
def	setPlaybackBy ()
def	setPlaybackMode ()
def	setPlaybackSpeed ()
def	setViewMode ()
def	setWeightedTangents ()
def	stop ()
def	viewMode ()
def	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

def 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.

def 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.

def OpenMayaAnim.MAnimControl.autoKeyMode ( )

static

autoKeyMode() -> bool

Return the autoKeyMode.

def OpenMayaAnim.MAnimControl.currentTime ( )

static

currentTime() -> MTime

Return an MTime instance containing the current animation frame.

def OpenMayaAnim.MAnimControl.globalInTangentType ( )

static

globalInTangentType() -> int

Return the current global in tangent type.

def OpenMayaAnim.MAnimControl.globalOutTangentType ( )

static

globalOutTangentType() -> int

Return the current global out tangent type.

def OpenMayaAnim.MAnimControl.isPlaying ( )

static

isPlaying() -> bool

Return a value indicating whether Maya is currently playing the animation

def OpenMayaAnim.MAnimControl.isScrubbing ( )

static

isScrubbing() -> bool

Return a value indicating whether interactive scrubbing is occuring while Maya is not currently playing an animation.

def OpenMayaAnim.MAnimControl.maxTime ( )

static

maxTime() -> MTime

Return an MTime specifying the last frame of the current playback time range.

def OpenMayaAnim.MAnimControl.minTime ( )

static

minTime() -> MTime

Return an MTime specifying the first frame of the current playback time range.

def OpenMayaAnim.MAnimControl.playbackBy ( )

static

playbackBy() -> float

Return a float specifying the increment between times viewed during the playing of the animation.

def 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.

def OpenMayaAnim.MAnimControl.playbackSpeed ( )

static

playbackSpeed() -> float

Return the speed with with to play the animation.

def OpenMayaAnim.MAnimControl.playBackward ( )

static

playBackward() -> None

Start playing the current animation backwards.

def OpenMayaAnim.MAnimControl.playForward ( )

static

playForward() -> None

Start playing the current animation forwards.

def OpenMayaAnim.MAnimControl.setAnimationEndTime ( )

static

setAnimationEndTime(MTime) -> None

Set the value of the last frame in the animation.

def OpenMayaAnim.MAnimControl.setAnimationStartEndTime ( )

static

setAnimationStartEndTime(MTime, MTime) -> None

Set the values of the first and last frames in the animation.

def OpenMayaAnim.MAnimControl.setAnimationStartTime ( )

static

setAnimationStartTime(MTime) -> None

Set the value of the first frame in the animation.

def OpenMayaAnim.MAnimControl.setAutoKeyMode ( )

static

setAutoKeyMode(bool) -> None

Set the autoKeyMode.

def OpenMayaAnim.MAnimControl.setCurrentTime ( )

static

setMinTime(MTime) -> None

Set the current animation frame.

def OpenMayaAnim.MAnimControl.setGlobalInTangentType ( )

static

setGlobalInTangentType(int) -> None

Set the current global in tangent type

def OpenMayaAnim.MAnimControl.setGlobalOutTangentType ( )

static

setGlobalOutTangentType(int) -> None

Set the current global out tangent type.

def OpenMayaAnim.MAnimControl.setMaxTime ( )

static

setMaxTime(MTime) -> None

Set the value of the last frame of the current playback time range.

def OpenMayaAnim.MAnimControl.setMinMaxTime ( )

static

setMinMaxTime(MTime, MTime) -> None

Set the values of the first and last frames of the playback time range.

def OpenMayaAnim.MAnimControl.setMinTime ( )

static

setMinTime(MTime) -> None

Set the value of the first frame of the current playback time range.

def OpenMayaAnim.MAnimControl.setPlaybackBy ( )

static

setPlaybackBy(float) -> None

Specify the increment between times viewed during the playing of the animation.

def OpenMayaAnim.MAnimControl.setPlaybackMode ( )

static

setPlaybackMode(int) -> None

Set the current playback mode.

def OpenMayaAnim.MAnimControl.setPlaybackSpeed ( )

static

setPlaybackSpeed(float) -> None

Set the desired speed factor at which the animation will play back.

def 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.

def OpenMayaAnim.MAnimControl.setWeightedTangents ( )

static

setWeightedTangents(bool) -> None

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

def OpenMayaAnim.MAnimControl.stop ( )

static

stop() -> None

Stop playing the current animation.

def 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.

def OpenMayaAnim.MAnimControl.weightedTangents ( )

static

weightedTangents() -> bool

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