MPBuilding Class Reference

#include <MPBuilding.h>

Inheritance diagram for MPBuilding:

Instance Methods
(nullable MPFloor *)	- getFloor
(nullable NSNumber *)	- getInitFloor
(nullable NSNumber *)	- getFloors
(nullable NSArray< MPFloor * > *)	- getFloorArray
(void)	- setFloor:
(void)	- showBuilding:onMap:
(void)	- updateBuildingTiles
(void)	- hideBuilding
(nullable GMSCoordinateBounds *)	- getBuildingBounds

Properties
NSNumber *	currentFloor
id< MPBuildingDelegate >	delegate
GMSMapView *	map
NSNumber *	floorsReady
NSString *	externalId
NSString *	buildingId
	Get building id.
NSString *	address
	Get building address.
NSString *	administrativeId
	Get building administrative id.
NSMutableDictionary< NSString *, MPFloor * >< MPFloor > *	floors
	Get building floors.
NSString *	name
	Get building name.
MPPoint *	anchor
	Get building anchor coordinate.
NSArray< NSArray * > *	bounds
	Get building bounds.
NSString *	venueId
NSNumber *	defaultFloor
NSDictionary< NSString *, MPLocationField * >< MPLocationField > *	fields

Detailed Description

Holds relevant data for a single building, and the buildings floor levels.

Method Documentation

getBuildingBounds

- (nullable GMSCoordinateBounds *) getBuildingBounds

Get the geographic bounds for the building

getFloor

- (nullable MPFloor *) getFloor

Get the current floor.

getFloorArray

- (nullable NSArray< MPFloor * > *) getFloorArray

Get the floors as an array of MPFloor.

getFloors

- (nullable NSNumber *) getFloors

Get the number of floors.

getInitFloor

- (nullable NSNumber *) getInitFloor

Get the initial/default floor upon creation.

hideBuilding

- (void) hideBuilding

Hide the building from the map.

setFloor:

- (void) setFloor:

(nullable NSNumber *)

floor

Set the current floor property (without affecting the building display).

Parameters

floor

The floor number to replace current floor with.

showBuilding:onMap:

- (void) showBuilding:		(nullable NSNumber *)	newFloor
onMap:		(nullable GMSMapView *)	map

Use this method to actually shift floor and show the building level.

Parameters

newFloor	The floor number that represents the building level.
map	Affected map.

updateBuildingTiles

- (void) updateBuildingTiles

Updates the current floor tile layer by clearing the tile cache.

Property Documentation

address

- (NSString*) address

readwritenonatomicstrong

Get building address.

administrativeId

- (NSString*) administrativeId

readwritenonatomicstrong

Get building administrative id.

anchor

- (MPPoint*) anchor

readwritenonatomicstrong

Get building anchor coordinate.

bounds

- (NSArray<NSArray*>*) bounds

readwritenonatomicstrong

Get building bounds.

buildingId

- (NSString*) buildingId

readwritenonatomicstrong

Get building id.

currentFloor

- (NSNumber*) currentFloor

readwritenonatomicstrong

Holds the current floor.

defaultFloor

- (NSNumber*) defaultFloor

readnonatomicstrong

Get the buildings default floor. Is used by MPMapControl to determine which floor to show if a user have not already selected a floor.

delegate

- (id<MPBuildingDelegate>) delegate

readwritenonatomicweak

Delegate that holds the building ready event method. Relevant when using offline mode, as it will take a while to load the database upon first app start.

externalId

- (NSString*) externalId

readwritenonatomicstrong

External id.

fields

- (NSDictionary<NSString*, MPLocationField*><MPLocationField> *) fields

readnonatomicstrong

Dictionary of custom fields

floors

- (NSMutableDictionary<NSString*, MPFloor*><MPFloor> *) floors

readwritenonatomicstrong

Get building floors.

floorsReady

- (NSNumber*) floorsReady

readwritenonatomicstrong

Simple counter that keeps track of how many floors and related tile layers are ready.

map

- (GMSMapView*) map

readwritenonatomicweak

Reference to the map. The reference is used to activate/deactivate tile layers.

name

- (NSString*) name

readwritenonatomicstrong

Get building name.

venueId

- (NSString*) venueId

readnonatomicstrong

Venue id