class Gameboard (Niantic.ARDK.Extensions.Gameboard.Gameboard)

Overview

class Gameboard: Niantic.ARDK.Extensions.Gameboard.IGameboard {
public:
    // properties

    float Area;
    ModelSettings Settings;

    // events

    event GameboardDestroyed();
    event GameboardUpdated();

    // methods

    bool CalculatePath(
        Vector3 fromPosition,
        Vector3 toPosition,
        AgentConfiguration agent,
        out Path path
    );

    bool CheckFit(Vector3 center, float size);
    void Clear();
    void Destroy();

    bool FindNearestFreePosition(
        Vector3 sourcePosition,
        float range,
        out Vector3 nearestPosition
    );

    bool FindNearestFreePosition(
        Vector3 sourcePosition,
        out Vector3 nearestPosition
    );

    bool FindRandomPosition(out Vector3 randomPosition);

    bool FindRandomPosition(
        Vector3 sourcePosition,
        float range,
        out Vector3 randomPosition
    );

    Gameboard(ModelSettings settings, bool visualise);
    bool IsOnGameboard(Vector3 position, float delta);
    void Prune(Vector3 keepNodesOrigin, float range);
    bool RayCast(Ray ray, out Vector3 hitPoint);
    void Scan(Vector3 origin, float range);
    void SetVisualisationActive(bool active);
};

Inherited Members

public:
    // properties

    float Area;
    ModelSettings Settings;

    // events

    event GameboardDestroyed();
    event GameboardUpdated();

    // methods

    bool CalculatePath(
        Vector3 fromPosition,
        Vector3 toPosition,
        AgentConfiguration agent,
        out Path path
    );

    bool CheckFit(Vector3 center, float size);
    void Clear();
    void Destroy();

    bool FindNearestFreePosition(
        Vector3 sourcePosition,
        float range,
        out Vector3 nearestPosition
    );

    bool FindNearestFreePosition(
        Vector3 sourcePosition,
        out Vector3 nearestPosition
    );

    bool FindRandomPosition(out Vector3 randomPosition);

    bool FindRandomPosition(
        Vector3 sourcePosition,
        float range,
        out Vector3 randomPosition
    );

    bool IsOnGameboard(Vector3 position, float delta);
    void Prune(Vector3 keepNodesOrigin, float range);
    bool RayCast(Ray ray, out Vector3 hitPoint);
    void Scan(Vector3 origin, float range);
    void SetVisualisationActive(bool active);

Detailed Documentation

Properties

float Area

The discovered free area in square meters.

ModelSettings Settings

The configuration of the GameboardModel.

Methods

void Clear()

Removes all surfaces from the Gameboard.

Gameboard(ModelSettings settings, bool visualise)

Allocates a new Gameboard.

Parameters:

settings	Settings to calibrate unoccupied area detection.
visualise	Activate visualisation.