SetDisplayMode

Description

Sets the display mode for a camera.

Scripting Syntax

SetDisplayMode( [InputObjs], [DisplayMode] )

Parameters

Parameter

Type

Description

InputObjs

String

List of cameras to set.

Default Value: Selected properties

DisplayMode

String

Display mode

Default Value: wireframe

Possible Values:

• bbox: Bounding box display mode

• wireframe: Wireframe display mode

• depthcue: Depth-cue display mode

• hiddenline: Hidden-line display mode

• constant: Constant display mode

• shaded: Shaded display mode

• textured: Textured display mode

• texturedecal: Texture decal display mode

• realtimeshaders: Real-time shader display mode

Examples

1. VBScript Example

' Set User Camera in viewport A to wireframe mode
SetDisplayMode "Views.ViewA.UserCamera", "wireframe"

2. JScript Example

// Demonstrate how SetDisplayMode is actually just a shortcut
// to setting values on the Camera's Display Property.

var camera = Dictionary.GetObject( "Views.ViewA.UserCamera" )
var displayModeProp = camera.Properties( "Camera Display" ) ;

logmessage( "Static Display mode before : " + displayModeProp.viewportmodename.Value ) ;
SetDisplayMode( camera , "shaded" ) ;
logmessage( "Static Display mode after : " + displayModeProp.viewportmodename.Value ) ;


//Result: 
//INFO : Static Display mode before : wireframe
//INFO : Static Display mode after : shaded

InspectObj( displayModeProp ) ;

See Also

SetViewDisplayMode

SetLightingDisplayMode

ToggleHeadlightDisplayMode

SOFTIMAGE|XSI v6.01     

Return to Softimage XSI Index