Interface Visual

Base class for all visual Components (e.g. MeshVisual).

interface Visual {
    enabled: boolean;
    sceneObject: SceneObject;
    uniqueIdentifier: string;
    destroy(): void;
    getRenderOrder(): number;
    getSceneObject(): SceneObject;
    getTransform(): Transform;
    getTypeName(): string;
    isOfType(type: string): boolean;
    isSame(other: ScriptObject): boolean;
    setRenderOrder(value: number): void;
}

Hierarchy (view full)

Properties

enabled sceneObject uniqueIdentifier

Methods

destroy getRenderOrder getSceneObject getTransform getTypeName isOfType isSame setRenderOrder

Properties

enabled

enabled: boolean

If disabled, the Component will stop enacting its behavior.

ReadonlysceneObject

sceneObject: SceneObject

ReadonlyuniqueIdentifier

uniqueIdentifier: string

Methods

destroy

  • destroy(): void

  • Destroys the component.

    Returns void

getRenderOrder

  • getRenderOrder(): number

  • Returns the order of this Visual in the render queue.

    Returns number

getSceneObject

getTransform

getTypeName

  • getTypeName(): string

  • Returns the name of this object's type.

    Returns string

isOfType

  • isOfType(type): boolean

  • Returns true if the object matches or derives from the passed in type.

    Parameters

    • type: string

    Returns boolean

isSame

  • isSame(other): boolean

  • Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

    Parameters

    Returns boolean

setRenderOrder

  • setRenderOrder(value): void

  • Sets the order of this Visual in the render queue.

    Parameters

    • value: number

    Returns void

Settings

Member Visibility

On This Page

Properties
Methods