class MAGES::AR::ARSubModule¶

Overview¶

A SubModule responsible for handling the switch to AR and back. More…

class ARSubModule: public MAGES::SubModule
{
public:
    // properties

    UnityEvent AREnabled;
    UnityEvent ARDisabled;
    bool IsEnabled;

    // methods

    void RegisterObjectToRemove(GameObject go);
    void DeregisterObjectToRemove(GameObject go);
    void SetEnabled(bool enable);
    void SetARSessionObject(GameObject go);
    override void Shutdown();
    override void Startup();
};

Inherited Members¶

public:
    // properties

    int Version;

    // methods

    void Startup();
    void Shutdown();
    virtual void UpdateModule(UpdatePhase updatePhase);

Detailed Documentation¶

A SubModule responsible for handling the switch to AR and back.

Properties¶

UnityEvent AREnabled

Gets or sets the Event raised when AR is enabled.

UnityEvent ARDisabled

Gets or sets the Event raised when AR is disabled.

bool IsEnabled

Gets a value indicating whether AR is enabled.

Methods¶

void RegisterObjectToRemove(GameObject go)

Parameters:

go	The gameobject to be disabled.

void DeregisterObjectToRemove(GameObject go)

Deregister an object to be disabled when AR is enabled.

Parameters:

go	The gameobject to be disabled.

void SetEnabled(bool enable)

Enables/Disables AR.

Parameters:

enable	If true, AR is enabled, else it is disabled.

void SetARSessionObject(GameObject go)

Setup the AR Session GameObject.

Parameters:

go	The AR Session GameObject.