Prop (Class)

Namespace: Wrld.Resources.Props

A Prop is a 3d mesh, which can be displayed in an indoor map with a given position and orientation. It may be picked, colored, have its geometry changed, or be moved around the map.

Methods

void SetPosition (LatLong position)

Set the explicit latitude and longitude coordinates of this Prop.

Argument Type Description
position LatLong The position as a LatLong.

LatLong GetPosition ()

Get the explicitly-set latitude and longitude coordinates of this Prop.

Returns: The position as a LatLong.

void SetElevation (double elevation)

Set the elevation of this Prop, in meters. The behavior of this depends on the ElevationMode.

Argument Type Description
elevation double The elevation, in meters.

double GetElevation ()

Get the elevation of this Prop, in meters.

Returns: The elevation of this Prop, in meters.

void SetElevationMode (ElevationMode elevationMode)

Set the ElevationMode of this Prop. See the ElevationMode documentation for more details.

Argument Type Description
elevationMode ElevationMode The ElevationMode of this prop.

ElevationMode GetElevationMode ()

Get the ElevationMode of this Prop.

Returns: The ElevationMode of this Prop.

void SetHeadingDegrees (double headingDegrees)

Sets the heading of the prop, in degrees, clockwise from North (0 degrees).

Argument Type Description
headingDegrees double The heading of this prop in degrees.

double GetHeadingDegrees ()

Gets the heading of the prop, in degrees, clockwise from North (0 degrees).

Returns: The heading of this prop in degrees.

String GetIndoorMapId ()

Get the Indoor Map Id string of this Prop.

Returns: The Indoor Map Id, as a string.

int GetIndoorMapFloorId ()

Get the Indoor Map Floor Id of this Prop.

Returns: The Indoor Map Floor Id of this Prop.

String GetGeometryId ()

Get the geometry Id for this prop - this identifies the 3d model that we want to render in the location described by the prop. Available geometry is currently curated by WRLD - please contact support@wrld3d.com for information about adding new models.

Returns: The id of the geometry to be rendered in the prop’s location

void SetGeometryId (String geometryId)

Set the geometry id for this prop - this identifies the 3d model that we want to render in the location described by the prop. Available geometry is currently curated by WRLD - please contact support@wrld3d.com for information about adding new models.

Argument Type Description
geometryId String The id of the geometry to be rendered in the prop’s location

String GetName ()

Get the name which was assigned to this prop on creation - this should be unique.

Returns: The prop’s name, as a string.

void Discard ()

Destroys the Prop.

Properties

int Id

Uniquely identifies this object instance.

int Id { get; private set; } 
v0.8.17