Object View Attributes

Introduced

v5.0

View attributes for the Object View. Some of these attributes are available for View.GetAttributeValue and View.SetAttributeValue but some are only available for View.GetAttributeValue. Check the third column in the table.

Note See ViewAttributes for a complete list of types of attributes that you can use when customizing your Relational Views.
Attribute Name Description Supports
autoalign If set to "true", the camera automatically aligns along the default view axis whenever the view is updated.

Possible Values:

Description:

'true' (Default) Enables the Auto Align Camera option. Note: Use the string "true", not the binary true.
'false' Disables the Auto Align Camera option. Note: Use the string "false", not the binary false.
View.GetAttributeValue only.
autoframe If set to "true", the camera automatically frames the selection whenever the view is updated.

Possible Values:

Description:

'true' (Default) Enables the Auto Frame Camera option. Note: Use the string "true", not the binary true.
'false' Disables the Auto Frame Camera option. Note: Use the string "false", not the binary false.
View.GetAttributeValue only.
autoselect Modifies the behaviour of the Auto Align Camera option so that the camera alignment axis is controlled by the maximum area of the bounding box. In other words, the camera view is set to front/top/right based on the area of the bounding box in that view.

Possible Values:

Description:

'true' Enables the Auto Select View option. Note: Use the string "true", not the binary true.
'false' (Default) Disables the Auto Select View option. Note: Use the string "false", not the binary false.
View.GetAttributeValue only.
camera The name of a camera to use.

Possible Values:

Description:

default User (default)
user User (default)
render Render Pass
render pass Render Pass
<any scene camera name> The name of any camera in the scene
<any spotlight name> The name of any spotlight in the scene
View.GetAttributeValue and View.SetAttributeValue.
compensate Controls whether the camera is adjusted to compensate for changes to the selection. In other words, when this option is enabled, the camera is locked to the selection while it is animated, transformed, and so on.

Possible Values:

Description:

'true' (Default) Enables the Camera Compensation option. Note: Use the string "true", not the binary true.
'false' Disables the Camera Compensation option. Note: Use the string "false", not the binary false.
View.GetAttributeValue only.
displayall Displays all visible scene objects in the object view, instead of just the selection.

Possible Values:

Description:

'true' Enables the Display All Objects option. Note: Use the string "true", not the binary true.
'false' (Default) Disables the Display All Objects option. Note: Use the string "false", not the binary false.
View.GetAttributeValue only.
displaymode Get or set the default display mode to use when the object view is opened.

Possible Values:

Description:

bounding box Bounding Box
wireframe Wireframe (default)
depth cue DepthCue
hidden line removal Hidden Line
constant Constant
shaded Shaded
textured Textured
textured decal Textured Decal
realtime shaders OpenGL/Cg
View.GetAttributeValue and View.SetAttributeValue.
localview Controls whether the top/bottom/front/back/left/right views are based on the reference object (i.e. the first object in the display list) or whether they are global views.

Possible Values:

Description:

'true' (Default) Enables the Local Camera View option. Note: Use the string "true", not the binary true.
'false' Disables the Local Camera View option. Note: Use the string "false", not the binary false.
View.GetAttributeValue only.
lockstatus Controls the state of the lock selection button in the toolbar.

Possible Values:

Description:

'true' Locks the selection in the object view.
'false' Unlocks the selection in the object view. This means that the object view display will change when the selection changes.
View.GetAttributeValue and View.SetAttributeValue.
modifycameras When the View is set to a scene camera or spotlight, changing the selection modifies the camera/light's position based on changes in the object view.

Possible Values:

Description:

'true' Enables the Modify Scene Cameras option. Note: Use the string "true", not the binary true.
'false' (Default) Disables the Modify Scene Cameras option. Note: Use the string "false", not the binary false.
View.GetAttributeValue only.
rotatecomp When Camera Compensation is activated, this option allows you to toggle the compensation for rotation.

For example, this is useful if you want to track an object, but you don't want the camera to rotate with it.

Possible Values:

Description:

'true' (Default) Enables the Compensate > Rotation option. Note: Use the string "true", not the binary true.
'false' Disables the Compensate > Rotation option. Note: Use the string "false", not the binary false.
View.GetAttributeValue only.
scalecomp When Camera Compensation is activated, this option allows you to toggle the compensation for scaling.

For example, this is useful if you want to track an object, but you don't want the camera to scale with it.

Possible Values:

Description:

'true' (Default) Enables the Compensate > Scaling option. Note: Use the string "true", not the binary true.
'false' Disables the Compensate > Scaling option. Note: Use the string "false", not the binary false.
View.GetAttributeValue only.
targetcontent The name of an object to view by default when the object view is opened. When the view is opened, it displays this element if it exists. The displayed object may change as you select objects unless the object view is locked.

If the view is driven by a relationship, this content can be replaced dynamically.

Possible Values:

Description:

<name of a scene item> The SIObject.FullName of the object to display (by default, the current selection is used).
View.GetAttributeValue and View.SetAttributeValue.
translatecomp When Camera Compensation is activated, this option allows you to toggle the compensation for translation.

For example, this is useful if you want to track an object, but you don't want the camera to translate with it.

Possible Values:

Description:

'true' (Default) Enables the Compensate > Translation option. Note: Use the string "true", not the binary true.
'false' Disables the Compensate > Translation option. Note: Use the string "false", not the binary false.
View.GetAttributeValue only.
view The default point of view to use when the object view is opened.

Possible Values:

Description:

top View from the top
bottom View from the bottom
front View from the front
back View from the back
right View from the right
left View from the left
View.GetAttributeValue and View.SetAttributeValue.