ProtoTwin API
    Preparing search index...

    Class ColorSensorComponent

    The base type for all components.

    Hierarchy (View Summary)

    Index

    Properties

    entity

    Accessors

    blockedMaterial clearedMaterial color colors deleted direction initialized io name object origin range tolerance world

    Methods

    added? handle initializeAsync? postUpdateAsync? removed requireAsyncInitialization requireInitialization subscribe unsubscribe update? updateAsync?

    Properties

    entity: Entity

    The entity to which the component is attached.

    Accessors

    • get blockedMaterial(): null | Material

      The material used when the sensor is blocked. If blocked is null, then use the initial material of the entity.

      Returns null | Material

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

      Parameters

      Returns void

    • get clearedMaterial(): null | Material

      The material used when the sensor is cleared. If cleared is null, then use the initial material of the entity.

      Returns null | Material

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

      Parameters

      Returns void

    • get color(): number

      The detected color index.

      Returns number

    • get colors(): null | readonly Color[]

      The programmed colors which can be detected.

      Returns null | readonly Color[]

    • set colors(value: null | Color[]): void

      Parameters

      Returns void

    • get direction(): Vec3

      The direction of the detection beam.

      Returns Vec3

    • set direction(value: Vec3): void

      Parameters

      Returns void

    • get initialized(): boolean

      Whether the component has been initialized.

      Returns boolean

    • 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 maximum range for the color sensor.

      Returns number

    • set range(value: number): void

      Parameters

      • value: number

      Returns void

    • get tolerance(): number

      The tolerance used to determine whether a color has been detected.

      Returns number

    • set tolerance(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.

      const handle = this.handle(Entity, this.world.find("Some Entity"));


      const handle = this.handle(MyScriptComponent);

    • 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>

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods