IndoorMapsApi (Class)

Namespace: Wrld.Resources.IndoorMaps

API points for interaction with Indoor maps

Methods

void EnterIndoorMap (String)

Try to enter the indoor map with the given ID.

Argument Type Description
indoorMapId String This is the ID of the desired indoor map.

void ExitIndoorMap ()

Exit the current indoor map.

void ExpandIndoor ()

Show the expanded indoor map view.

void CollapseIndoor ()

Show the collapsed indoor map view.

IndoorMap GetActiveIndoorMap ()

Gets the active indoor map.

Returns: The active indoor map, or null if no indoor map is active.

int GetCurrentFloorId ()

Gets the active floor of the current indoor map.

Returns: The index of the active floor of the current indoor map, or -1 if no indoor map is active.

void SetCurrentFloorId (int)

Sets the current floor shown in an indoor map.

Argument Type Description
floorId int The ID of the floor to be selected. This should match an element of the array returned by IndoorMap.FloorIds

void MoveUpFloor (int)

Moves up a number of floors in the current indoor map.

Argument Type Description
numberOfFloors int The number of floors to move up.

void MoveDownFloor (int)

Moves down a number of floors in the current indoor map.

Argument Type Description
numberOfFloors int The number of floors to move down

void SetIndoorFloorInterpolation (float)

Sets the interpolation value used in the expanded indoor view.

Argument Type Description
dragParameter float The float value, in the range 0 .. number of floors - 1

void SetIndoorEntityHighlights (String[], Color, String)

Highlights one or more indoor entities.

Argument Type Description
ids String[] The IDs of the entities.
color Color The color of the highlight.
indoorId String The ID of the indoor map which contains the entity ids. (Optional, the active indoor map will be used if no id is supplied)

void SetIndoorEntityHighlight (String, Color, String)

Highlights a single indoor entity.

Argument Type Description
id String The ID of the entity.
color Color The color of the highlight.
indoorId String The ID of the indoor map which contains the entity ids. (Optional, the active indoor map will be used if no id is supplied)

void ClearIndoorEntityHighlights (String[], String)

Clears the highlights from one or more indoor entities. If no ids are specified then all highlighted entities will be cleared.

Argument Type Description
ids String[] The IDs of the entities.
indoorId String The ID of the indoor map which contains the entity ids. (Optional, the active indoor map will be used if no id is supplied)

void ClearIndoorEntityHighlight (String, String)

Clears the highlights from a single indoor entity.

Argument Type Description
id String The ID of the entity.
indoorId String The ID of the indoor map which contains the entity ids. (Optional, the active indoor map will be used if no id is supplied)

Properties

IIndoorMapMaterialFactory IndoorMapMaterialFactory

The factory that will be used when creating materials for interiors. This can be replaced to allow the interior materials to be customized.

IIndoorMapMaterialFactory IndoorMapMaterialFactory { get; set; } 

IIndoorMapTextureFetcher IndoorMapTextureFetcher

The texture fetcher that will be used when creating materials for interiors. This can be replaced to allow the interior materials to be customized.

IIndoorMapTextureFetcher IndoorMapTextureFetcher { get; set; } 

Events

Action OnIndoorMapEntered

This event is raised to notify users when an indoor map has been entered.

Action OnIndoorMapExited

This event is raised to notify users when an indoor map has been exited.

Action<​int​> OnIndoorMapFloorChanged

Users may subscribe to this event for notification when an indoor map’s floor is changed. The id of the newly selected floor will be passed to subscribers.

Action<​String​> OnIndoorMapEntityClicked

Deprecated: As more than one entity may be in the path of the ray generated by a click, this event has been deprecated in favor of OnIndoorMapEntitiesClicked. Raised whenever an indoor map entity is clicked. The subscriber is passed the id of the selected entity.

Action<​IndoorMapEntitiesClicked​> OnIndoorMapEntitiesClicked

Raised whenever one or more indoor map entities are clicked, with details of the clicked entities being passed to handlers via an IndoorMapEntitiesClicked object.