PositionerOptions (Class)
Namespace: Wrld.Space.Positioners
Defines creation parameters for a Positioner.
Methods
PositionerOptions LatitudeDegrees (double latitudeDegrees)
Sets the latitude for the Positioner.
Returns: This PositionerOptions instance, with the new latitude set.
| Argument | Type | Description |
|---|---|---|
| latitudeDegrees | double | The latitude, in degrees. |
PositionerOptions LongitudeDegrees (double longitudeDegrees)
Sets the longitude for the Positioner.
Returns: This PositionerOptions instance, with the new longitude set.
| Argument | Type | Description |
|---|---|---|
| longitudeDegrees | double | The longitude, in degrees. |
PositionerOptions ElevationAboveGround (double elevation)
Sets the elevation for the Positioner, relative to the altitude of the terrain at the Positioner’s LatLong coordinate.
Returns: This PositionerOptions instance, with the elevation set.
| Argument | Type | Description |
|---|---|---|
| elevation | double | The elevation, in meters. |
PositionerOptions ElevationAboveSeaLevel (double elevation)
Sets the elevation for the Positioner, relative to sea-level.
Returns: This PositionerOptions instance, with the elevation set.
| Argument | Type | Description |
|---|---|---|
| elevation | double | The elevation, in meters. |
PositionerOptions IndoorMap (String indoorMapId)
Sets the indoor map for the Positioner. If this method is not called, or if indoorMapId is an empty string, PositionerOptions is initialized to create a positioner for display on an outdoor map. As a side-effect, the resultant Positioner object created with these options will treat the indoorMapFloorId parameter of Positioner.SetIndoorMap(string indoorMapId, int indoorMapFloorId) as an index into the zero-based array of floors for the specified indoor map. This method is retained for legacy compatibility reasons only, please use IndoorMapWithFloorId instead.
Returns: This PositionerOptions instance, with the Indoor Map Id set.
| Argument | Type | Description |
|---|---|---|
| indoorMapId | String | The identifier of the indoor map on which the Positioner should be displayed. |
PositionerOptions IndoorMapWithFloorId (String indoorMapId, int indoorMapFloorId)
Sets the indoor map properties for the positioner. If this method is not called, or if indoorMapId is an empty string, PositionerOptions is initialized to create a positioner for display on an outdoor map.
Returns: This PositionerOptions instance, with the new indoor map properties set.
| Argument | Type | Description |
|---|---|---|
| indoorMapId | String | The identifier of the indoor map on which the Positioner should be displayed. |
| indoorMapFloorId | int | The identifier of the indoor map floor on which the Positioner should be displayed. In the WRLD Indoor Map Format, this corresponds to the ‘z_order’ field of the Level object. |