Explorer Attributes

Introduced

v5.0

View attributes for the Explorer (see View.GetAttributeValue and View.SetAttributeValue). Not all attributes support both setting and getting. Check the third column in the table.

See ViewAttributes for a complete list of types of attributes that you can use when customizing your Relational Views.

Attribute Name Description Supports
allownodeexpansion This attribute controls whether you can expand the nodes in the explorer by providing a + (plus) sign (therefore making them expandable).

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

Possible Values:

Description:

'true' (Default) Nodes are expandable (plus signs appear). Note: Use the string "true", not the boolean true.
'false' Nodes are not expandable (no plus signs). Note: Use the string "false", not the boolean false.
View.GetAttributeValue and View.SetAttributeValue.
scope The scope to display (for setting) or currently on display (for getting).

See the View.SetAttributeValue, View.BeginEdit and View.GetAttributeValue methods for an example using this attribute.

Possible Values:

Description:

Project Project (Application) scope.
Preferences Preferences scope.
Scene (Default) Scene (Scene root) scope.
Layers Layers scope.
Passes Passes scope.
Environments Environments scope.
Selection Selection scope.
Custom Custom scope.
Current Layer Current Layer scope.
Current Pass Current Pass scope.
Current Environment Current Environment scope.
Sources and Clips Sources and Clips (combined) scope.
Animation Sources Animation sources scope.
Audio Sources and Clips Audio sources and clips scope.
Image Sources and Clips Image sources and clips scope.
Material Sources Material sources scope.
View.GetAttributeValue and View.SetAttributeValue.
localselection Determines whether the explorer maintains its own local selection. If this option is on, elements selected in the explorer do not affect the global selection in the scene. Locally selected elements are highlighted in pale blue rather than white.

Possible Values:

Description:

'false' (Default) Selected elements affect the global selection in the scene. Note: Use the string "false", not the boolean false.
'true' Selected elements do not affect the global selection in the scene. Note: Use the string "true", not the boolean true.
View.GetAttributeValue and View.SetAttributeValue.
targetcontent The node(s) to display (for setting) or currently on display (for getting) in the Explorer. This attribute is only available when the scope is set to either "Selection" or "Custom".

Possible Values:

Description:

<node name> The Object Name or Parameter Name to focus on.
View.SetAttributeValue only.
select The node(s) to select (for setting) or already selected (for getting) in the Explorer. The selection can be either global or local.

Possible Values:

Description:

<node name> The Object Name or Parameter Name to select.
View.SetAttributeValue only.
supportmarking Determines whether the explorer will mark or select parameter nodes. If this option is on, parameter nodes selected in the explorer are "marked" rather than selected. Marked elements are highlighted in yellow rather than white.

Possible Values:

Description:

'true' (Default) Selected parameter nodes are marked rather than selected. Note: Use the string "true", not the boolean true.
'false' Parameter nodes will be selected. Note: Use the string "false", not the boolean false.
View.GetAttributeValue and View.SetAttributeValue.
generalsort Sorts objects, sources, clips, and other basic elements according to the specified sorting order.

Possible Values:

Description:

'None' Uses the order based on when an element was created or parented.
'Alphabetical' Sorts the elements alphabetically. Any numeric suffix is sorted in correct numerical order, so Object2 comes before Object10. The children of an object are always listed after any parameter sets of the object.
'Used + Alphabetical' Sorts the elements into used and unused groups, and then sorts alphabetically within each group. This option is available only with the Sources/Clips scopes.
'Type + Alphabetical' (Default) Sorts the elements by type first, and then alphabetically within each type. The types depend on the scope. For example with the Scene Root scope, the explorer lists all the cameras in alphabetical order, then all the lights, models, referenced models, nulls, chains, curves, polygon meshes, NURBS surfaces, text, particle clouds, hair objects, control objects, forces, dynamic constraints, implicits, and geoshaders, each in alphabetical order. If the scope contains only one type of element, this option is equivalent to Alphabetical.
View.GetAttributeValue and View.SetAttributeValue.
FilterMask Determines which types of nodes are displayed in the explorer. This is the scripting equivalent of changing the selection in the Filter 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 siSEFilterMask enum. For example: 
// Show only animated nodes

myView.SetAttributeValue("FilterMask", siSEFilterAnimatedNodes); 



// Show objects, models and groups

myView.SetAttributeValue("FilterMask", "Group|Object|Model");
 View.GetAttributeValue and View.SetAttributeValue.
trackselection Determines whether or not the 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 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 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 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 explorer opens.

Possible Values:

Description:

'None' (Default) 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' 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 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 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' (Default) Use the regular name. Note: Use the string "false", not the boolean false.
'true' Use the script name. Note: Use the string "true", not the boolean true.
View.GetAttributeValue and View.SetAttributeValue.
parametervalues Determines whether or not the 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' (Default) Uses the order based on when an element was created or parented.
'Alphabetical' 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 This attribute controls the lock state of the selection scope. Set is only valid for Selection scope (attribute is ignored for other scopes). Get returns "false" for non-selection scopes.

Possible Values:

Description:

'true' Lock the Selection scope. Note: Use the string "true", not the boolean true.
'false' Unlock the Selection scope. Note: Use the string "false", not the boolean false.
View.GetAttributeValue and View.SetAttributeValue.

Please send us your comments about this page