Wayfinder Floor Database Class
Floors or Maps (interchangable name) represent a single level or floor within the entire project.
his class inherits and therefore includes all the methods and functions defined the standard wayfinder database base class. This class provides the following static properties:
|
StatusNotLoaded |
property |
A number representing the status of floor, in this case, the floor hasn't started loading yet. |
|
StatusLoading |
property |
A number representing the status of floor, in this case, the floor has started to load. |
|
StatusLoadError |
property |
A number representing the status of floor, in this case, the floor encountered an error during loading and so cannot be displayed. |
|
StatusLoadReady |
property |
A number representing the status of floor, in this case, the floor has successfully loaded and is ready to be displayed. |
and exports the following functions:
|
getFloorStatus(floorId) |
function |
Returns one of the above status codes representing the status of the specified map, or null, if the map was not found. |
|
getFloorBounds(floorId) |
function |
Returns a Wayfinder Bounds object containing the bounding box/cube for the specified map, or null if the map was not found. |
|
inBuilding(id) |
function |
Returns an instance of WayfinderFloorDatabase that only contains the maps that exist within the specified build ID. |
|
getActiveBounds(floorId) |
function |
Gets the active bounds for the floor, if they don't exist they are calculated (returns null if they don't exist) |
|
getFloorAverageDestinationSize(floorId) |
function |
Calculates the average size of destinations on a given floor or null if the floor does not exist or has no destinations. Returns an object with |
Each record in the WayfinderFloorDatabase contains the following properties and functions: