class MAGES::Recorder::TransformCaptureGroup

Overview

A utility class that helps with capturing transformation changes in Gameobjects. More…

class TransformCaptureGroup
{
public:
    // enums

    enum CaptureMethod;

    // classes

    class CapturedObject;

    // methods

    void Remove(GameObject gameObject);
    void Clear();

    void Add(
        GameObject gameObject,
        CaptureMethod flags = CaptureMethod.PositionRotation,
        string varName = null
    );

    void AddUnsafe(
        GameObject gameObject,
        CaptureMethod flags = CaptureMethod.PositionRotation,
        string varName = null
    );

    void Poll(System.Action<ICapturedEvent> sendEvent, long frame, double timestamp);
};

Detailed Documentation

A utility class that helps with capturing transformation changes in Gameobjects.

Methods

void Remove(GameObject gameObject)

Removes a GameObject from the capture group.

Parameters:

gameObject

The game object to remove.

void Clear()

Clears the capture group of any objects contained inside.

void Add(
    GameObject gameObject,
    CaptureMethod flags = CaptureMethod.PositionRotation,
    string varName = null
)

Adds a GameObject to the capture group.

Parameters:

gameObject

The game object.

flags

The capture method flags (optional).

varName

The variable name (optional).

void AddUnsafe(
    GameObject gameObject,
    CaptureMethod flags = CaptureMethod.PositionRotation,
    string varName = null
)

Adds a GameObject to the capture group without doing any checks for validity.

Parameters:

gameObject

The game object.

flags

The capture method flags (optional).

varName

The variable name (optional).

void Poll(System.Action<ICapturedEvent> sendEvent, long frame, double timestamp)

Polls for changes in all captured objects.

Parameters:

sendEvent

The event sender.

frame

The current frame.

timestamp

The current timestamp.