Meta Developers

Pointer Class

Representation of an ongoing interaction between a PointerInteractor<TInteractor, TInteractable> and the PointerInteractable<TInteractor, TInteractable>s at which it points.

Instance of this can be observed and leveraged to add pointer interaction functionality no built into PointableCanvasModule, such as scrolling based on controller thumbsticks.

Properties

int Identifier[Get]

The PointerEvent.Identifier of the PointerEvents which control the state of this Pointer.

Canonically, this will be the same as the IInteractorView.Identifier of the actuating interactor.

PointerEventData PointerEventData[Get]

Events

Action< PointerEventData > WhenUpdated

Invoked when the Pointer has been updated, exposing the PointerEventData representing what PointableCanvasModule does and knows about this Pointer's behavior.

PointerEventData is exposed here in order to be leveraged in extending functionality, such as scrolling support. However, modifying this data is not supported and can result in unexpected behavior. Rather than modifying this data, consumers should copy relevant information to their own PointerEventData instances and use those to execute events. For similar reasons, references to this PointerEventData should not be cached off or accessed except during the WhenUpdated callback itself.

Action WhenDisposed

Invoked when the pointer is being disposed.

Observers can use this signal to clean up any references or resources they may have retained related to this Pointer.

Did you find this page helpful?