CanvasScene Object

The CanvasScene Object represents a 3D Canvas Scene.

Frames CreateFrame
  GetRootFrame
  GetFrameCount
  GetFrame
  GetActiveFrameCount
  GetActiveFrame
Objects CreateObject
  GetObjectCount
  GetObject
  GetActiveObjectCount
  GetActiveObject
  GetActiveFaceCount
  GetActiveFace
  GetActiveEdgeCount
  GetActiveEdge
  GetActivePointCount
  GetActivePoint
Materials CreateMaterial

GetRootFrame

Gets the CanvasFrame object that is the root frame of the scene.

Syntax

object.GetRootFrame() As CanvasFrame

GetFrameCount

Gets the number of CanvasFrame objects in the scene.

Syntax

object.GetFrameCount() As Variant

GetFrame

Gets the specified CanvasFrame object.

Syntax

object.GetFrame(Index As Variant) As CanvasFrame

CreateFrame

Creates a CanvasFrame object.

Syntax

object.CreateFrame() As CanvasFrame

Remarks

The frame is not added to the scene until it is added as a child to another frame using the AddChild method.

GetActiveFrameCount

Gets the number of active CanvasFrame objects in the Scene

Syntax

object.GetActiveFrameCount() As Variant

Remarks

Currently there can be only one active frame.

GetActiveFrame

Gets the specified active CanvasFrame object.

Syntax

object.GetActiveFrame(Index As Variant) As CanvasFrame

CreateObject

Creates a CanvasObject object.

Syntax

object.CreateObject() As CanvasObject

Remarks

The object is not added to the scene until it is added to a frame using the AddObject method.

GetActiveObjectCount

Gets the number of active CanvasObject objects in the scene.

Syntax

object.GetActiveObjectCount() As Variant

Remarks

Currently there can only be one active object.

GetActiveObject

Gets the specified active CanvasObject object.

Syntax

object.GetActiveObject(Index As Variant) As CanvasObject

GetObjectCount

Gets the number of CanvasObject objects in the scene.

Syntax

object.GetObjectCount() As Variant

GetObject

Gets the specified CanvasObject object.

Syntax

object.GetObject(Index As Variant) As CanvasObject

GetActiveFaceCount

Gets the number of active CanvasFace objects in the scene.

Syntax

object.GetActiveFaceCount() As Variant

GetActiveFace

Gets the specified active CanvasFace object.

Syntax

object.GetActiveFace(Index As Variant) As CanvasFace

GetActiveEdgeCount

Gets the number of active edges in the active CanvasObject object.

Syntax

object.GetActiveEdgeCount() As Variant

GetActiveEdge

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.

GetActivePointCount

Gets the number of active points in the active CanvasObject object.

Syntax

object.GetActivePointCount() As Variant

GetActivePoint

Gets the specified active point in the active CanvasObject object.

Syntax

object.GetActivePoint(Index As Variant) As Variant

CreateMaterial

Creates a CanvasMaterial object.

Syntax

object.CreateMaterial() As CanvasMaterial