PositionerApi (Class)

Namespace: Wrld.Space.Positioners

An API to create and receive change notification for Positioner instances.

Methods

Positioner CreatePositioner (PositionerOptions positionerOptions)

Creates an instance of a Positioner.

Argument Type Description
positionerOptions PositionerOptions The PositionerOptions object which defines creation parameters for this Positioner.

Events

PositionerChangedHandler OnPositionerTransformedPointChanged

Notification that the resultant point of a Positioner has changed. This may be due to the input data model of this Positioner changing (for example, by calling SetLocation); or it maybe due to a change to one of the components on which the resultant point depends - for example, if the terrain map tile that contains the LatLong location has streamed in, causing the Positioner’s height above ground to be updated. An app may hook to this event in order to respond to a change to a Positioner by accessing the updated resultant point via Positioner.TryGetECEFLocation or Positioner.TryGetLatLongAltitude.

PositionerChangedHandler OnPositionerScreenPointChanged

Notification that the screen projection of the resultant point of a Positioner has changed. This may be raised every frame due to the camera view changing. An app may hook to this event in order to respond to a change to a Positioner by accessing the updated resultant projected screen-space point via Positioner.TryGetScreenPoint.

Delegates

void PositionerChangedHandler (Positioner positioner)

A delegate type for event handlers receiving notification that a Positioner has changed.

Argument Type Description
positioner Positioner The Positioner instance that has changed.
v0.8.17