Class Visual

Base class for all visual Components.

Hierarchy (View Summary, Expand)

Component
- Visual
  - BaseMeshVisual
  - ClearDepth

Index

Constructors

Properties

enabled sceneObject uniqueIdentifier

Methods

destroy getRenderOrder getSceneObject getTransform getTypeName isOfType isSame setRenderOrder

Constructors

`Protected`constructor

new Visual(): Visual
Returns Visual
Overrides Component.constructor

Properties

enabled

enabled: boolean

If disabled, the Component will stop enacting its behavior.

`Readonly`sceneObject

sceneObject: SceneObject

The scene object this component is on.

`Readonly`uniqueIdentifier

uniqueIdentifier: string

Methods

destroy

destroy(): void
Destroys the component.

Returns void
Inherited from Component.destroy

getRenderOrder

getRenderOrder(): number
Returns the order of this Visual in the render queue.

Returns number

getSceneObject

getSceneObject(): SceneObject
Returns the SceneObject the component is attached to.

Returns SceneObject
Inherited from Component.getSceneObject

getTransform

getTransform(): Transform
Returns the Transform this component is attached to.

Returns Transform
Inherited from Component.getTransform

getTypeName

getTypeName(): string
Returns the name of this object's type.

Returns string
Inherited from Component.getTypeName

isOfType

isOfType(type: string): boolean
Returns true if the object matches or derives from the passed in type.
Parameters
- type: string
Returns boolean
Inherited from Component.isOfType

isSame

isSame(other: ScriptObject): boolean
Returns true if this object is the same as other. Useful for checking if two references point to the same thing.
Parameters
- other: ScriptObject
Returns boolean
Inherited from Component.isSame

setRenderOrder

setRenderOrder(value: number): void
Sets the order of this Visual in the render queue.
Parameters
- value: number
Returns void