class MAGES::ComponentLibrary::SpatialElement

Overview

Base class for all spatial elements. More…

class SpatialElement: public MonoBehaviour
{
public:
    // enums

    enum SpatialAnchor;

    // properties

    Canvas TopLevelCanvas;
    Vector3 PreferredPosition;
    SpatialAnchor Anchor;
    int LayoutPriority;
    Vector2 WorldSize;
    Vector3 CameraLookDirection;
    Bounds WorldBounds;
    string Group;
    SpatialLayoutSubModule SLM;

    // methods

    virtual void PreLayout();
    virtual void PostLayout();
    virtual void ExecuteUpdate(UpdatePhase phase);
};

// direct descendants

class SpatialLabel;
class SpatialNotificationElement;
class SpatialLoadingDialog;

Detailed Documentation

Base class for all spatial elements.

Properties

Canvas TopLevelCanvas

Gets the top level canvas for this spatial element.

Vector3 PreferredPosition

Gets or sets the preferred position of the element.

SpatialAnchor Anchor

Gets or sets the anchor for the element.

int LayoutPriority

Gets or sets the layout priority.

Vector2 WorldSize

Gets the world size of the element.

string Group

Gets or sets the group.

SpatialLayoutSubModule SLM

Gets the spatial layout sub module.

Methods

virtual void ExecuteUpdate(UpdatePhase phase)

Executes the update phase.

Parameters:

phase

The phase of the update.