CanvasGroup Object
The CanvasGroup object represents a 3D Canvas Group.
| Hierarchy | GetParent |
| GetChildCount | |
| GetChild | |
| AddChild | |
| SetParent |
| Position and Orientation | GetPosition |
| SetPosition | |
| GetOrientation | |
| SetOrientation | |
| GetTransformMatrix |
| Bones | GetBoneCount |
| GetBone |
| Lights | GetLightCount |
| GetLight |
| Animation | GetAnimationStyle |
| GetPositionKeyFrameCount | |
| GetPositionKeyFrame | |
| GetOrientationKeyFrameCount | |
| GetOrientationKeyFrame |
Gets the name of the group.
Syntax
object.GetName() As Variant
Sets the name of the group.
Syntax
object.SetName(Name As Variant)
Remarks
A group must be made a child of another group using the AddChild method before it can be named.
Gets the CanvasGroup that is the parent group of the group.
Syntax
object.GetParent() As CanvasGroup
Gets the number of child groups the group has.
Syntax
object.GetChildCount() As Variant
Gets the specified child CanvasGroup object.
Syntax
object.GetChild(Index As Variant) As CanvasGroup
Adds the specified CanvasGroup object as a child group.
Syntax
object.AddChild(Group As Variant)
Remarks
This will add the group to the scene.
Sets the parent group for the specified CanvasGroup object.
Syntax
object.SetParent(ParentGroup As Variant)
Gets the position of the group relative to a specific CanvasGroup object.
Syntax
object.GetPosition(RelativeGroup As Variant,
X As Variant,
Y As Variant,
Z As Variant)
Remarks
Provide Nothing as the RelativeGroup to get the group's position in world coordinates.
Sets the position of the group relative to a specific CanvasGroup object.
Syntax
object.SetPosition(RelativeGroup As Variant,
AnimationTime As Variant,
X As Variant,
Y As Variant,
Z As Variant)
Remarks
Provide Nothing as the RelativeGroup to set the group's position in world coordinates.
The AnimationTime parameter allows you to set a position at a particular time in the animation. This allows you to set group animation paths.
Gets the orientation of the group relative to a specific CanvasGroup object.
Syntax
object.GetOrientation(RelativeGroup As Variant,
DirX As Variant,
DirY As Variant,
DirZ As Variant,
UpX As Variant,
UpY As Variant,
UpZ As Variant)
Remarks
Provide Nothing as the RelativeGroup to get the group's orientation in world coordinates.
Sets the orientation of the group relative to a specific CanvasGroup object.
Syntax
object.SetOrientation(RelativeGroup As Variant,
AnimationTime As Variant,
DirX As Variant,
DirY As Variant,
DirZ As Variant,
UpX As Variant,
UpY As Variant,
UpZ As Variant)
Remarks
Provide Nothing as the RelativeGroup to set the group's orientation in world coordinates.
The AnimationTime parameter allows you to set an orientation at a particular time in the animation. This allows you to set group animation paths.
Gets the transformation matrix of the group relative to a specific CanvasGroup object.
Syntax
object.GetTransformMatrix(RelativeGroup As Variant,
Mat00 As Variant,
Mat01 As Variant,
Mat02 As Variant,
Mat03 As Variant,
Mat10 As Variant,
Mat11 As Variant,
Mat12 As Variant,
Mat13 As Variant,
Mat20 As Variant,
Mat21 As Variant,
Mat22 As Variant,
Mat23 As Variant,
Mat30 As Variant,
Mat31 As Variant,
Mat32 As Variant,
Mat33 As Variant)
Remarks
Provide Nothing as the RelativeGroup to get the group's transformation matrix in world coordinates.
Adds a CanvasObject object to the group.
Syntax
object.AddObject(Object As Variant)
Remarks
The object is added to the scene when it is added to a group. If you make any further changes to the object after it is added to a group you will need to update it using the object's WriteScriptOperationLayer method.
Gets the number of CanvasObject objects in this group.
Syntax
object.GetObjectCount() As Variant
Gets the specified CanvasObject object.
Syntax
object.GetObject(Index As Variant) As CanvasObject
Gets the number of CanvasBone objects in this group.
Syntax
object.GetBoneCount() As Variant
Gets the specified CanvasBone object.
Syntax
object.GetBone(Index As Variant) As CanvasBone
Gets the number of CanvasLight objects in this group.
Syntax
object.GetLightCount() As Variant
Gets the specified CanvasLight object.
Syntax
object.GetLight(Index As Variant) As CanvasLight
Gets the unique identifier for the group.
Syntax
object.GetID() As Variant
Gets the animation style for the group.
Syntax
object.GetAnimationStyle() As Variant
Remarks
0 = a closed (repeating) animation
1 = an open animation
Gets the number of animation position key-frames for this group.
Syntax
object.GetPositionKeyFrameCount() As Variant
Gets the specified animation position key-frame.
Syntax
object.GetPositionKeyFrame(Index As Variant,
Time As Variant,
X As Variant,
Y As Variant,
Z As Variant)
Gets the number of animation orientation key-frames for this group.
Syntax
object.GetOrientationKeyFrameCount() As Variant
Gets the specified animation orientation key-frame.
Syntax
object.GetOrientationKeyFrame(Index As Variant,
Time As Variant,
X As Variant,
Y As Variant,
Z As Variant,
r As Variant)
Remarks
An orientation key-frame is a quaternion.
Gets the bounding box for the current group and all groups below it in the hierarchy.
Syntax
object.GetBoundingBox(MinX As Variant,
MinY As Variant,
MinZ As Variant,
MaxX As Variant,
MaxY As Variant,
MaxZ As Variant)
Gets the value of a custom field.
Syntax
object.GetCustomFieldValue(FieldID as Variant) As Variant
Remarks
The FieldID can be determined using GetGroupCustomFieldID of the CanvasApplication object.
Sets the value of a custom field.
Syntax
object.SetCustomFieldValue(FieldID as Variant, FieldValue As Variant)
Remarks
The FieldID can be determined using GetGroupCustomFieldID of the CanvasApplication object.