ofxOui - UI Components for OpenFrameworks

Classes | Public Types | Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
ofxOui::MultiSlider Class Reference

MultiSlider. More...

#include <ofxOuiMultiSlider.hpp>

Inheritance diagram for ofxOui::MultiSlider:
[legend]
Collaboration diagram for ofxOui::MultiSlider:
[legend]

Classes

class  ValueEvent
 Event arguments for slider editing events. More...
 

Public Types

enum  Layout { Layout::Horizontal, Layout::Vertical }
 Display Layout. More...
 
enum  Origin { Origin::Lower, Origin::Upper, Origin::Zero }
 Origin of the slider filling. More...
 

Public Member Functions

template<typename T , typename args , class ListenerClass >
void onEditSlider (T *owner, void(ListenerClass::*listenerMethod)(args))
 Set callback function for slider editing events. More...
 
 MultiSlider (int x_=0, int y_=0, int width_=0, int height_=0)
 Constructor. More...
 
virtual ~MultiSlider ()
 Destructor. More...
 
virtual void update ()
 OF-like update function. More...
 
virtual void draw ()
 OF-like draw function. More...
 
virtual bool inside (float x_, float y_) const
 checks if a point is inside the component (depending on the shape) More...
 
Type type () const
 get the type of the component More...
 

Public Attributes

vector< float > values
 Slider values. More...
 
float min = 0.
 Minimum value of each slider. More...
 
float max = 1.
 Maximum value of each slider. More...
 
Layout layout = Layout::Horizontal
 Display Layout. More...
 
Origin origin = Origin::Lower
 Origin of the slider filling. More...
 
Shape shape = ofxOui::Shape::Rectangle
 shape of the component More...
 
Style style = ofxOui::Style::Default
 style of the component More...
 
TextBox font
 textbox for the main label of the component More...
 
Icon icon
 icon box of the component More...
 
float x
 x position (left) More...
 
float y
 y position(top) More...
 
float width
 component width More...
 
float height
 component height More...
 
string labelOn = ""
 Label of the component (active) More...
 
string labelOff = ""
 Label of the component (not active) More...
 
bool disabled = false
 specifies if the component should be in "disabled" mode (no interaction) More...
 
bool active = false
 specifies if the component is active More...
 

Protected Member Functions

virtual void drawLabel ()
 
void clipValues ()
 
virtual void mouseDragged (ofMouseEventArgs &e)
 
virtual void mousePressed (ofMouseEventArgs &e)
 
virtual void drawBackground ()
 
virtual void drawFrame ()
 
virtual void drawIcon ()
 

Protected Attributes

ofRectangle slider_rect_
 
bool dragging_ = false
 
ofVec2f previous_position_
 
std::function< void(MultiSlider::ValueEvent &)> multislider_event_callback_
 
Type type_ = ofxOui::Type::Label
 
bool hover_ = false
 
ofColor current_background_color_
 
ofColor current_frame_color_
 

Static Protected Attributes

static Componentblocking_component = nullptr
 

Detailed Description

MultiSlider.

Member Enumeration Documentation

§ Layout

Display Layout.

Enumerator
Horizontal 
Vertical 

§ Origin

Origin of the slider filling.

Enumerator
Lower 
Upper 
Zero 

Constructor & Destructor Documentation

§ MultiSlider()

ofxOui::MultiSlider::MultiSlider ( int  x_ = 0,
int  y_ = 0,
int  width_ = 0,
int  height_ = 0 
)

Constructor.

Parameters
x_x position (left)
y_y position (top)
width_component width
height_component height

§ ~MultiSlider()

ofxOui::MultiSlider::~MultiSlider ( )
virtual

Destructor.

Member Function Documentation

§ clipValues()

void ofxOui::MultiSlider::clipValues ( )
protected

§ draw()

void ofxOui::Component::draw ( )
virtualinherited

OF-like draw function.

this method is subdivided in protected sub-methods that can be overloaded in inherited components

Reimplemented in ofxOui::Matrix, and ofxOui::DropDown.

§ drawBackground()

void ofxOui::Component::drawBackground ( )
protectedvirtualinherited

§ drawFrame()

void ofxOui::Component::drawFrame ( )
protectedvirtualinherited

§ drawIcon()

void ofxOui::Component::drawIcon ( )
protectedvirtualinherited

Reimplemented in ofxOui::CheckBox.

§ drawLabel()

void ofxOui::MultiSlider::drawLabel ( )
protectedvirtual

Reimplemented from ofxOui::Component.

§ inside()

bool ofxOui::Component::inside ( float  x_,
float  y_ 
) const
virtualinherited

checks if a point is inside the component (depending on the shape)

Returns
true if the point of coordinates (x, y) is inside the component

§ mouseDragged()

void ofxOui::MultiSlider::mouseDragged ( ofMouseEventArgs &  e)
protectedvirtual

§ mousePressed()

void ofxOui::MultiSlider::mousePressed ( ofMouseEventArgs &  e)
protectedvirtual

§ onEditSlider()

template<typename T , typename args , class ListenerClass >
void ofxOui::MultiSlider::onEditSlider ( T *  owner,
void(ListenerClass::*)(args)  listenerMethod 
)
inline

Set callback function for slider editing events.

Parameters
ownerpointer to the owner object
listenerMethodmethod to be called on eaech event
Template Parameters
Ttype of the owner object
argsarguments of the callback function
ListenerClassclass to which the listener method belongs

§ type()

Type ofxOui::Component::type ( ) const
inlineinherited

get the type of the component

Returns
type of the component

§ update()

void ofxOui::MultiSlider::update ( )
virtual

OF-like update function.

Reimplemented from ofxOui::Component.

Member Data Documentation

§ active

bool ofxOui::Component::active = false
inherited

specifies if the component is active

§ blocking_component

ofxOui::Component * ofxOui::Component::blocking_component = nullptr
staticprotectedinherited

§ current_background_color_

ofColor ofxOui::Component::current_background_color_
protectedinherited

§ current_frame_color_

ofColor ofxOui::Component::current_frame_color_
protectedinherited

§ disabled

bool ofxOui::Component::disabled = false
inherited

specifies if the component should be in "disabled" mode (no interaction)

§ dragging_

bool ofxOui::MultiSlider::dragging_ = false
protected

§ font

TextBox ofxOui::Component::font
inherited

textbox for the main label of the component

§ height

float ofxOui::Component::height
inherited

component height

§ hover_

bool ofxOui::Component::hover_ = false
protectedinherited

§ icon

Icon ofxOui::Component::icon
inherited

icon box of the component

§ labelOff

string ofxOui::Component::labelOff = ""
inherited

Label of the component (not active)

§ labelOn

string ofxOui::Component::labelOn = ""
inherited

Label of the component (active)

§ layout

Layout ofxOui::MultiSlider::layout = Layout::Horizontal

Display Layout.

§ max

float ofxOui::MultiSlider::max = 1.

Maximum value of each slider.

§ min

float ofxOui::MultiSlider::min = 0.

Minimum value of each slider.

§ multislider_event_callback_

std::function<void(MultiSlider::ValueEvent&)> ofxOui::MultiSlider::multislider_event_callback_
protected

§ origin

Origin ofxOui::MultiSlider::origin = Origin::Lower

Origin of the slider filling.

§ previous_position_

ofVec2f ofxOui::MultiSlider::previous_position_
protected

§ shape

Shape ofxOui::Component::shape = ofxOui::Shape::Rectangle
inherited

shape of the component

§ slider_rect_

ofRectangle ofxOui::MultiSlider::slider_rect_
protected

§ style

Style ofxOui::Component::style = ofxOui::Style::Default
inherited

style of the component

§ type_

Type ofxOui::Component::type_ = ofxOui::Type::Label
protectedinherited

§ values

vector<float> ofxOui::MultiSlider::values

Slider values.

§ width

float ofxOui::Component::width
inherited

component width

§ x

float ofxOui::Component::x
inherited

x position (left)

§ y

float ofxOui::Component::y
inherited

y position(top)


The documentation for this class was generated from the following files: