Interface: TrackSelectionSets

 

The TrackSelectionSets Core Interface provides access to the new Track Selection Sets functionality.

Properties:

.count : integer : Read

Get the number of track selection sets.

Methods:

<boolean>create <string>name <maxObject by value array>tracks trackNames:<string by value array>

trackNames default value: #()

Creates a new track selection set with the given name out of the supplied tracks. Returns true on success.

For Example:

trackSelectionSets.create "My Objects" #($Teapot01[4]) trackNames:#("My Teapot")

true

 

<boolean>delete <string>name

Deletes the named track selection set. Returns true on success.

For Example:

trackSelectionSets.count

1

trackSelectionSets.delete "My Objects"

true

trackSelectionSets.count

0

 

<string>getName <index>index

Returns the name of the indexed track selection set.

For Example:

trackSelectionSets.create "My Objects" #($Teapot01[4]) trackNames:#("My Teapot")

true

trackSelectionSets.count

1

trackSelectionSets.getName 1

"My Objects"

 

<void>setName <index>index <string>name

Sets a new name in the named track selection set.

For Example:

trackSelectionSets.getName 1

"My Objects"

trackSelectionSets.setName 1 "Some New Name"

OK

trackSelectionSets.getName 1

"Some New Name"

 

<string>getCurrent <Interface>trackview

Returns the current track selection set in the supplied trackview.

<maxObject by value array>getTracks <string>name <&maxObject array>tracks trackNames:<&string array>

tracks is Out parameter

trackNames default value: #()

trackNames is Out parameter

Returns the tracks in the named track selection set.

For Example:

--call the method to get the tracks passing variable names by reference

trackSelectionSets.getTracks "My Objects" &my_tracks trackNames:&my_names

OK

--check the by-reference variables for the return array values

my_tracks

#(Teapot)

my_names

#("My Teapot")

 

<boolean>add <string>name <maxObject by value array>tracks trackNames:<string by value array>

trackNames default value: #()

Adds the specified objects to the named track selection set. Returns true on success.

<boolean>remove <string>name <maxObject by value array>tracks

Removes the specified objects from the named track selection set. Returns true on success.

Actions:

See also

Interface: trackviews