User Guide

Groups 323
Groups
Groups are collections of models and other objects that are formally associated with one another.
These associations can be created in your 3D modeling software or with script. Each 3D cast
member has a default group called world, which is the cast member.
Groups simplify the rotation and translation of models by letting all members of a group move
together with a single command. A group has a name, a transform, and a parent, and can also
have children. It has no other properties.
The following cast member methods and properties can be used to perform basic
group operations:
deleteCamera
(name)
Deletes the camera named
name. Script
references to this camera persist but can
do nothing.
TRUE (1) if the camera named
name exists. FALSE (0) if
the camera named
name
doesn’t exist.
deleteCamera
(index)
Deletes the camera with the given index
number. Script references to this camera
persist but can do nothing.
TRUE (1) if the camera with
this index number exists.
FALSE
(0)
if the camera with this
index number doesn’t exist.
Method Function Returns
group.count
Returns the number of group objects
included in the cast member.
Integer.
group(name)
Returns the group named name. Returns the group object
named
name if it exists. Returns
void if the object does not
exist.
group[index]
Returns the group at the designated position
in the index. The index number can change if
groups are added or deleted.
Returns the group object at
that index number if it exists.
Returns
void if the object does
not exist at that index number.
newGroup(name)
Creates a new group and adds it to the
group object list.
Returns a new group object
with a unique name. If the
name isn’t unique, returns a
script error.
deleteGroup
(name)
Deletes the group named name. Script
references to this group persist but can
do nothing.
TRUE (1) if the group named
name exists. FALSE (0) if
the group named
name doesn’t
exist.
deleteGroup
[index]
Deletes the group with the given index
number. Script references to this group
persist but can do nothing.
TRUE (1) if the group with this
index number exists.
FALSE
(0)
if the group with this index
number doesn’t exist.
Method Function Returns