ValueAccumulatorBaseEnums.BoundType Enum Reference

Sets how a Value Accumulator handles the increments when it reaches the limits of the range of increments. More...

Inheritance diagram for ValueAccumulatorBaseEnums.BoundType:

Public Member Functions
	BoundType (int mValue)
	BoundType (BoundType enum_)
int	getValue ()
	Returns the integer value of the enumeration constant. More...
final int	swigValue ()

Static Public Member Functions
static BoundType	swigToEnum (int swigValue)
static BoundType	toEnum (int value)
	Converts an integer value to the matching enumeration constant. More...

Public Attributes
	Clamp =(1)
	Limits the total accumulated value between the maximum and minimum values by clamping the value.
	Loop =(0)
	Limits the total accumulated value between the maximim and minimum values by wrapping the value.

Detailed Description

Sets how a Value Accumulator handles the increments when it reaches the limits of the range of increments.

For an IntValueAccumulator you can set the boundaries with the IntValueAccumulator::MinimumAccumulatedValueProperty and IntValueAccumulator::MaximumAccumulatedValueProperty.
For an FloatValueAccumulator you can set the boundaries with the FloatValueAccumulator::MinimumAccumulatedValueProperty and FloatValueAccumulator::MaximumAccumulatedValueProperty.

Member Function Documentation

int getValue

(

)

Returns the integer value of the enumeration constant.

Returns

Integer value.

Implements Enum.

static BoundType toEnum ( int  value )

static

Converts an integer value to the matching enumeration constant.

Parameters

value

Integer value to convert to enumeration constant.

Returns

Enumeration constant matching the integer value.