WRLDProp Class Reference

A Prop is a 3d mesh, placed on or above the map.

+ propWithName:geometryId:location:indoorMapId:indoorMapFloorId:elevation:elevationMode:headingDegrees:

+ (instancetype)propWithName:(NSString *)name geometryId:(NSString *)geometryId location:(CLLocationCoordinate2D)location indoorMapId:(NSString *)indoorMapId indoorMapFloorId:(int)indoorMapFloorId elevation:(CLLocationDistance)elevation elevationMode:(WRLDElevationMode)elevationMode headingDegrees:(double)headingDegrees

Instantiate a prop.

Returns:

A WRLDProp instance.

Argument Description
name

The name assigned to this prop - this should be unique.

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.

location

The location for the prop

indoorMapId

The id of the indoor map the prop will be displayed on

indoorMapFloorId

The id of the floor of the indoor map on which to display the prop

elevation

The elevation of the prop, in metres above ground of sea-level, depending on the value of elevationMode

elevationMode

Specifies how the elevation property of this prop is interpreted

headingDegrees

The direction in which the prop should face, in degrees, clockwise from North (0 degrees)

+ propWithName:geometryId:location:indoorMapId:indoorMapFloorId:

+ (instancetype)propWithName:(NSString *)name geometryId:(NSString *)geometryId location:(CLLocationCoordinate2D)location indoorMapId:(NSString *)indoorMapId indoorMapFloorId:(int)indoorMapFloorId

Instantiate a prop.

Returns:

A WRLDProp instance, with default elevation (0), elevation Mode (height above ground) and heading (0 degrees, pointing North).

Argument Description
name

The name assigned to this prop - this should be unique.

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.

location

The location for the prop

indoorMapId

The id of the indoor map the prop will be displayed on

indoorMapFloorId

The id of the floor of the indoor map on which to display the prop

@property name

@property (nonatomic, readonly) NSString *name

The name assigned to the prop, this should be unique.

@property geometryId

@property (nonatomic, copy) NSString *geometryId

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

@property location

@property (nonatomic) CLLocationCoordinate2D location

The height of the prop above either the ground, or sea-level, depending on the elevationMode property.

@property indoorMapId

@property (nonatomic, readonly) NSString *indoorMapId

The id of the indoor map on which to display the prop.

@property indoorFloorId

@property (nonatomic, readonly) NSInteger indoorFloorId

The floor id of the floor on which the prop will be displayed

@property elevation

@property (nonatomic) CLLocationDistance elevation

The height of the prop above either the ground, or sea-level, depending on the elevationMode property.

@property elevationMode

@property (nonatomic) WRLDElevationMode elevationMode

Specifies how the elevation property of this prop is interpreted:

  • WRLDElevationModeHeightAboveSeaLevel: The elevation is an absolute altitude above mean sea level, in meters.
  • WRLDElevationModeHeightAboveGround: The elevation is a height relative to the map’s terrain, in meters.

@property headingDegrees

@property (nonatomic) double headingDegrees

An angle in degrees, clockwise from North (0 degrees) specifying the direction in which the prop faces.

v0.0.1235