Grip Value Types

Module description

Possible supported grip item types.

The type determines it's UI representation and what types of data it represents.

Enumerations
enum	Type {   eInvalid = -1, eInt = 0, eFloat, eTime,   eUniverse, eCombo, eToggle, eAction,   eCommand, eStatus }

Enumeration Type Documentation

enum Type

Enumerator
eInvalid	The type is invalid. Usually used when trying to get a grip item which is out of range.
eInt	This type of the grip element represents an integer, and expects a IBaseGrip::GripValue::mInt value when getting and setting values. The grip UI will be a spinner.
eFloat	This type of the grip element represents a float, and expects a IBaseGrip::GripValue::mFloat value when getting and setting values. The grip UI will be a spinner.
eTime	This type of the grip element represents a TimeValue, and expects a IBaseGrip::GripValue::mInt value, in the form of a tick value, when getting and setting values. The grip UI will be a spinner.
eUniverse	This type of the grip element represents a value in world space that respects the current system settings, and expects a IBaseGrip::GripValue::mFloat value when getting and setting values. The grip UI will be a spinner.
eCombo	This type of the grip element represents a combination of limited distinct choices, and expects a IBaseGrip::GripValue::mCombo value when getting and setting values. The UI will present the choices in a drop down menu.
eToggle	This type of the grip element is a Boolean toggle and expects a IBaseGrip::GripValue::mbool value when getting and setting values.
eAction	This type of grip element performs an action and doesn't support the getting and setting values.
eCommand	This type of grip element performs a command action, which means an action that has an off state and a on state. For example a pick action, is a command action since there is a pick state that's active during the process of picking. It uses the IBaseGrip::GripValue::mbool value to determine if a mode is active or not.
eStatus	This type of grip element just show's text and doesn't perform any actions or the getting or setting of any values.

    {
        eInvalid = -1,
        eInt = 0,
        eFloat,
        eTime,
        eUniverse,
        eCombo,
        eToggle,
        eAction,
        eCommand ,
        eStatus
    };