Animation Editor Attributes

Attribute Name

Description

Supports

targetcontent

The name of the object for which to display the animated parameters. If the view is driven by a relationship, this content can be replaced dynamically. You can also control this attribute programmatically even if the view is not driven.

Possible Values:	Description:
<any eligible scene object>	The SIObject.Name of an object with animated parameters.

View.GetAttributeValue and View.SetAttributeValue.

viewer

The viewer to display in the animation editor when it is opened. When you open the Animation Editor the list of parameters is scanned and the "default" editor for those parameters is opened. So if you have a single parameter with an expression then the Expression Editor is opened. However, if there is a mix of expressions and fcurves then the FCurve Editor is opened.

Possible Values:	Description:
FCurve Editor	Load the FCurve Editor in the editor.
DopeSheet	Load the DopeSheet in the editor.
Expression Editor	Load the Expression Editor in the editor.
Scripted Operator Editor	Load the Scripted Operator Editor in the editor.

View.GetAttributeValue and View.SetAttributeValue.

drivingaction

Determines or not whether the animation editor will display only the parameters that are driven by an action clip at the current frame.

Possible Values:	Description:
'false'	(Default) Display parameters whether driven or not. Note: Use the string "false", not the boolean false.
'true'	Display only driven parameters. Note: Use the string "true", not the boolean true.

View.GetAttributeValue and View.SetAttributeValue.

animatedparamsonly

Determines whether or not the animation editor will display only the element's animated parameters and their associated fcurves in the graph.

Possible Values:	Description:
'false'	No restrictions on displaying animated parameter. Note: Use the string "false", not the boolean false.
'true'	(Default) Display only the element's animated parameters and fcurves. Note: Use the string "true", not the boolean true.

View.GetAttributeValue and View.SetAttributeValue.

keyableparamsonly

Determines whether or not the animation editor will display only the element's keyable parameters as defined in the keyable parameters editor.

Possible Values:	Description:
'false'	(Default) No restrictions on displaying keyable parameters. Note: Use the string "false", not the boolean false.
'true'	Display only the element's keyable parameters. Note: Use the string "true", not the boolean true.

View.GetAttributeValue and View.SetAttributeValue.

filterpreset

Determines what kind of parameters will be displayed. See the siATFilterPreset enum for the list of valid values.

View.GetAttributeValue and View.SetAttributeValue.

taggedparameters

Determines which tagged parameters for the elements and their associated fcurves will be displayed. This is the scripting equivalent of changing the selection in the Explorer->Parameter Filters->Tagged Parameters menu. This is a kind of a string mask, so to set the value, you can pass a pipe-delimited ('|') list of options or specify a single value from the siATFilterTaggedParameters enum. For example:

// Show only tagged 1 parameters

myView.SetAttributeValue("TaggedParameters", siATFilterTagged1); 



// Show tagged 3, 4 and 5 parameters

myView.SetAttributeValue("TaggedParameters", "Tag3|Tag4|Tag5");

If the siATFilterTaggedAll value is passed to the View.SetAttributeValue method, any other values will be ignored.

View.GetAttributeValue and View.SetAttributeValue.

activationparamsonly

Determines whether or not the animation editor will display only the element's active or mute parameters.

Possible Values:	Description:
'false'	(Default) No restrictions on displaying Active or Mute parameters. Note: Use the string "false", not the boolean false.
'true'	Display only the element's Active or Mute parameters. Note: Use the string "true", not the boolean true.

View.GetAttributeValue and View.SetAttributeValue.

markedparamsonly

Determines whether or not the animation editor will display only the marked parameters for the elements and their associated function curves.

Possible Values:	Description:
'false'	(Default) No restrictions on displaying marked parameters. Note: Use the string "false", not the boolean false.
'true'	Display only the marked parameters. Note: Use the string "true", not the boolean true.

View.GetAttributeValue and View.SetAttributeValue.

trackselection

Determines whether or not the animation explorer will automatically scroll to ensure that the node of the first selected elements is always visible.

Possible Values:	Description:
'false'	(Default) Disable automatic scrolling. Note: Use the string "false", not the boolean false.
'true'	Enable automatic scrolling. Note: Use the string "true", not the boolean true.

View.GetAttributeValue and View.SetAttributeValue.

decomposebranchsel

Determines whether the animation explorer will display the children, grandchildren, and other descendents of a branch-selected object as top-level nodes or as a nested hierarchy.

Possible Values:	Description:
'false'	(Default) Display as nested hierarchy. Note: Use the string "false", not the boolean false.
'true'	Display hierarchy as top-level nodes. Note: Use the string "true", not the boolean true.

View.GetAttributeValue and View.SetAttributeValue.

localpropsonly

Determines whether the animation explorer will display only the properties that have been applied directly to an object or all properties, no matter how they are propagated.

Possible Values:	Description:
'false'	(Default) Display all properties. Note: Use the string "false", not the boolean false.
'true'	Display the properties that have been applied directly to an object. Note: Use the string "true", not the boolean true.

View.GetAttributeValue and View.SetAttributeValue.

lockedparams

Determines whether or not the animation explorer will display the locked parameters.

Possible Values:	Description:
'false'	Locked parameters will not be visible. Note: Use the string "false", not the boolean false.
'true'	(Default) Display the locked parameters. Note: Use the string "true", not the boolean true.

View.GetAttributeValue and View.SetAttributeValue.

flattenstate

Controls how the hierarchy appears when the animation editor opens.

Possible Values:	Description:
'None'	Displays the entire hierarchy.
'Parameters'	Appears without intermediate nodes and with renamed nodes at the ends of branches. For example, Global Transform > Pos > X node appears as Global Transform > Pos.X.
'All'	(Default) Displays parameters in a flat list, hiding intermediate nodes (properties, primitives, materials, etc.). For example, Global Transform > Pos > X node is shortened to Global Transform.Pos.X.

View.GetAttributeValue and View.SetAttributeValue.

colorcoding

Determines whether or not the animation explorer will display different types of nodes in different colors.

Possible Values:	Description:
'false'	No color coding for type. Note: Use the string "false", not the boolean false.
'true'	(Default) Indicates node type by color. Note: Use the string "true", not the boolean true.

View.GetAttributeValue and View.SetAttributeValue.

scriptnames

Determines whether the animation explorer will use the script name instead of regular name for node labels.

See the View.BeginEdit method for an example using this attribute.

Possible Values:	Description:
'false'	Use the regular name. Note: Use the string "false", not the boolean false.
'true'	(Default) Use the script name. Note: Use the string "true", not the boolean true.

View.GetAttributeValue and View.SetAttributeValue.

parametervalues

Determines whether or not the animation explorer will display the values of any and all selected parameters.

Possible Values:	Description:
'false'	(Default) Do not display values. Note: Use the string "false", not the boolean false.
'true'	Parameter values will appear next to the parameter name. Note: Use the string "true", not the boolean true.

View.GetAttributeValue and View.SetAttributeValue.

parametersort

Sorts parameters according to the specified criteria.

Possible Values:	Description:
'None'	Uses the order based on when an element was created or parented.
'Alphabetical'	(Default) Sorts the parameters alphabetically. Any numeric suffix is sorted in correct numerical order, so Param2 comes before Param10.
'Layout'	Uses the order in which the parameters appear in their property editor. If a parameter does not appear in the corresponding property editor, it is not listed.

View.GetAttributeValue and View.SetAttributeValue.

lock

Controls the lock state of the animation explorer.

Possible Values:	Description:
'true'	Lock the animation explorer. Note: Use the string "true", not the boolean true.
'false'	Unlock the animation explorer. Note: Use the string "false", not the boolean false.

View.GetAttributeValue and View.SetAttributeValue.

ripple

Determines whether or not existing keys are pushed ahead on the timeline when you parse keys on an fcurve or when you scale a region of keys.

Note: This attribute is only effective if the view area (right panel) is the fcurve graph.

Possible Values:	Description:
false	(Default) Turns off ripple mode. Note: Use the boolean false.
true	Turns on ripple mode. Note: Use the boolean true.

View.GetAttributeValue and View.SetAttributeValue.

snaptogrid

Determines whether or not the animation editor will use the snap-to-grid feature.

Note: This attribute is only effective if the view area (right panel) is the fcurve graph.

Possible Values:	Description:
'false'	(Default) Do not use snap-to-grid feature. Note: Use the string "false", not the boolean false.
'true'	Use the snap-to-grid feature. Note: Use the string "true", not the boolean true.

View.GetAttributeValue and View.SetAttributeValue.

snaptoframe

Determines whether or not the animation editor will use the snap-to-frame feature.

Note: This attribute is only effective if the view area (right panel) is the fcurve graph.

Possible Values:	Description:
'false'	(Default) Do not use snap-to-frame feature. Note: Use the string "false", not the boolean false.
'true'	Use the snap-to-frame feature. Note: Use the string "true", not the boolean true.

View.GetAttributeValue and View.SetAttributeValue.

snapslopes

Determines whether or not the slope handles on key points will snap when manipulated.

Note: This attribute is only effective if the view area (right panel) is the fcurve graph.

Possible Values:	Description:
'false'	(Default) No snapping on slope handles. Note: Use the string "false", not the boolean false.
'true'	The slope handles on key points will snap when manipulated. Note: Use the string "true", not the boolean true.

View.GetAttributeValue and View.SetAttributeValue.

selectedcurves

Returns or sets the selected FCurve objects as a comma-delimited string containing the full name of the FCurve's parent. If nothing is selected, it returns an empty string.

Note: This attribute is only effective if the view area (right panel) is the fcurve graph.

Possible Values:	Description:
<string>	The parent(s) SIObject.FullName of FCurve Object(s).

View.GetAttributeValue and View.SetAttributeValue.

frameall

Frames all displayed fcurves.

Note: This attribute is only effective if the view area (right panel) is the fcurve graph.

Possible Values:	Description:
<any value>	This value is ignored.

View.SetAttributeValue only.

frameselection

Frames selection.

Note: This attribute is only effective if the view area (right panel) is the fcurve graph.

Possible Values:	Description:
<any value>	This value is ignored.

View.SetAttributeValue only.

frameplaybackrange

Frames all the fcurves within the time span specified by the timeline.

Note: This attribute is only effective if the view area (right panel) is the fcurve graph.

Possible Values:	Description:
<any value>	This value is ignored.

View.SetAttributeValue only.

frameselectedkeys

Frames selected keys.

Note: This attribute is only effective if the view area (right panel) is the fcurve graph.

Possible Values:	Description:
<any value>	This value is ignored.

View.SetAttributeValue only.

frameselectedcurves

Frames selected fcurves.

Note: This attribute is only effective if the view area (right panel) is the fcurve graph.

Possible Values:	Description:
<any value>	This value is ignored.

View.SetAttributeValue only.

frameregion

Frames a region.

Note: This attribute is only effective if the view area (right panel) is the fcurve graph.

Possible Values:	Description:
<any value>	This value is ignored.

View.SetAttributeValue only.

centercurrenttime

Centers the fcurve graph around the timeline cursor's position, when the timeline cursor is visible.

Note: This attribute is only effective if the view area (right panel) is the fcurve graph.

Possible Values:	Description:
<any value>	This value is ignored.

View.SetAttributeValue only.

autoframe

Determines whether or not animation editor will frame all fcurves automatically.

Note: This attribute is only effective if the view area (right panel) is the fcurve graph.

Possible Values:	Description:
false	(Default) Disables the automatic framing. Note: Use the boolean false.
true	Enables the automatic framing. Note: Use the boolean true.

View.GetAttributeValue and View.SetAttributeValue.

interactiveupdate

Determines whether or not to see the effect of the changes in viewports as you edit the fcurves.

Note: This attribute is only effective if the view area (right panel) is the fcurve graph.

Possible Values:	Description:
false	(Default) "Interactive update" option is off. Note: Use the boolean false.
true	"Interactive update" option is on. Note: Use the boolean true.

View.GetAttributeValue and View.SetAttributeValue.

showbuffercurves

Determines whether or not to display a temporary copy of the original function curve that has been saved into a buffer.

Note: This attribute is only effective if the view area (right panel) is the fcurve graph.

Possible Values:	Description:
false	(Default) Don't show the buffer curves. Note: Use the boolean false.
true	Shows the buffer curves. Note: Use the boolean true.

View.GetAttributeValue and View.SetAttributeValue.

displaynormalized

Determines whether or not to display the normalized fcurves.

Note: This attribute is only effective if the view area (right panel) is the fcurve graph.

Possible Values:	Description:
false	(Default) Displays non-normalized fcurves. Note: Use the boolean false.
true	Displays normalized fcurves. Note: Use the boolean true.

View.GetAttributeValue and View.SetAttributeValue.

classicmode

Switches between Suite and Classic Mode.

Note: This attribute is only effective if the view area (right panel) is the fcurve graph.

Possible Values:	Description:
false	Suite Mode is active which is designed to be used if you're running the Suite version of Softimage. Note: Use the boolean false.
true	(Default) Classic Mode is on to provide all tools that you are used to as a seasoned Softimage user. Note: Use the boolean true.

View.GetAttributeValue and View.SetAttributeValue.

hle

Determines whether or not to enable the high-level editing (HLE) tool.

Note: This attribute is only effective if the view area (right panel) is the fcurve graph.

Possible Values:	Description:
false	(Default) Disables the high-level editing (HLE) tool. Note: Use the binary false.
true	Enables the high-level editing (HLE) tool. Note: Use the binary true.

View.GetAttributeValue and View.SetAttributeValue.

hlecompensation

Determines whether or not to enable the high-level editing (HLE) compensation mode, when the HLE tool is activated.

Note: This attribute is only effective if the view area (right panel) is the fcurve graph.

Possible Values:	Description:
false	(Default) Disables the high-level editing (HLE) compensation mode. Note: Use the binary false.
true	Enables the high-level editing (HLE) compensation mode. Note: Use the binary true.

View.GetAttributeValue and View.SetAttributeValue.

hleoperation

Determines which high-level editing (HLE) operation the HLE tool uses, when enabled.

Note: This attribute is only effective if the view area (right panel) is the fcurve graph.

Possible Values:	Description:
siHLEOperationRelativeOffset	The HLE tool uses the Relative Offset operation.
siHLEOperationAbsoluteOffset	(Default) The HLE tool uses the Absolute Offset operation.
siHLEOperationAbsoluteScaling	The HLE tool uses the Absolute Scaling operation.

View.GetAttributeValue and View.SetAttributeValue.

displayoptions

Determines which fcurves are displayed in the graph by default.

Possible Values:	Description:
siAllParam	Displays fcurves for all parameters of the selected object.
siMarkedParam	Displays fcurves only for the object's marked parameters.
siAnimatedParam	(Default) Displays fcurves only for the object's animated parameters.
siSelectedParam	Displays fcurves only for the object's selected parameters.

View.GetAttributeValue and View.SetAttributeValue.

isolatecurve

Determines whether or not to isolate the selected fcurves so that only they appear in the graph.

Note: This attribute is only effective if the view area (right panel) is the fcurve graph.

Possible Values:	Description:
false	(Default) Disables the isolating feature. Note: Use the boolean false.
true	Isolates the selected fcurves. Note: Use the boolean true.

View.GetAttributeValue and View.SetAttributeValue.

clearallcurves

Hides all fcurves associated with the selected object without collapsing the animation explorer.

Note: This attribute is only effective if the view area (right panel) is the fcurve graph.

Possible Values:	Description:
<any value>	This value is ignored.

View.SetAttributeValue only.

hidecurve

Hides the selected fcurves. This also deselects the fcurves.

Note: This attribute is only effective if the view area (right panel) is the fcurve graph.

Possible Values:	Description:
<any value>	This value is ignored.

View.SetAttributeValue only.

unhideallcurves

Displays all hidden fcurves.

Note: This attribute is only effective if the view area (right panel) is the fcurve graph.

Possible Values:	Description:
<any value>	This value is ignored.

View.SetAttributeValue only.

keysonunselectedcurves

Determins whether or not to display keys on all unselected curves.

Note: This attribute is only effective if the view area (right panel) is the fcurve graph.

Possible Values:	Description:
false	(Default) Hides keys on all unselected curves. Note: Use the boolean false.
true	Shows keys on all unselected curves. Note: Use the boolean true.

View.GetAttributeValue and View.SetAttributeValue.

slopesonunselectedkeys

Determines whether or not to display the slope handles of all unselected keys on a selected curve.

Note: This attribute is only effective if the view area (right panel) is the fcurve graph.

Possible Values:	Description:
false	(Default) Hides slope handles of all unselected keys. Note: Use the boolean false.
true	Shows slope handles of all unselected keys. Note: Use the boolean true.

View.GetAttributeValue and View.SetAttributeValue.

showlabels

Determines whether or not to display labels on all selected curves.

Note: This attribute is only effective if the view area (right panel) is the fcurve graph.

Possible Values:	Description:
false	(Default) Hides the curve and axis labels. Note: Use the boolean false.
true	Shows the curve and axis labels. Note: Use the boolean true.

View.GetAttributeValue and View.SetAttributeValue.

keyscoordinates

Determines whether or not to display the X and Y coordinate values for each selected key.

Note: This attribute is only effective if the view area (right panel) is the fcurve graph.

Possible Values:	Description:
false	Hides the coordinate values. Note: Use the boolean false.
true	(Default) Shows the coordinate values. Note: Use the boolean true.

View.GetAttributeValue and View.SetAttributeValue.

grid

Determines whether or not to display the X and Y axis grid lines.

Note: This attribute is only effective if the view area (right panel) is the fcurve graph.

Possible Values:	Description:
false	Hides the grid lines. Note: Use the boolean false.
true	(Default) Shows the grid lines. Note: Use the boolean true.

View.GetAttributeValue and View.SetAttributeValue.

rulers

Determines whether or not to display the rulers on the horizontal X (time) and vertical Y (value) axes.

Note: This attribute is only effective if the view area (right panel) is the fcurve graph.

Possible Values:	Description:
false	Hides both X and Y axes. Note: Use the boolean false.
true	(Default) Shows both X and Y axes. Note: Use the boolean true.

View.GetAttributeValue and View.SetAttributeValue.

timecursorvisible

Determines whether or not to display the red playback cursor in the fcurve graph.

Note: This attribute is only effective if the view area (right panel) is the fcurve graph.

Possible Values:	Description:
false	Hides the playback cursor. Note: Use the boolean false.
true	(Default) Shows the playback cursor. Note: Use the boolean true.

View.GetAttributeValue and View.SetAttributeValue.

timecursorselectable

Determines whether or not the red playback cursor is selectable in the fcurve graph.

Note: This attribute is only effective if the view area (right panel) is the fcurve graph.

Possible Values:	Description:
false	(Default) Only can drag the cursor in the timeline area. Note: Use the boolean false.
true	Makes the playback cursor available in the graph so that you can also select and drag it in graph area. Note: Use the boolean true.

View.GetAttributeValue and View.SetAttributeValue.

metacurveregion

Determines whether or not to display a bar below the graph showing an overview representation of all the keys of the selected fcurves.

Note: This attribute is only effective if the view area (right panel) is the fcurve graph.

Possible Values:	Description:
false	(Default) Hides the metacurve region. Note: Use the boolean false.
true	Shows the metacurve region. Note: Use the boolean true.

View.GetAttributeValue and View.SetAttributeValue.

localtime

Determines whether or not to display the corresponding time of the animation between the action in the animation mixer and the fcurve editor.

Note: This attribute is only effective if the view area (right panel) is the fcurve graph.

Possible Values:	Description:
false	(Default) Disables this feature. Note: Use the boolean false.
true	Shows the local time of where the original action source is being evaluated in fcurve editor, and shows whether this point is in relation to the global time of the scene in Mixer. Note: Use the boolean true.

View.GetAttributeValue and View.SetAttributeValue.

framerange

Returns or sets the frame range in frame values.

Note: This attribute is only effective if the view area (right panel) is the fcurve graph.

Possible Values:	Description:
<start>,<end>	Frame range, specified by a comma-delimited string containing the start and end frame values.

View.GetAttributeValue and View.SetAttributeValue.

timerange

Returns or sets the frame range in time values.

Note: This attribute is only effective if the view area (right panel) is the fcurve graph.

Possible Values:	Description:
<start>,<end>	Frame range, specified by a comma-delimited string containing the start and end time values.

View.GetAttributeValue and View.SetAttributeValue.

valuerange

Returns or sets the minimum/maximum values (Y axis) range.

Note: This attribute is only effective if the view area (right panel) is the fcurve graph.

Possible Values:	Description:
<minimum>,<maximum>	Value range, specified by a comma-delimited string containing the minimum and maximum values (Y axis).

View.GetAttributeValue and View.SetAttributeValue.

displayedcurves

Returns or sets the displayed FCurve objects as a comma delimited string containing the full name of the FCurve's parent. If nothing is displayed, it returns an empty string.

Note: This attribute is only effective if the view area (right panel) is the fcurve graph.

Possible Values:	Description:
<string>	The Parent's SIObject.FullName of FCurve Object(s).

View.GetAttributeValue and View.SetAttributeValue.

selectedkeysatframes

Returns or sets the selected keys of FCurve objects as a string. The string format is the following: ",,;,,".

Note: This attribute is only effective if the view area (right panel) is the fcurve graph.

For example:

// Selects keys at frame 1 and frame 25 of the local posx of the cone object and the frame 50 of the local sclx of the Model.sphere object.

myView.SetAttributeValue( "selectedkeysatframes", "cone.kine.local.posx,1,25;Model.sphere.local.kine.sclx,50" );

Possible Values:	Description:
<string>	A string representing the selected keys in a context of frame values (X axis).

View.GetAttributeValue and View.SetAttributeValue.

selectedkeysattimes

// Selects keys at time 0.5 and time 4 of the local posx of the cone object and the time 8 of the local sclx of the Model.sphere object.

myView.SetAttributeValue( "selectedkeysattimes", "cone.kine.local.posx,0.5,4;Model.sphere.local.kine.sclx,8" );

Possible Values:	Description:
<string>	A string representing the selected keys in a context of time values (X axis).

View.GetAttributeValue and View.SetAttributeValue.

savebuffer

Saves the buffer copy of the edited curve, when buffer curves option is active.

Note: This attribute is only effective if the view area (right panel) is the fcurve graph.

Possible Values:	Description:
<any value>	This value is ignored.

View.SetAttributeValue only.

swapbuffer

Swaps between the edited curve and its buffer copy, when buffer curves option is active.

Note: This attribute is only effective if the view area (right panel) is the fcurve graph.

Possible Values:	Description:
<any value>	This value is ignored.

View.SetAttributeValue only.

autosnaptoframes

Determines whether the keys will be kept on frames when scaling regions or not.

Note: This attribute is only effective if the view area (right panel) is the fcurve graph or the dopesheet.

Possible Values:	Description:
'false'	(Default) Keys will not be snapped to frames. Note: Use the string "false", not the boolean false.
'true'	The keys will be kept on frames when scaling regions. Note: Use the string "true", not the boolean true.

View.GetAttributeValue and View.SetAttributeValue.

Animation Editor Attributes

Introduced