Control Surface API  2.2.2
Public Member Functions | List of all members
SettableRangedValue Interface Reference
Inheritance diagram for SettableRangedValue:
Inheritance graph
[legend]

Public Member Functions

void set (double value)
 
void setImmediately (double value)
 
void set (Number value, Number resolution)
 
void inc (double increment)
 
void inc (Number increment, Number resolution)
 
void setRaw (double value)
 
void incRaw (double delta)
 
- Public Member Functions inherited from RangedValue
double get ()
 
double getRaw ()
 
StringValue displayedValue ()
 
void addValueObserver (int range, IntegerValueChangedCallback callback)
 
void addRawValueObserver (DoubleValueChangedCallback callback)
 
- Public Member Functions inherited from Value< DoubleValueChangedCallback >
void markInterested ()
 
void addValueObserver (ObserverType callback)
 

Detailed Description

Instances of this interface represent numeric values that have an upper and lower limit.

Since
API version 1

Definition at line 8 of file SettableRangedValue.java.

Member Function Documentation

void inc ( double  increment)

Increments or decrements the value by a normalized amount assuming the whole range of the value is 0 ..

  1. For example to increment by 10% you would use 0.1 as the increment.
Since
API version 2
void inc ( Number  increment,
Number  resolution 
)

Increments or decrements the value according to the given increment and resolution parameters.

Typically the resolution would be specified as the amount of steps the hardware control provides (for example 128) and just pass the integer value as it comes from the MIDI device. The host application will take care of scaling it.

Parameters
incrementthe amount that the current value is increased by
resolutionthe resolution used for scaling
Since
API version 1
void incRaw ( double  delta)

Increments / decrements the internal (raw) value.

Parameters
deltathe amount that the current internal value get increased by.
Since
API version 1
void set ( double  value)

Sets the value in an absolute fashion as a value between 0 .. 1 where 0 represents the minimum value and 1 the maximum. The value may not be set immediately if the user has configured a take over strategy for the controller.

Parameters
valueabsolute value [0 .. 1]
Since
API version 2
void set ( Number  value,
Number  resolution 
)

Sets the value in an absolute fashion. The value will be scaled according to the given resolution.

Typically the resolution would be specified as the amount of steps the hardware control provides (for example 128) and just pass the integer value as it comes from the MIDI device. The host application will take care of scaling it.

Parameters
valueinteger number in the range [0 .. resolution-1]
resolutionthe resolution used for scaling @ if passed-in parameters are null
Since
API version 1
void setImmediately ( double  value)

Sets the value in an absolute fashion as a value between 0 .. 1 where 0 represents the minimum value and 1 the maximum. The value change is applied immediately and does not care about what take over mode the user has selected. This is useful if the value does not need take over (e.g. a motorized slider).

Parameters
valueabsolute value [0 .. 1]
Since
API version 4
void setRaw ( double  value)

Set the internal (raw) value.

Parameters
valuethe new value with double precision. Range is undefined.
Since
API version 1
The documentation for this interface was generated from the following file: