Scripting: OpenTransientExplorer

OpenTransientExplorer

Introduced

v3.5

Description

Pops up a transient scene explorer for picking objects. The picked objects are returned in a collection.

Scripting Syntax

oReturn = OpenTransientExplorer( [InitObjects], [Filter], [ExpandLevel], [Sort], [MultiSelect] );

Return Value

XSICollection

The return value of a collection of objects selected. This collection is empty if nothing was picked.

Parameters

Parameter	Type	Description
InitObjects	Variant	List of objects to display in transient scene explorer. Default Value: Current Selection
Filter	siTransientExplorerFilter	Scene explorer filters. Default Value: siSEFilterAllNodes
ExpandLevel	Long	Number of levels to auto-expand initial selection. Default Value: 0
Sort	Boolean	Sort the entries in alphabetical order. Default Value: False
MultiSelect	Boolean	Allows multiple objects to be selected. Default Value: False

Examples

JScript Example

// Create hiearchy
var a = GetPrim( "Null", "a" );
var b = GetPrim( "Null","b", a );
var c = GetPrim( "Null","c", b );
// Display the transient explorer
var pickedobjects = OpenTransientExplorer( a, null, 3, true, false );
Application.LogMessage( "you picked " + pickedobjects );
// A message appears in the history pane naming the item you clicked in the explorer.