pymel.core.windows.timeControl

timeControl(*args, **kwargs)

This command creates a control that can be used for changing current time, displaying/editing keys, and displaying/scrubbing sound.Note: only one timeControl may be created. The one Maya creates on startup can be accessed from the global string variable $gPlayBackSlider. Also, it is not a good idea to delete it.

Flags:

Long Name / Short Name Argument Types Properties
animCurveNames / acn bool ../../../_images/create.gif ../../../_images/query.gif
  When showKeysis not none, querying this flag will return the names of all the animCurves for which keyframe ticks are being displayed. Query returns string[].
animLayerFilterOptions / alf unicode ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  Specifies whether a filter is to be applied when displaying animation layers. If so, the options can be allAffecting(no filter), active(only the active layers on the object will be displayed) and animLayerEditor(the settings will be taken from the animation layer editor).
animLayerShowWeight / asw bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  Specifies or queries whether weights are to be shown when displaying animation layers.
annotation / ann unicode ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  Annotate the control with an extra string value.
backgroundColor / bgc float, float, float ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  The background color of the control. The arguments correspond to the red, green, and blue color components. Each component ranges in value from 0.0 to 1.0. When setting backgroundColor, the background is automatically enabled, unless enableBackground is also specified with a false value.
beginScrub / bs bool ../../../_images/edit.gif
  Set this widget up for sound scrubbing. Subsequent changes to current time will result in sound scrubbingbehavior, until the -endScrubcommand is issued for this widget.
currentFrameColor / cfc float, float, float, float ../../../_images/edit.gif
  This flag is used to specify the rgba color of the current frame overlay rectangle in the timeControl.
defineTemplate / dt unicode ../../../_images/create.gif
  Puts the command in a mode where any other flags and args are parsed and added to the command template specified in the argument. They will be used as default arguments in any subsequent invocations of the command when templateName is set as the current template.
displaySound / ds bool ../../../_images/query.gif ../../../_images/edit.gif
  Turn sound display off. Query returns int.
docTag / dtg unicode ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  Add a documentation flag to the control. The documentation flag has a directory structure like hierarchy. Eg. -dt render/multiLister/createNode/material
dragCallback / dgc script ../../../_images/create.gif ../../../_images/edit.gif
  Adds a callback that is called when the middle mouse button is pressed. The MEL version of the callback is of the form: global proc string[] callbackName(string $dragControl, int $x, int $y, int $mods) The proc returns a string array that is transferred to the drop site. By convention the first string in the array describes the user settable message type. Controls that are application defined drag sources may ignore the callback. $mods allows testing for the key modifiers CTL and SHIFT. Possible values are 0 == No modifiers, 1 == SHIFT, 2 == CTL, 3 == CTL + SHIFT. In Python, it is similar, but there are two ways to specify the callback. The recommended way is to pass a Python function object as the argument. In that case, the Python callback should have the form: def callbackName( dragControl, x, y, modifiers ): The values of these arguments are the same as those for the MEL version above. The other way to specify the callback in Python is to specify a string to be executed. In that case, the string will have the values substituted into it via the standard Python format operator. The format values are passed in a dictionary with the keys dragControl, x, y, modifiers. The dragControlvalue is a string and the other values are integers (eg the callback string could be print ‘%(dragControl)s %(x)d %(y)d %(modifiers)d’
dropCallback / dpc script ../../../_images/create.gif ../../../_images/edit.gif
  Adds a callback that is called when a drag and drop operation is released above the drop site. The MEL version of the callback is of the form: global proc callbackName(string $dragControl, string $dropControl, string $msgs[], int $x, int $y, int $type) The proc receives a string array that is transferred from the drag source. The first string in the msgs array describes the user defined message type. Controls that are application defined drop sites may ignore the callback. $type can have values of 1 == Move, 2 == Copy, 3 == Link. In Python, it is similar, but there are two ways to specify the callback. The recommended way is to pass a Python function object as the argument. In that case, the Python callback should have the form: def pythonDropTest( dragControl, dropControl, messages, x, y, dragType ): The values of these arguments are the same as those for the MEL version above. The other way to specify the callback in Python is to specify a string to be executed. In that case, the string will have the values substituted into it via the standard Python format operator. The format values are passed in a dictionary with the keys dragControl, dropControl, messages, x, y, type. The dragControlvalue is a string and the other values are integers (eg the callback string could be print ‘%(dragControl)s %(dropControl)s %(messages)r %(x)d %(y)d %(type)d’
enable / en bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  The enable state of the control. By default, this flag is set to true and the control is enabled. Specify false and the control will appear dimmed or greyed-out indicating it is disabled.
enableBackground / ebg bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  Enables the background color of the control.
endScrub / es bool ../../../_images/edit.gif
  End sound scubbing for this widget. This stops sound scrubbing behavior and should be issued before any subsequent -beginScrubflags
exists / ex bool ../../../_images/create.gif
  Returns whether the specified object exists or not. Other flags are ignored.
forceRedraw / fd bool ../../../_images/create.gif ../../../_images/edit.gif
  Force a redraw of the time control UI. Similiar to forceRefresh but does not rebuild key information.
forceRefresh / fr bool ../../../_images/create.gif ../../../_images/edit.gif
  Force a refresh of the time control UI.
foregroundColor / fgc float, float, float ../../../_images/edit.gif
  This flag is used to specify the rgb color of the vertical lines and numeric text in the timeControl.
fullPathName / fpn bool ../../../_images/query.gif
  Return the full path name of the widget, which includes all the parents
globalTime / gt bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  truemeans this widget controls and displays the global, dependency graph time. falsemeans time changes here do NOT affect the dependency graph. Query returns int.
greasePencilSequenceNames / gn bool ../../../_images/query.gif
  Returns the names of all grease pencil sequences that have frames being displayed in the time line. Query returns string[].
height / h int ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  The height of the control. The control will attempt to be this size if it is not overruled by parent layout conditions.
highlightColor / hlc float, float, float ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  The highlight color of the control. The arguments correspond to the red, green, and blue color components. Each component ranges in value from 0.0 to 1.0.
isObscured / io bool ../../../_images/query.gif
  Return whether the control can actually be seen by the user. The control will be obscured if its state is invisible, if it is blocked (entirely or partially) by some other control, if it or a parent layout is unmanaged, or if the control’s window is invisible or iconified.
mainListConnection / mlc unicode ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  Specifies the name of a selectionConnection object that the time slider will use as its source of content. The time slider will only display keys for items contained in the selectionConnection object.
manage / m bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  Manage state of the control. An unmanaged control is not visible, nor does it take up any screen real estate. All controls are created managed by default.
noBackground / nbg bool ../../../_images/create.gif ../../../_images/edit.gif
  Clear/reset the control’s background. Passing true means the background should not be drawn at all, false means the background should be drawn. The state of this flag is inherited by children of this control.
numberOfPopupMenus / npm bool ../../../_images/query.gif
  Return the number of popup menus attached to this control.
parent / p unicode ../../../_images/create.gif ../../../_images/query.gif
  The parent layout for this control.
popupMenuArray / pma bool ../../../_images/query.gif
  Return the names of all the popup menus attached to this control.
pressCommand / pc script ../../../_images/create.gif ../../../_images/edit.gif
  script to run on mouse-down in this control.
preventOverride / po bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  If true, this flag disallows overriding the control’s attribute via the control’s right mouse button menu.
range / rng bool ../../../_images/create.gif ../../../_images/query.gif
  Returns string representing the currently highlighted range visible on the time slider. A range from 10 to 20 would be returned as 10:20. When there’s no range visible on the time slider, the query returns a range spanning the current time: for example, 10:11. These values are in the current time unit.
rangeArray / ra bool ../../../_images/create.gif ../../../_images/query.gif
  Returns a float array representing the currently highlighted range visible on the time slider. A range from 10 to 20 would be returned as { 10.0, 20.0 }. When there’s no range visible on the time slider, the query returns values spanning the current time: { 10.0, 11.0 }. These values are in the current time unit.
rangeVisible / rv bool ../../../_images/create.gif ../../../_images/query.gif
  Returns true if a currently highlighted range is visible on the time slider, false if no.
releaseCommand / rc script ../../../_images/create.gif ../../../_images/edit.gif
  script to run on mouse-up in this control.
repeatChunkSize / rcs float ../../../_images/query.gif ../../../_images/edit.gif
  How much sound (in the current time unit) is repeated when -repeatOnHold is true. Default is 1.0.
repeatOnHold / roh bool ../../../_images/query.gif ../../../_images/edit.gif
  Repeat sound during mouse-down events
resample / r bool ../../../_images/edit.gif
  Resample the sound display to fit the widget
showGreaseFrames / sg unicode ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  activewill show grease frames for the active camera. noneshows no grease frames. allwill show all grease frames. Default active. Query returns string.
showKeys / sk unicode ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  activewill show tick marks for keyframes on all active objects. noneshows no tick marks. Any other name is taken as the name of a channel box whose selected attributes will display tick marks. Default active. Query returns string.
showKeysCombined / skc bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  This flag can be used in conjunction with the showKeys flag to enable a combination of active+ channel boxbehavior. Specifically, if channel box attributes are selected, tick marks will be shown for those attributes. If no channel box attributes are selected, tick marks will be shown for keyframes on all active objects.
snap / sn bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  truemeans this widget is constrained to having values that are integers representing the current time unit.. falsemeans the current time indicator is free floatingand not constrained.
sound / s unicode ../../../_images/query.gif ../../../_images/edit.gif
  Name of audio depend node whose data should display in the sound-display widget. Query returns string.
tickSize / ts int ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  Specifies the width of keyframe ticks drawn in the time slider. The value will be clamped to the range [1, 63].
tickSpan / tsp int ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  Specifies the interval between keyframe ticks in the timeControl. For example, a value of 10, will place ticks at 0, 10, 20, etc.
useTemplate / ut unicode ../../../_images/create.gif
  Force the command to use a command template other than the current one.
visible / vis bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  The visible state of the control. A control is created visible by default. Note that a control’s actual appearance is also dependent on the visible state of its parent layout(s).
visibleChangeCommand / vcc script ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  Command that gets executed when visible state of the control changes.
waveform / wf unicode ../../../_images/query.gif ../../../_images/edit.gif
  Determines what part of the sound waveform to display, when -displaySound is true. Valid values are top, bottom, and both. Default is top. Query returns string.
width / w int ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  The width of the control. The control will attempt to be this size if it is not overruled by parent layout conditions. Flag can have multiple arguments, passed either as a tuple or a list.

Derived from mel command maya.cmds.timeControl

Example:

import pymel.core as pm

# To display sound in the time slider, there must first be a sound
# node in the scene. We'll create one and give it the name "ohNo".
# Note that the argument to the -file flag must be a path to a valid
# soundfile.
#
pm.sound( file='C:/My Documents/maya/projects/default/sound/ohNo.aiff', name='ohNo' )


# To display sound in the time slider, you must specify
# the sound node to display and turn display of sound "on."
# First we need to get the name of the playback slider from
# the global mel variable called gPlayBackSlider
#
import maya.mel
aPlayBackSliderPython = maya.mel.eval('$tmpVar=$gPlayBackSlider')
pm.timeControl( aPlayBackSliderPython, e=True, sound='ohNo', displaySound=True )

# To hear sound while scrubbing in the time slider, set the press and
# release commands to begin and end sound scrubbing.
#
pm.timeControl( aPlayBackSliderPython,edit=True,pressCommand='pm.timeControl(aPlayBackSliderPython,edit=True,beginScrub=True)')
pm.timeControl( aPlayBackSliderPython,edit=True,releaseCommand='pm.timeControl(aPlayBackSliderPython,edit=True,endScrub=True)')