Interface TrackedPointComponent

Description

Allows you to bind the position and rotation of an object with this component to a TrackedPoint.

interface TrackedPointComponent {
    enabled: boolean;
    isValid: boolean;
    trackedPoint: TrackedPoint;
    uniqueIdentifier: string;
    destroy(): void;
    getSceneObject(): SceneObject;
    getTransform(): Transform;
    getTypeName(): string;
    isOfType(type): boolean;
    isSame(other): boolean;
}

Hierarchy (view full)

Properties

enabled isValid trackedPoint uniqueIdentifier

Methods

destroy getSceneObject getTransform getTypeName isOfType isSame

Properties

enabled

enabled: boolean

Description

If disabled, the Component will stop enacting its behavior.

Readonly isValid

isValid: boolean

Description

Returns whether the trackedPoint is valid.

trackedPoint

trackedPoint: TrackedPoint

Description

The TrackedPoint which this component will copy the position and rotation from.

Readonly uniqueIdentifier

uniqueIdentifier: string

Methods

destroy

  • destroy(): void

  • Returns void

    Description

    Destroys the component.

getSceneObject

getTransform

getTypeName

  • getTypeName(): string

  • Returns string

    Description

    Returns the name of this object's type.

isOfType

  • isOfType(type): boolean

  • Parameters

    • type: string

    Returns boolean

    Description

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

isSame

  • isSame(other): boolean

  • Parameters

    Returns boolean

    Description

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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc