CanvasScene Object
The CanvasScene Object represents a 3D Canvas Scene.
| Groups | CreateGroup |
| GetRootGroup | |
| GetGroupCount | |
| GetGroup | |
| GetActiveGroupCount | |
| GetActiveGroup | |
| GetCameraGroup |
| Lights | GetLightCount |
| GetLight |
| Materials | CreateMaterial |
| General | GetAnimationKeyFrameCount |
| SetAnimationKeyFrameCount | |
| GetAnimationKeyFPS | |
| SetAnimationKeyFPS | |
| GetSelectionType |
Gets the current selection type.
Syntax
object.GetSelectionType() As Variant
Remarks
0 = Object
1 = Face
2 = Point
3 = Edge
Gets the group of the current viewing camera.
Syntax
object.GetCameraGroup() As CanvasGroup
Returns the object face index for an active face. The face index returned can be used as the parameter for the CanvasObject's GetFace method.
Syntax
object.GetActiveFaceObjectIndex(Index as Variant) As Variant
Gets the CanvasGroup object that is the root group of the scene.
Syntax
object.GetRootGroup() As CanvasGroup
Gets the number of CanvasGroup objects in the scene.
Syntax
object.GetGroupCount() As Variant
Gets the specified CanvasGroup object.
Syntax
object.GetGroup(Index As Variant) As CanvasGroup
Creates a CanvasGroup object.
Syntax
object.CreateGroup() As CanvasGroup
Remarks
The group is not added to the scene until it is added as a child to another group using the AddChild method.
Gets the number of active CanvasGroup objects in the Scene
Syntax
object.GetActiveGroupCount() As Variant
Remarks
As of version 6.5 of 3D Canvas there can be multiple active groups.
Gets the specified active CanvasGroup object.
Syntax
object.GetActiveGroup(Index As Variant) As CanvasGroup
Creates a CanvasObject object.
Syntax
object.CreateObject() As CanvasObject
Remarks
The object is not added to the scene until it is added to a group using the AddObject method.
Gets the number of active CanvasObject objects in the scene.
Syntax
object.GetActiveObjectCount() As Variant
Remarks
As of version 6.5 of 3D Canvas there can be multiple active objects.
Gets the specified active CanvasObject object.
Syntax
object.GetActiveObject(Index As Variant) As CanvasObject
Gets the number of CanvasObject objects in the scene.
Syntax
object.GetObjectCount() As Variant
Gets the specified CanvasObject object.
Syntax
object.GetObject(Index As Variant) As CanvasObject
Gets the number of active CanvasFace objects in the scene.
Syntax
object.GetActiveFaceCount() As Variant
Gets the specified active CanvasFace object.
Syntax
object.GetActiveFace(Index As Variant) As CanvasFace
Gets the number of active edges in the active CanvasObject object.
Syntax
object.GetActiveEdgeCount() As Variant
Gets the specified active edge.
Syntax
object.GetActiveEdge(Index As Variant,
FaceIndex As Variant,
EdgeIndex As Variant)
Remarks
FaceIndex refers to a specific face in the active CanvasObject object. EdgeIndex refers to the first point in the edge.
Gets the number of active points in the active CanvasObject object.
Syntax
object.GetActivePointCount() As Variant
Gets the specified active point in the active CanvasObject object.
Syntax
object.GetActivePoint(Index As Variant) As Variant
Gets the number of points in the scene.
Syntax
object.GetPointCount() As Variant
Gets the number of CanvasFace objects in the scene.
Syntax
object.GetFaceCount() As Variant
Gets the scene's bounding box.
Syntax
object.GetBoundingBox(MinX As Variant,
MinY As Variant,
MinZ As Variant,
MaxX As Variant,
MaxY As Variant,
MaxZ As Variant)
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
Creates a CanvasMaterial object. This material will be filled in with the current material from 3D Canvas' Material Palette. You may change these material parameters programmatically.
Syntax
object.CreateMaterial() As CanvasMaterial
Gets the number of animation key-frames in the scene.
Syntax
object.GetAnimationKeyFrameCount() As Variant
Sets the number of animation key-frames in the scene.
Syntax
object.SetAnimationKeyFrameCount(AnimationKeyFrameCount As Variant)
Gets the number of animation key-frames per second for the scene.
Syntax
object.GetAnimationKeyFPS() As Variant
Sets the number of animation key-frames per second for the scene.
Syntax
object.SetAnimationKeyFPS(AnimationKeyFPS As Variant)