themixer const StructDef

This struct contains a number of system global variables and methods to access the mixerManagerclass which affects all Character Studio Animation Mixers.

System Global Variables

The following properties are seen as icons in the mixer user interface

themixer.snapFrames SystemGlobal:snapFrames boolean default:true

themixer.snapToClips SystemGlobal:snapToClips boolean default:false

themixer.lockTransitions SystemGlobal:lockTransitionsboolean default:false

The following properties appear in the Preferences dialog in theMixer user interface

themixer.showBalanceCurves SystemGlobal:showBalanceCurvesboolean default:true

themixer.showClipBounds SystemGlobal:showClipBounds boolean default:true

themixer.showClipNames SystemGlobal:showClipNames boolean default:true

themixer.showClipScale SystemGlobal:showClipScaleboolean default:false

themixer.showGlobalFrames SystemGlobal:showGlobalFramesboolean default:true

themixer.showInpoints SystemGlobal:showInpointsboolean default:true

themixer.showOutpoints SystemGlobal:showOutpointsboolean default:false

themixer.showTgRangebars SystemGlobal:showTgRangebarsboolean default:true

themixer.showTimeWarps SystemGlobal:showTimeWarpsboolean default:true

themixer.showWgtCurves SystemGlobal:showWgtCurvesboolean default:true

Methods

<boolean>themixer.showMixer()

Show the Mixer. Returns true on success.

<boolean>themixer.hideMixer()

Hide the Mixer. Returns true on success.

<boolean>themixer.toggleMixer()

Toggles the display of the Motion Mixer. If it is hidden, this shows the Motion Mixer. If it is displayed, it hides the mixer. Returns true on success.

themixer.addMixerToDisplay <biped_controller>

Adds the Biped the supplied controller belongs to to the Mixer. Returns true on success.

themixer.removeMixerFromDisplay <biped_controller>

Removes the Biped the supplied controller belongs to from the Mixer. Returns true on success.

The following functions are available through icons in theMixer user interface:

themixer.setAnimationRange()

Sets the animation range. Returns true on success.

themixer.updateDisplay

Updates the Mixer's display. Returns true on success.

themixer.zoomExtents()

Zooms the Mixer's display to the extents of the animation. Returns true on success.

themixer.numMaxMixers()

Returns the number of max mixers in the Motion Mixer.

themixer.addMaxMixer <node_array> <track_name>

Adds a new max mixer to the Motion Mixer using the specified scene objects in the node_array, with the specified track_name. Note that if the track_name already exists, this method fails and returns false.

themixer.removeMaxMixer <int_index> <bool_collapse> <bool_keyperframe>

Removes the max mixer at index int_index from the Mixer. If bool_collapse is true, the mixer collapses and replaces the mixer-driven controllers with the values set in the mixer. If false, it replaces the driven with the original controllers and their values when the nodes were added to the mixer. If bool_keyperframe is true, the mixer collapses with a key per frame, otherwise it will try to collapse individual keyframes from the clips.

themixer.getMaxMixer <int_index>

Gets the max mixer at the specified index from the Motion Mixer. Returns a Mixer object on success.