RemoveFromSelection

Introduced

v1.0

Description

Removes elements from the selection.

Note: If the SelectionList argument contains an error, the command fails.

Scripting Syntax

oReturn = RemoveFromSelection( SelectionList, [HierarchyLevel] );

Return Value

Returns XSICollection that contains the objects removed from the selection.

Parameters

Parameter Type Description
SelectionList String List of elements to remove from the selection.
HierarchyLevel String Specifies how to select objects in a hierarchy.

Default Value: "ASITIS"

Possible Values:

Description:

ASITIS Select the object as it is.
NODE Select the object.
BRANCH Select the object and its children.
TREE Select the entire hierarchy of objects.
MODEL Select the model and the hierarchy of objects.

Examples

VBScript Example

' The following creates 5 cylinders, select them all, then deselect one of them

NewScene

CreatePrim "Cylinder", "MeshSurface"

Duplicate "cylinder", , 2, 1, 1, 0, 0, 1, 0, 1

Translate , -3.30097087378641, 2.93327468983085, 0, _

		siRelative, siView, siObj, siXYZ

Duplicate "cylinder1", , 2, 1, 1, 0, 0, 1, 0, 1

Translate , 7.65048543689321, -0.563344145729104, 0, _

		siRelative, siView, siObj, siXYZ

Duplicate "cylinder2", , 2, 1, 1, 0, 0, 1, 0, 1

Translate , -5.32038834951456, -5.22550259314237, 0, _

		siRelative, siView, siObj, siXYZ

Duplicate "cylinder3", , 2, 1, 1, 0, 0, 1, 0, 1

Translate , -0.621359223300971, 3.24408525299174, 0, _

		siRelative, siView, siObj, siXYZ

SelectObj "cylinder*"

RemoveFromSelection "cylinder2"

logMessage "all cylinders except cylinder2 should be selected now"

See Also

Selection SelectObj AddToSelection RemoveFromSelection SelectBranch SelectTree SelectModel