Preparing search index...

    Renders a 3D model to visualize an Interactor's ray, connecting the Interactor's origin to the target cursor position. Its length and opacity is driven by the state of a corresponding InteractorCursor.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    _interactor?: BaseInteractor

    Reference to the Interactor component that this ray will visualize.

    api: Record<string, any>

    Generic object accessible by other instances of ScriptComponent. Use this object to store references to properties and methods that need to be accessible from other ScriptComponents.

    This property is no longer needed, you can use a reference to the ScriptComponent, including 'script', directly

    A reference to the InteractorCursor that controls this ray's endpoint and opacity. This is typically set by the CursorController.

    enabled: boolean

    If disabled, the Component will stop enacting its behavior.

    isEnabledInHierarchy: boolean

    Returns true if this Component, its SceneObject, and all of that SceneObjects parents are enabled.

    name: string
    sceneObject: SceneObject

    The SceneObject this component is on.

    uniqueIdentifier: string
    updatePriority: number

    Accessors

    • get isTriggering(): boolean

      Returns if the ray is in a triggered state.

      Returns boolean

    • set isTriggering(triggering: boolean): void

      Sets if the ray should reflect a triggered state.

      Parameters

      • triggering: boolean

      Returns void

    • get rayMaterial(): Material

      The Material used to render the ray model.

      Returns Material

    • set rayMaterial(material: Material): void

      The Material used to render the ray model. Cloning the material ensures that opacity changes do not affect other objects using the same source material.

      Parameters

      Returns void

    Methods

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

      Parameters

      • type: string

      Returns boolean

    • Returns void

    • Clean up.

      Returns void

    • Returns void