Detailed Description

A Slider selecting a value along a gradient of colors, with a solid arrow as a grip

Inheritance diagram for ColorSlider:

Public Member Functions
	ColorSlider (Type type=HORIZONTAL, float min=0.0f, float max=100.0f, float value=0.0f, float step=1.0f)

const auto &	getColors () const

void	setColors (const std::vector< float4 > &colors)

float4	colorAt (float ratio) const

const auto &	getTrackRect () const

auto	getSteps () const

void	setSteps (uint32 steps)

auto	getArrow () const

void	setResources (const std::string &resArrow)

Public Member Functions inherited from Slider
	Slider (Type type=HORIZONTAL, float min=0.0f, float max=100.0f, float value=0.0f, float step=1.0f)

auto	getSliderType () const

auto	getGripSize () const

void	setGripSize (float size)

auto	getTrackSize () const

void	setTrackSize (float size)

auto	getTrack () const

auto	getFill () const

auto	getGrip () const

void	setResources (const std::string &resTrack, const std::string &resFill, const std::string &resGrip)

Public Member Functions inherited from ValueSelect
	ValueSelect (Type type, float min, float max, float value, float step)

auto	getMin () const

auto	getMax () const

auto	getValue () const

auto	getStep () const

virtual void	setMin (float min)

virtual void	setMax (float max)

virtual void	setValue (float value)

virtual void	setStep (float step)

Public Member Functions inherited from Widget
	Widget (Type type=WIDGET)

	~Widget () override

Type	getType () const

bool	isVisible () const

void	setVisible (bool show=true)

bool	isEnabled () const

void	setEnabled (bool isEnabled=true)

virtual void	setPos (float x, float y)

float	getWidth () const

float	getHeight () const

float	getRequestedWidth () const

float	getRequestedHeight () const

virtual void	setSize (float width, float height)

void	setWidth (const float width)

void	setHeight (const float height)

const Rect &	getRect () const

void	setRect (float x, float y, float width, float height)

void	setRect (const Rect &rect)

float	getAspectRatio () const

Alignment	getAlignment () const

void	setAlignment (Alignment alignment)

std::shared_ptr< Font >	getFont () const

void	setFont (const std::shared_ptr< Font > &font)

float	getFontScale () const

virtual void	setFontScale (float fontScale)

bool	isFocused () const

Widget *	getParent () const

void	setOverlap (const bool overlap)

template<typename T , typename... Args>
std::shared_ptr< T >	create (const std::string &resource, const Alignment alignment, Args &&...args)

template<typename T , typename... Args>
std::shared_ptr< T >	create (const Alignment alignment, Args &&...args)

template<typename T >
std::shared_ptr< T >	add (std::shared_ptr< T > child, const Alignment alignment=Alignment::NONE, const std::string &resource="", const bool overlap=false)

template<typename T >
std::shared_ptr< T >	addPopup (std::shared_ptr< T > child, const std::string &resource="")

template<typename T >
std::shared_ptr< T >	addAfter (std::shared_ptr< T > child, const std::shared_ptr< Widget > &after, const Alignment alignment, const std::string &resource="", const bool overlap=false)

virtual void	remove (const std::shared_ptr< Widget > &child)

virtual void	removeAll ()

void	setPadding (float padding)

float	getPadding () const

float	getVBorder () const

float	getHBorder () const

void	setVBorder (float size)

void	setHBorder (float size)

bool	isDrawBackground () const

void	setDrawBackground (bool drawBackground)

bool	isPushed () const

bool	isPointed () const

bool	isFreezed () const

bool	isRedrawOnMouseEvent () const

bool	isOverlapping () const

Rect	getChildrenRect () const

void	setFreezed (const bool f)

void	setPushed (const bool p)

void	refresh ()

void	setResource (std::shared_ptr< UIResource > res)

uint32	getGroupIndex () const

void	setGroupIndex (int32 index)

template<typename T >
T	getUserData () const

template<typename T >
std::shared_ptr< T >	getPointerUserData () const

const std::any &	getUserData () const

void	setUserData (const std::any &data)

float	getTransparency () const

void	setTransparency (float alpha)

void	resizeChildren ()

float	getChildrenOffsetX () const

float	getChildrenOffsetY () const

void	setChildrenOffset (float x, float y)

std::shared_ptr< Widget >	setFocus (bool focus=true)

virtual void	onAttach ()

virtual void	onDetach ()

virtual void	onShow ()

virtual void	onHide ()

virtual void	onResize ()

virtual void	onMove ()

virtual bool	onKeyDown (Key key)

virtual bool	onTextInput (const std::string &text)

virtual bool	onKeyUp (Key key)

virtual bool	onMouseDown (MouseButton button, float x, float y)

virtual bool	onMouseUp (MouseButton button, float x, float y)

virtual bool	onMouseMove (uint32 buttonsState, float x, float y)

virtual void	onMouseLeave ()

virtual void	onDisable ()

virtual void	onEnable ()

virtual void	onGotFocus ()

virtual void	onLostFocus ()

bool	getConsumeMouseEvent () const

void	setConsumeMouseEvent (const bool consumeMouseEvent)

const std::list< std::shared_ptr< Widget > > &	getChildren () const

bool	hasChildren () const

void	subscribe (const event_type &type, unique_id id, EventHandlerCallback callback)

void	subscribe (const event_type &type, EventHandlerCallback callback)

void	unsubscribe (unique_id id)

bool	isAttached () const

Window &	getWindow () const

Style &	getStyle () const

Vector2DRenderer &	getRenderer () const

RenderingWindow &	getRenderingWindow () const

WindowManager &	getWindowManager () const

Static Public Attributes
static constexpr uint32	DEFAULT_STEPS {64}
	Number of strips the gradient is drawn with. More...

static constexpr float	DEFAULT_ARROW_SIZE {10.0f}
	Default size of the arrow, in square units. More...

Static Public Attributes inherited from Slider
static constexpr float	DEFAULT_GRIP_SIZE {14.0f}
	Default size of the grip, in square units. More...

static constexpr float	DEFAULT_TRACK_SIZE {6.0f}
	Default thickness of the track, in square units. More...

static constexpr float	EDGE_MARGIN {1.0f}

Protected Member Functions
void	update () override
	Places the track, the fill & the grip for the current value & size. More...

Protected Member Functions inherited from Slider
	Slider (Widget::Type widgetType, Type type, float min, float max, float value, float step)

void	eventRangeChange () override

Protected Member Functions inherited from ValueSelect
virtual void	eventValueChange (float prev)

Additional Inherited Members
Public Types inherited from Slider
enum	Type { HORIZONTAL, VERTICAL }

Public Types inherited from Widget
enum	Type { WIDGET, PANEL, BOX, LINE, FRAME, BUTTON, TOGGLEBUTTON, RADIOBUTTON, CHECKBOX, CHECKMARK, CROSSMARK, ARROW, TEXT, TEXTEDIT, RICHTEXTAREA, SCROLLBAR, SLIDER, COLORSLIDER, COLORWHEEL, KNOB, TREEVIEW, IMAGE, POPUP, LIST, LISTBOX, SELECTION, PROGRESSBAR, SCROLLCONTAINER, MENU, MENUPANEL, MENUBOX, TABBAR, TABCONTAINER, DIALOG, FOLDABLECONTAINER, COLORPICKER, COLORPICKERBUTTON, SPINBOX, SPINBUTTONS, ICONIMAGE, ICONSVG, DROPDOWNLIST, TOOLTIP, GRIDCELL, GRID, TABLE }

Static Protected Member Functions inherited from Slider
static float	travel (float length, float gripLength)
	Returns the distance the start of the grip travels along the axis of the slider. More...

Protected Attributes inherited from Slider
std::shared_ptr< Widget >	track

std::shared_ptr< Widget >	fill

std::shared_ptr< Widget >	grip

Protected Attributes inherited from ValueSelect
float	min

float	max

float	value

float	step

Protected Attributes inherited from Widget
const Type	type

Rect	rect

float	requestedWidth {0}

float	requestedHeight {0}

float	hborder {0}

float	vborder {0}

float	padding {0}

bool	consumeMouseEvent {false}

bool	overlap {false}

bool	focused {false}

bool	allowFocus {false}

bool	allowChildren {true}

bool	drawBackground {true}

bool	moveChildrenOnPush {false}

bool	scrollChildren {false}

bool	skipInvisibleChildren {false}

bool	redrawOnMouseEvent {false}

bool	redrawOnMouseMove {false}

float	transparency {1.0f}

Widget *	parent {nullptr}

Alignment	alignment {Alignment::NONE}

std::shared_ptr< UIResource >	resource

std::list< std::shared_ptr< Widget > >	children

bool	mouseMoveOnFocus {false}

float	childrenOffsetX {0}

float	childrenOffsetY {0}

Constructor & Destructor Documentation

ColorSlider	(	Type	type = `HORIZONTAL`,
		float	min = `0.0f`,
		float	max = `100.0f`,
		float	value = `0.0f`,
		float	step = `1.0f`
	)

Constructor.

Parameters

type	Orientation (HORIZONTAL or VERTICAL).
min	Minimum value.
max	Maximum value.
value	Initial value.
step	Amount the value is rounded to, also added or removed by the mouse wheel.

Member Function Documentation

float4 colorAt ( float ratio ) const

Returns the color of the gradient at a given position, in [0.0, 1.0]

auto getArrow ( ) const

inline

Returns the arrow the user drags to change the value

const auto& getColors ( ) const

inline

Returns the colors the gradient is interpolated between, evenly spaced

auto getSteps ( ) const

inline

Returns the number of strips the gradient is drawn with

const auto& getTrackRect ( ) const

inline

Returns the rectangle the gradient is drawn in, next to the arrow

void setColors ( const std::vector< float4 > & colors )

Changes the colors the gradient is interpolated between, evenly spaced. The first one is displayed at the minimum value, the last one at the maximum.

void setResources ( const std::string & resArrow )

Sets the UI resources of the widgets created by the slider, hiding the three resources of a Slider : the gradient replaces the track & the fill.

Parameters

resArrow Resource for the arrow.

void setSteps ( uint32 steps )

Changes the number of strips the gradient is drawn with

void update ( )

overrideprotectedvirtual

Places the track, the fill & the grip for the current value & size.

Reimplemented from lysa::ui::Slider::update()

Member Data Documentation

constexpr float DEFAULT_ARROW_SIZE {10.0f}

staticconstexpr

Default size of the arrow, in square units.

constexpr uint32 DEFAULT_STEPS {64}

staticconstexpr

Number of strips the gradient is drawn with.

Detailed Description

Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation