ofxOui::Bpf Class Reference

Breakpoint function component. More...

#include <ofxOuiBpf.hpp>

Inheritance diagram for ofxOui::Bpf:

Collaboration diagram for ofxOui::Bpf:

Classes
class	EditPointEvent
	Event arguments when a point is edited. More...

Public Types
enum	Appearance { Appearance::Lines, Appearance::FillBottom, Appearance::FillTop, Appearance::FillZero }
	Appearance of the BPF display. More...

Public Member Functions
	Bpf (int x_=0, int y_=0, int width_=0, int height_=0)
	Constructor. More...
virtual	~Bpf ()
	Destructor. More...
template<typename T , typename args , class ListenerClass >
void	onEditPoint (T *owner, void(ListenerClass::*listenerMethod)(args))
	Set callback function for editing events. More...
virtual void	update ()
	OF-like update function. More...
void	clipBounds ()
	Set the bounds to the min/max of the values. 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< ofVec2f >	values
	Vector of x/y values of the BPF. More...
Graph	graph
	2D Graph area More...
Appearance	appearance = Appearance::Lines
	Appearance of the BPF display. More...
float	point_radius = 8
	Radius of the node of the BPF. 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 ()
virtual void	mousePressed (ofMouseEventArgs &e)
virtual void	mouseDragged (ofMouseEventArgs &e)
virtual void	mouseReleased (ofMouseEventArgs &e)
virtual void	drawBackground ()
virtual void	drawFrame ()
virtual void	drawIcon ()

Protected Attributes
int	point_selected_
float	time_mouse_pressed_
std::function< void(Bpf::EditPointEvent &)>	callback_
Type	type_ = ofxOui::Type::Label
bool	hover_ = false
ofColor	current_background_color_
ofColor	current_frame_color_

Static Protected Attributes
static Component *	blocking_component = nullptr

Detailed Description

Breakpoint function component.

Mouse Interaction modes: click + drag. Single clik can be used to edit existing values, double click can be used for either adding or removing nodes in the BPF

Member Enumeration Documentation

Appearance

enum ofxOui::Bpf::Appearance

strong

Appearance of the BPF display.

Enumerator
Lines	Display as lines.
FillBottom	Display as filled surface to the bottom of the display.
FillTop	Display as filled surface to the top of the display.
FillZero	Display as filled surface to zero.

Constructor & Destructor Documentation

Bpf()

ofxOui::Bpf::Bpf	(	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

~Bpf()

ofxOui::Bpf::~Bpf ( )

virtual

Destructor.

Member Function Documentation

clipBounds()

void ofxOui::Bpf::clipBounds

(

)

Set the bounds to the min/max of the values.

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::Bpf::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::Bpf::mouseDragged ( ofMouseEventArgs &  e )

protectedvirtual

mousePressed()

void ofxOui::Bpf::mousePressed ( ofMouseEventArgs &  e )

protectedvirtual

mouseReleased()

void ofxOui::Bpf::mouseReleased ( ofMouseEventArgs &  e )

protectedvirtual

onEditPoint()

template<typename T , typename args , class ListenerClass >

void ofxOui::Bpf::onEditPoint ( T *  owner, void(ListenerClass::*)(args)  listenerMethod  )

inline

Set callback function for editing events.

Parameters

owner	pointer to the owner object
listenerMethod	method to be called on eaech event

Template Parameters

T	type of the owner object
args	arguments of the callback function
ListenerClass	class 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::Bpf::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

appearance

Appearance ofxOui::Bpf::appearance = Appearance::Lines

Appearance of the BPF display.

blocking_component

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

staticprotectedinherited

callback_

std::function<void(Bpf::EditPointEvent &)> ofxOui::Bpf::callback_

protected

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)

font

TextBox ofxOui::Component::font

inherited

textbox for the main label of the component

graph

Graph ofxOui::Bpf::graph

2D Graph area

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)

point_radius

float ofxOui::Bpf::point_radius = 8

Radius of the node of the BPF.

point_selected_

int ofxOui::Bpf::point_selected_

protected

shape

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

inherited

shape of the component

style

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

inherited

style of the component

time_mouse_pressed_

float ofxOui::Bpf::time_mouse_pressed_

protected

type_

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

protectedinherited

values

vector<ofVec2f> ofxOui::Bpf::values

Vector of x/y values of the BPF.

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:

• ofxOuiBpf.hpp
• ofxOuiBpf.cpp