class MAGES::ComponentLibrary::Framework::Rig¶

Overview¶

Represents a rig. Contains references to the player’s head, hands, and body. More…

class Rig: public MonoBehaviour
{
public:
    // properties

    Transform RootTransform;
    Transform HeadPoint;
    Camera HeadCamera;
    Transform LeftControllerPoint;
    Transform RightControllerPoint;

    // methods

    static Rig SpawnEmptyRig();
    static Rig ConvertToRig(Camera cam, float cameraHeight = 1.7f);
};

Detailed Documentation¶

Represents a rig. Contains references to the player’s head, hands, and body.

Properties¶

Transform RootTransform

Gets the root transform of the rig.

Transform HeadPoint

Gets or sets the head.

Camera HeadCamera

Gets or sets the head camera.

Transform LeftControllerPoint

Gets the left controller point.

Transform RightControllerPoint

Gets the right controller point.

Methods¶

static Rig SpawnEmptyRig()

Spawns and returns an empty (only with the required components) rig.

Returns:

The spawned rig.

static Rig ConvertToRig(Camera cam, float cameraHeight = 1.7f)

Tries to build a rig around the given camera.

Parameters:

Returns:

The rig.