Skip to content

Latest commit

 

History

History
65 lines (33 loc) · 3.11 KB

API.md

File metadata and controls

65 lines (33 loc) · 3.11 KB

World mapping classes:

The supplementary class that is used as a root to all MapSegment classes and also stores references to them. Every new MapSegment should be attached to the ARWorldBase class.

The class that is used to define segments of the target area. All FloatingIcon , Room, and Vertex classes that are located in this segment should be attached to it.

The fundamental class that represents a single vertex used for building navigation paths in the target area.

The class represents a floating icon that can be used to highlight points of interest.

The class that represents a single room in the target area. It can be literally a room or just a small sub-area.

Supplementary classes:

The class is responsible for rendering the 2D minimap image.

The supplementary class that stores lists of the possible user's initial positions.

The class which is responsible for building a navigation path from the user's location to destination.

The class which represents a single custom marker.

The class which represents a single arrow used in NavigationPathSpline .

Structs:

CustomMarker

The struct is storing name and location data about a single custom marker placed on the map.

InitialPosition

The struct is storing displayed text and a vertex ID for a single predefined initial position.

InitialPositionPage

The struct is storing an array of InitialPosition structs.

QuickDestinationButton

The struct is storing displayed name, displayed floor and a vertex ID for a single predefined destination.

MainUI

The struct is storing an array of QuickDestinationButton structs.