Component: Pointer

The TutorialPointer component is used to simply point at objects on the scene.

The API is simple; the pointer simply takes the position where it should be pointing at, and in which direction. Scale can optionally be overridden as well. Then it passes the request through its own configurable pipeline - if configured - to calculate the final request.

The pointer component provides configuration for Transform Modification Pipeline. You can configure all the pipeline actions you want applied globally to this pointer here.

The components sending a pointing request to the pointer typically have their own pipelines. The pointing request is crafted by those pipelines first, and then is passed through the global pointer pipeline to calculate the final transform of the pointer.

TutorialPointer

Member Parameters Description
State - Gets the current state of the pointer i.e. the last request.
Point TutorialPointRequest Points the pointer at the given position in the given direction with the given scale.
SetVisibility bool Shows/hides the pointer.

TutorialPointRequest

Member Description
Visible Whether the pointer should be visible or not.
BaseTransform The target transform we're pointing at (optional)
TargetPosition The position where the pointer should be pointing at.
TargetRotation The rotation from the forward direction (0, 0, 1) to the direction in which the pointer should be pointing at.
TargetScale The scale of the pointer.