ProtoTwin API
    Preparing search index...

    Class DistanceSensorComponent

    Distance Sensor.

    Detects the distance to the nearest object using a raycast.

    Hierarchy (View Summary)

    Index

    Properties

    entity: Entity

    The entity to which the component is attached.

    Accessors

    • get blockedMaterial(): null | Material

      The material used when the sensor is blocked.

      Returns null | Material

      If null then the initial material of the entity is used.

    • set blockedMaterial(value: null | Material): void

      Parameters

      Returns void

    • get clearedMaterial(): null | Material

      The material used when the sensor is cleared.

      Returns null | Material

      If null then the initial material of the entity is used.

    • set clearedMaterial(value: null | Material): void

      Parameters

      Returns void

    • get direction(): Vec3

      The direction of the detection beam.

      Returns Vec3

    • set direction(value: Vec3): void

      Parameters

      Returns void

    • get distance(): number

      The measured distance to the detected entity.

      Returns number

    • get initialized(): boolean

      Whether the component has been initialized.

      Returns boolean

    • get kinematics(): boolean

      Whether to detect entities with kinematic physics bodies.

      Returns boolean

      This is typically set to false, in order to avoid detecting conveyors or other static parts.

    • set kinematics(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get layer(): string

      The collision layer for the detection beam.

      Returns string

    • set layer(value: string): void

      Parameters

      • value: string

      Returns void

    • get name(): string

      The component name.

      Returns string

    • set name(value: string): void

      Parameters

      • value: string

      Returns void

    • get object(): null | Entity

      The detected entity.

      Returns null | Entity

    • get origin(): Vec3

      The start of the detection beam.

      Returns Vec3

    • set origin(value: Vec3): void

      Parameters

      Returns void

    • get range(): number

      The range of the detection beam.

      Returns number

    • set range(value: number): void

      Parameters

      • value: number

      Returns void

    • get world(): World

      The virtual world to which the owning entity belongs.

      Returns World

    Methods

    • Added function called immediately after the component is attached to an entity.

      Returns void

    • Creates a handle (weak reference) to a trackable object.

      Type Parameters

      Parameters

      • type: TrackableType<T>

        The type of object that is to be referenced.

      • value: null | T = null

        The object that is initially referenced by the handle.

      Returns Handle<T>

      A handle to a trackable object.

      Handles created through this function are automatically cleared when the component is detached/removed.

    • Asynchronous initialization function called immediately before simulating when the model is initialized.

      Returns Promise<void>

    • Asynchronous post-update function called after physics has been updated.

      Parameters

      • dt: number

        The timestep (seconds).

      Returns Promise<void>

    • Removed function called immediately after the component is detached from an entity.

      Returns void

    • Immediately triggers asynchronous initialization if the component hasn't already been initialized.

      Returns Promise<void>

      This can be used in cases where one component references another in its asynchronous initialize function, but it is required that the referenced component has already been asynchronously initialized.

    • Immediately triggers initialization if the component hasn't already been initialized.

      Returns void

      This can be used in cases where one component references another in its initialize function, but it is required that the referenced component has already been initialized.

    • Subscribes to a subscribable object.

      Subscriptions created through this function are automatically unsubscribed when the component is detached/removed.

      Type Parameters

      • T

      Parameters

      • object: Subscribable<T>

        The subscribable object for which to subscribe.

      • subscriber: Subscriber<T>

        The callback function that is triggered when the object's value is updated.

      Returns void

    • Unsubscribes from a subscribable object.

      Type Parameters

      • T

      Parameters

      • object: Subscribable<T>

        The object from which to unsubscribe.

      • subscriber: Subscriber<T>

        The callback function for the subscription.

      Returns boolean

      True if the subscription was canceled, false otherwise.

    • Update function called every timestep when simulating.

      Parameters

      • dt: number

        The timestep (seconds).

      Returns void

    • Asynchronous update function called every timestep when simulating.

      Parameters

      • dt: number

        The timestep (seconds).

      Returns Promise<void>