SelectAllUsingFilter

Introduced

v1.0

Categories

selection

Description

Selects all elements using a selection filter.

Scripting Syntax

oReturn = SelectAllUsingFilter( [SelFilter], [CheckComponentVisibility], [AffectSelectionList], [CheckObjectSelectability] );

Return Value

If SelectFlag is False, returns XSICollection containing the objects.

Parameters

Parameter Type Description
SelFilter FilterConstant Selection filter to use.

Default Value: Current selection filter

CheckComponentVisibility siComponentVisibilityMode weither or not the command should apply to visible components only

Default Value: siIgnoreComponentVisibility

Possible Values:

Description:

siIgnoreComponentVisibility The command will ignore component visibility
siCheckComponentVisibility The command will apply to visible components only
AffectSelectionList Boolean True to select objects, False to return a list of objects.

Default Value: True

CheckObjectSelectability Boolean Specifies whether to select objects that marked as unselectable.

Default Value: False

Possible Values:

Description:

False Select objects even if they are marked as unselectable.
True Do not select objects if they are marked as unselectable.

Examples

1. VBScript Example

' Selects all objects. Objects that are already selected remain selected.
SelectAllUsingFilter "object"
' Select all lights. This deselect anything that is not a light.
SelectAllUsingFilter "light"
' Select all points on active objects
SelectAllUsingFilter "Point"

2. VBScript Example

' Create a sphere, hide some polygons, deselect all polygons, select all using filter
' result = only the visible polygons are selected
NewScene
CreatePrim "Sphere", "MeshSurface"
ActivatePolygonSelTool
SelectGeometryComponents "sphere.poly[0-20]"
SITogglePolygonVisibility
DeselectAll
SelectAllUsingFilter, siCheckComponentVisibility