net.happybrackets.core.control

Class FloatControl

java.lang.Object

net.happybrackets.core.control.DynamicControlParent

net.happybrackets.core.control.FloatControl

Direct Known Subclasses:

FloatBuddyControl, FloatSliderControl, FloatTextControl

public class FloatControl
extends DynamicControlParent

This class encapsulates the functionality of DynamicControl classes of type ControlType.FLOAT in a simple API
All FloatControl controls with the same name and ControlScope will respond to a message send. For example: For example, consider two FloatControl objects with the same ControlScope and name
When the control receives the value, it will be passed through to the valueChanged(double) )} listener that is implemented when the class is created.
For example

 FloatControl control1 = new FloatControl(this, "Read", 1.0);
 FloatControl control2 = new FloatControl(this, "Read", 1.0){
  @Override
    public void valueChanged(double new_value){
        System.out.println("Read "+ new_value);
    }
 }
 // Setting the value of control1 will cause any objects listening to control1 or control2 to receive the action. EG
 control1.setValue(2.0);  // This will also set the value of control2  

reflected in its valueChanged(double) function, causing Read 2.0 to be printed to standard output.

The control can also schedule messages to be sent at a time in the future by adding the time to the message using an absolute time in the setValue(double, double) function. Eg
control1.setValue (2.0, HB.getSchedulerTime() + 1000); // this will set control1 value, as well as all other FloatControl with same ControlScope and name, to true 1 second in the future If you require a handler on the class, use the valueChanged(double) class

Constructor Summary

Constructors

Constructor and Description
FloatControl(java.lang.Object parent_sketch, java.lang.String name, double initial_value) Constructor for abstract FloatControl.
FloatControl(java.lang.Object parent_sketch, java.lang.String name, double initial_value, double min_val, double max_val, DynamicControl.DISPLAY_TYPE display_type) Constructor for abstract FloatControl.

Method Summary

Modifier and Type	Method and Description
double	getValue() Get the value for the control
FloatControl	setControlScope(ControlScope new_scope) Changed the ControlScope the object has has.
FloatControl	setDisplayRange(double minimum, double maximum, DynamicControl.DISPLAY_TYPE display_type) Set how we want this control displayed
FloatControl	setDisplayType(DynamicControl.DISPLAY_TYPE display_type) Change how to display object We must do this in subclass
void	setValue(double val) Set the value for the control.
void	setValue(double val, double scheduler_time) Identical to the setValue(double) with the exception that the valueChanged(double) event will be caused at the HBScheduler scheduled time passed in.
void	valueChanged(double control_val) When the control receives the value, it will be passed through to the valueChanged(double) listener that is implemented when the class is created.

Methods inherited from class net.happybrackets.core.control.DynamicControlParent

addControlListener, addControlScopeListener, addControlTarget, addControlTarget, clearControlTargets, getDynamicControl, getSendingDevice, removeControlListener, removeControlScopeChangedListener, removeControlTarget, removeControlTarget, removeListeners, setControlTarget, setControlTarget

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FloatControl

public FloatControl(java.lang.Object parent_sketch,
                    java.lang.String name,
                    double initial_value,
                    double min_val,
                    double max_val,
                    DynamicControl.DISPLAY_TYPE display_type)

Constructor for abstract FloatControl. Slider, Text and Buddy Control will derive from this class

Parameters:

parent_sketch - The parent object for control

name - The name to Display

initial_value - Initial value of the object

min_val - Minimum value to display on Slider

max_val - Maximum value to display on Slider

display_type - The way we want object displayed

FloatControl

public FloatControl(java.lang.Object parent_sketch,
                    java.lang.String name,
                    double initial_value)

Constructor for abstract FloatControl. Slider, Text and Buddy Control will derive from this class

Parameters:

parent_sketch - The parent object for control

name - The name to Display

initial_value - Initial value of the object

Method Detail

getValue

public double getValue()

Get the value for the control

     FloatControl control1 = new FloatControl(this, "Read", 1.0);

     double val = control1.getValue(); // val  will be 1.0
     control1.setValue(2.0);
     val = control1.getValue(); // val  will be 2.0
     

Returns:

the control value

valueChanged

public void valueChanged(double control_val)

When the control receives the value, it will be passed through to the valueChanged(double) listener that is implemented when the class is created.
For example

     FloatControl control1 = new FloatControl(this, "Read", 1.0);
     FloatControl control2 = new FloatControl(this, "Read", 1.0){
      @Override
     public void valueChanged(double new_value){
     System.out.println("Read "+ new_value);
     }
     }
     // Setting the value of control1 will cause any objects listening to control1 or control2 to receive the action. EG
     control1.setValue(2.0);  // This will also set the value of control2  

reflected in its valueChanged(double) function, causing Read 2.0 to be printed to standard output.

Parameters:

control_val - the value received

setValue

public void setValue(double val)

Set the value for the control. This will pass the message on to all other DynamicControl with matching name, type and ControlScope and call valueChanged(double).
All FloatControl controls with the same name and ControlScope will respond to a message send. For example: * For example, consider two FloatControl objects with the same ControlScope and name

     FloatControl control1 = new FloatControl(this, "Read", 1.0);
     FloatControl control2 = new FloatControl(this, "Read", 1.0){
        @Override
       public void valueChanged(double new_value){
         System.out.println("Read "+ new_value);
       }
     }
     // Setting the value of control1 will cause any objects listening to control1 or control2 to receive the action. EG
     control1.setValue(2.0);  // This will also set the value of control2  

reflected in its valueChanged(double) function, causing Read 2.0 to be printed to standard output.

Parameters:

val - the value to set the control to

setValue

public void setValue(double val,
                     double scheduler_time)

Identical to the setValue(double) with the exception that the valueChanged(double) event will be caused at the HBScheduler scheduled time passed in.
For example, the following code will cause matching DynamicControl objects to respond 1 second in the future

     FloatControl control1 = new FloatControl(this, "Read", 1.0);
     FloatControl control2 = new FloatControl(this, "Read", 1.0){
         @Override
        public void valueChanged(double new_value){
            System.out.println("Read "+ new_value);
        }
     }
     // Setting the value of control1 will cause any objects listening to control1 or control2 to receive the action. EG
     control1.setValue(2.0, HB.getSchedulerTime() + 1000);  // This will also set the value of control2  

Parameters:

val - the value to set to

scheduler_time - the HBScheduler time this is supposed to occur at

setDisplayType

public FloatControl setDisplayType(DynamicControl.DISPLAY_TYPE display_type)

Change how to display object We must do this in subclass

Parameters:

display_type - The new Control Scope

Returns:

this object

setControlScope

public FloatControl setControlScope(ControlScope new_scope)

Changed the ControlScope the object has has. It will update control map so the correct events will be generated based on its scope

Overrides:

setControlScope in class DynamicControlParent

Parameters:

new_scope - The new Control Scope

Returns:

this object

setDisplayRange

public FloatControl setDisplayRange(double minimum,
                                    double maximum,
                                    DynamicControl.DISPLAY_TYPE display_type)

Set how we want this control displayed

Parameters:

minimum - minimum display value on slider

maximum - maximum display value on slider

display_type - the type of display

Returns:

this