Interface InstructionApiInterface

Use the InstructionApiInterface to access methods which allow you to move to instruction and to get the position (in site coordinates) and floor of the instruction.

interface InstructionApiInterface {
    floor: SiteModelEntityInterface;
    position: Vector3;
    text: string;
    type: InstructionType;
    moveToInstruction(): Promise<void>;
}

Properties

floor position text type

Methods

moveToInstruction

Properties

Readonly floor

floor: SiteModelEntityInterface

Return the floor of the instruction.

Readonly position

position: Vector3

Return the position (site coordinate) of the instruction.

Readonly text

text: string

Return the text of the instruction.

Readonly type

type: InstructionType

The type of the instruction.

Methods

moveToInstruction

  • moveToInstruction(): Promise<void>

  • Move the camera to the instruction.

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc