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 (BoundType enum_)
	Constructs a copy of a BoundType object.
	BoundType (int value)
	Constructs a BoundType of an integer value.
int	getValue ()
	Returns the integer value of the enumeration constant.
final int	swigValue ()
	Returns the integer value of the enumeration constant.

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

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 maximum 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.

Constructor & Destructor Documentation

BoundType() [1/2]

BoundType

(

int

value

)

Constructs a BoundType of an integer value.

Parameters

value

Integer value to convert to enumeration constant.

BoundType() [2/2]

BoundType

(

BoundType

enum_

)

Constructs a copy of a BoundType object.

Parameters

enum_

BoundType to be copy constructed.

Member Function Documentation

getValue()

int getValue

(

)

Returns the integer value of the enumeration constant.

Returns

Integer value.

Implements Enum.

swigToEnum()

static BoundType swigToEnum ( int swigValue )

static

Converts an integer value to the matching enumeration constant.

Used internally by SWIG generated code.

Parameters

swigValue

Integer value to convert to enumeration constant.

Returns

Enumeration constant matching the integer value.

swigValue()

final int swigValue

(

)

Returns the integer value of the enumeration constant.

Used internally by SWIG generated code.

Returns

Integer value.

toEnum()

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.