class MAGES::Interaction::LocomotionVignetteSettings¶

Overview¶

The look and timing of a LocomotionVignette. More…

class LocomotionVignetteSettings
{
public:
    // enums

    enum GridAnchoring;

    // properties

    float ApertureAngle;
    float FeatheringAngle;
    Color Color;
    bool ShowGrid;
    GridAnchoring GridAnchor;
    float FloorOffset;
    Color GridColor;
    float GridSize;
    float GridDistance;
    float MinimumDuration;
    float FadeInTime;
    float FadeOutTime;
    float FadeOutDelay;

    // methods

    LocomotionVignetteSettings Clone();
};

Detailed Documentation¶

The look and timing of a LocomotionVignette.

Properties¶

float ApertureAngle

Gets or sets the angle in degrees, measured from the view direction, that is left completely clear. Smaller values narrow the field of view more.

float FeatheringAngle

Gets or sets the angle in degrees over which the vignette fades from clear to fully opaque, starting at ApertureAngle.

Color Color

Gets or sets the color of the vignette. The alpha channel is its maximum opacity.

bool ShowGrid

Gets or sets a value indicating whether a floor grid is drawn inside the vignette, to help the user see how they move.

GridAnchoring GridAnchor

Gets or sets what the grid is anchored to: the world, so it moves past the user like real ground, or the play area, so it stays still while the world moves.

float FloorOffset

Gets or sets the height of the grid’s floor plane, in meters, above the floor of the space it is anchored to: world height 0 when anchored to the world, the play area floor when anchored to the play area.

Color GridColor

Gets or sets the color of the grid lines. The alpha channel is their opacity.

float GridSize

Gets or sets the size of a grid cell, in meters of the space the grid is anchored to.

float GridDistance

Gets or sets the distance from the user, in meters of the space the grid is anchored to, over which the grid fades out.

float MinimumDuration

Gets or sets the time in seconds a locomotion has to last before the vignette reacts to it. Locomotions shorter than this, like snap turns, are ignored.

float FadeInTime

Gets or sets the time in seconds the vignette takes to appear once it reacts to a locomotion.

float FadeOutTime

Gets or sets the time in seconds the vignette takes to disappear once a locomotion ends.

float FadeOutDelay

Gets or sets the time in seconds the vignette stays visible after a locomotion ends, before it starts to disappear.

Methods¶

LocomotionVignetteSettings Clone()

Creates a copy of these settings.

Returns:

A new instance with the same values.