PropOptions
Package: com.eegeo.mapapi.props
Defines creation parameters for a Prop.
Constructors
PropOptions()
Default constructor for prop creation parameters.
Methods
PropOptions position(LatLng position)
Set the position where prop will be drawn.
Returns: The PropOptions object on which the method was called, with the new position set.
| Type | argument | Description |
|---|---|---|
| LatLng | position | The position for the prop |
PropOptions elevation(double elevation)
Sets the elevation for the prop. If this method is not called, PropOptions will be initialised to create a Prop with an elevation of 0.
Returns: The PropOptions object on which the method was called, with the new elevation set.
| Type | argument | Description |
|---|---|---|
| double | elevation | The elevation, in meters. |
PropOptions elevationMode(ElevationMode elevationMode)
Sets the ElevationMode for the prop. If this method is not called, PropOptions will be initialised to create a Prop with ElevationMode.HeightAboveGround.
Returns: The PropOptions object on which the method was called, with the new elevation mode set.
| Type | argument | Description |
|---|---|---|
| ElevationMode | elevationMode | The ElevationMode used to interpret the elevation of the prop. |
PropOptions headingDegrees(double headingDegrees)
Set the heading of the prop. If this method is not called, PropOptions will be initialised to create a Prop with a heading of 0 degrees (pointing North).
Returns: The PropOptions object on which the method was called, with the new heading set.
| Type | argument | Description |
|---|---|---|
| double | headingDegrees | The heading, in degrees, clockwise, with 0 degrees pointing North. |
PropOptions geometryId(String geometryId)
Set the id of the geometry to be rendered in the location specified by the prop. If this method is not called, PropOptions will be initialised to create a Prop with an empty geometry Id, which will be invisible.
Returns: The PropOptions object on which the method was called, with the new heading set.
| Type | argument | Description |
|---|---|---|
| String | geometryId | the name of the geometry to be rendered. Available geometry is currently curated by WRLD, please get in touch via support@wrld3d.com to discuss additions. |
PropOptions indoor(String indoorMapId, int indoorFloorId)
Sets the indoor map properties for the prop. At present, the prop will not display if this method is not called, although functionality may be expanded in future to include outdoor props.
Returns: The PropOptions object on which the method was called, with the new indoor map properties set.
| Type | argument | Description |
|---|---|---|
| String | indoorMapId | The identifier of the indoor map on which the prop should be displayed. |
| int | indoorFloorId | The identifier of the indoor map floor on which the prop should be displayed. In the WRLD Indoor Map Format, this corresponds to the ‘z_order’ field of the Level object. |
PropOptions name(String name)
Sets the name to be assigned to the prop created with these parameters, this should be unique.
Returns: The PropOptions object on which the method was called, with the new name set.
| Type | argument | Description |
|---|---|---|
| String | name | the name to be assigned to the prop |
double getElevation()
Returns the elevation set for this PropOptions object.
Returns: A height, in meters.
ElevationMode getElevationMode()
Returns the elevation mode set for this PropOptions object.
Returns: The ElevationMode, indicating how elevation is interpreted.
String getIndoorMapId()
Returns the indoor map identifier for this PropOptions object.
Returns: A string containing the indoor map identifier.
int getIndoorFloorId()
Returns the indoor map floor identifier for this PropOptions object.
Returns: The indoor map floor id.
String getName()
Returns the name which the created prop will be assigned, this should be unique.
Returns: The name that will be assigned to the created prop.
LatLng getPosition()
Returns the position at which the prop will be displayed.
Returns: A LatLng object representing the prop’s position.
double getHeadingDegrees()
Returns The heading indicating the direction in which the prop will face, in degrees, clockwise from North (0 degrees).
Returns: The heading in degrees.
String getGeometryId()
Returns the geometry identifier for this PropOptions object.
Returns: A string containing id of the geometry that will be displayed for this prop.