Inherits G3D::GuiControl.

Public Member Functions
	GuiScrollBar (GuiContainer parent, const Pointer< float > &value, float maxValue, float extent=1, bool vertical=true, GuiControl eventSource=nullptr)

const GuiText &	caption () const

float	captionHeight () const
	For controls that have a caption outside the bounds of the control on the top or bottom, this is the size reserved for the caption. More...

float	captionWidth () const
	For controls that have a caption outside the bounds of the control on the left, this is the size reserved for the caption. More...

const Rect2D &	clickRect () const
	Used by GuiContainers. More...

virtual float	defaultCaptionHeight () const
	Default caption size for this control. More...

virtual float	defaultCaptionWidth () const

bool	enabled () const

virtual void	findControlUnderMouse (Vector2 mouse, GuiControl *&control)
	Return the enabled, visible control containing the mouse. More...

bool	focused () const

Vector2	fromOSWindowCoords (const Vector2 &v) const
	Transforms v from OS window coordinates to this control's coordinates. More...

bool	mouseOver () const

void	moveBy (const Vector2 &delta)

void	moveBy (float dx, float dy)

void	moveRightOf (const GuiControl *control, const Vector2 &offset)
	If these two controls have the same parent, move this one immediately to the right of the argument. More...

void	moveRightOf (const GuiControl *control, float offsetX=0.0f)

const Rect2D &	rect () const

virtual void	render (RenderDevice *rd, const shared_ptr< GuiTheme > &theme, bool ancestorsEnabled) const override
	Only methods on theme may be called from this method by default. More...

virtual void	setCaption (const GuiText &caption)

virtual void	setCaptionHeight (float c)

virtual void	setCaptionWidth (float c)

virtual void	setEnabled (bool e)

void	setEventSource (GuiControl *c)

void	setExtent (float extent)

void	setFocused (bool b)
	Grab or release keyboard focus. More...

void	setHeight (float h)

void	setMax (float max)

void	setPosition (const Vector2 &v)

void	setPosition (float x, float y)

virtual void	setRect (const Rect2D &rect)
	If you explicitly change the rectangle of a control, the containing pane may clip its borders. More...

void	setSize (const Vector2 &v)

void	setSize (float x, float y)

void	setThumbPos (float pos)

void	setVisible (bool b)

void	setWidth (float w)

shared_ptr< GuiTheme >	theme () const

virtual bool	toolStyle () const
	Return true if this is in tool button style. More...

Vector2	toOSWindowCoords (const Vector2 &v) const
	Returns the coordinates of v, which is in the coordinate system of this object, relative to the OSWindow on which it will be rendered. More...

Rect2D	toOSWindowCoords (const Rect2D &r) const

bool	visible () const

GuiWindow *	window () const
	Get the window containing this control. More...

Protected Types
enum	{ LEFT_CAPTION_WIDTH = 80, TOP_CAPTION_HEIGHT = 20 }

enum	State { NONE, ARROW_UP_SCROLLING, ARROW_DOWN_SCROLLING, ARROW_UP, ARROW_DOWN, IN_DRAG }

Protected Member Functions
void	fireEvent (GEventType type)
	Fires an event. More...

float	floatValue () const
	returns the value of the thumb from 0 to the maxValue/extent - 1. More...

void	getAllBounds (Rect2D &top, Rect2D &bottom, Rect2D &barBounds, Rect2D &thumbBounds) const

float	maxValue () const
	returns the max value that thumb pos can be, when everything is called by m_extent. More...

virtual bool	onEvent (const GEvent &event) override
	Events are only delivered (by GuiWindow) to a GuiControl when the control has the key focus. More...

void	setFloatValue (float f)
	Set value on the range set the value of thumb pos; used only in render and on event. More...

void	updateScroll ()

Protected Attributes
GuiText	m_caption

float	m_captionHeight

float	m_captionWidth

Rect2D	m_clickRect
	Rect bounds used for mouse actions. More...

Vector2	m_dragStart
	Position from which the mouse drag started, relative to m_gui.m_clientRect. More...

float	m_dragStartValue

bool	m_enabled

GuiControl *	m_eventSource
	Sent events should appear to be from this object, which is usually "this". More...

float	m_extent

GuiWindow *	m_gui
	The window that ultimately contains this control. More...

float	m_maxValue

GuiContainer *	m_parent
	Parent pane. More...

Rect2D	m_rect
	Rect bounds used for rendering and layout. More...

State	m_state

Pointer< float >	m_value

bool	m_vertical

bool	m_visible

Friends
class	GuiPane

class	GuiWindow

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

protectedinherited

Enumerator
LEFT_CAPTION_WIDTH
TOP_CAPTION_HEIGHT

◆ State

enum G3D::GuiScrollBar::State

protected

Enumerator
NONE
ARROW_UP_SCROLLING
ARROW_DOWN_SCROLLING
ARROW_UP
ARROW_DOWN
IN_DRAG

Constructor & Destructor Documentation

◆ GuiScrollBar()

G3D::GuiScrollBar::GuiScrollBar	(	GuiContainer *	parent,
		const Pointer< float > &	value,
		float	maxValue,
		float	extent = `1`,
		bool	vertical = `true`,
		GuiControl *	eventSource = `nullptr`
	)

Parameters

maxValue	- Is the maximum length of the slider. value will never reach it, the highest it will give is maxValue - extent.
extent	- extent is the size of a single screen or single situation. If maxValue is twice as large as extent then the thumb will be exactly half as long as the track.
eventSource	- If used in any hybrid controls should be set to the pane it is on so that all events fired from the scroll bar come from that pane.

Member Function Documentation

◆ caption()

const GuiText& G3D::GuiControl::caption ( ) const

inherited

Referenced by G3D::GuiPane::addDropDownList(), G3D::GuiPane::addMultiLineTextBox(), and G3D::GuiPane::addTextBox().

◆ captionHeight()

float G3D::GuiControl::captionHeight ( ) const

inherited

For controls that have a caption outside the bounds of the control on the top or bottom, this is the size reserved for the caption.

◆ captionWidth()

float G3D::GuiControl::captionWidth ( ) const

inherited

For controls that have a caption outside the bounds of the control on the left, this is the size reserved for the caption.

◆ clickRect()

const Rect2D& G3D::GuiControl::clickRect ( ) const

inlineinherited

Used by GuiContainers.

◆ defaultCaptionHeight()

virtual float G3D::GuiControl::defaultCaptionHeight ( ) const

inlinevirtualinherited

Default caption size for this control.

Reimplemented in G3D::GuiFunctionBox.

◆ defaultCaptionWidth()

virtual float G3D::GuiControl::defaultCaptionWidth ( ) const

inlinevirtualinherited

◆ enabled()

bool G3D::GuiControl::enabled ( ) const

inherited

Referenced by G3D::GuiNumberBox< int >::render().

◆ findControlUnderMouse()

virtual void G3D::GuiControl::findControlUnderMouse	(	Vector2	mouse,
		GuiControl *&	control
	)

inlinevirtualinherited

Return the enabled, visible control containing the mouse.

The default implementation returns itself if the mouse is within its bounds. GuiContainers should override this to iterate through children. Since only one (non-overlapping) child will write to control, it is sufficient to call this on all children without testing to see if one already wrote to control.

Reimplemented in G3D::GuiNumberBox< Value >, G3D::GuiNumberBox< float >, G3D::GuiNumberBox< int >, G3D::GuiTextureBox, G3D::GuiPane, G3D::GuiScrollPane, G3D::GuiFrameBox, and G3D::GuiTabPane.

Referenced by G3D::GuiNumberBox< int >::findControlUnderMouse().

◆ fireEvent()

void G3D::GuiControl::fireEvent ( GEventType type )

protectedinherited

Fires an event.

◆ floatValue()

float G3D::GuiScrollBar::floatValue ( ) const

inlineprotected

returns the value of the thumb from 0 to the maxValue/extent - 1.

which is the amount of thumbW it is from the top of the bar.

◆ focused()

bool G3D::GuiControl::focused ( ) const

inherited

◆ fromOSWindowCoords()

Vector2 G3D::GuiControl::fromOSWindowCoords ( const Vector2 & v ) const

inherited

Transforms v from OS window coordinates to this control's coordinates.

◆ getAllBounds()

void G3D::GuiScrollBar::getAllBounds	(	Rect2D &	top,
		Rect2D &	bottom,
		Rect2D &	barBounds,
		Rect2D &	thumbBounds
	)		const

protected

◆ maxValue()

float G3D::GuiScrollBar::maxValue ( ) const

inlineprotected

returns the max value that thumb pos can be, when everything is called by m_extent.

N.B. not the same as m_maxValue - this returns the number of bar lengths away from the top where as m_maxValue is the maximum pixel value

◆ mouseOver()

bool G3D::GuiControl::mouseOver ( ) const

inherited

◆ moveBy() [1/2]

void G3D::GuiControl::moveBy ( const Vector2 & delta )

inherited

◆ moveBy() [2/2]

void G3D::GuiControl::moveBy	(	float	dx,
		float	dy
	)

inherited

◆ moveRightOf() [1/2]

void G3D::GuiControl::moveRightOf	(	const GuiControl *	control,
		const Vector2 &	offset
	)

inherited

If these two controls have the same parent, move this one immediately to the right of the argument.

Parameters

offset May be negative

Referenced by G3D::GuiControl::moveRightOf().

◆ moveRightOf() [2/2]

void G3D::GuiControl::moveRightOf	(	const GuiControl *	control,
		float	offsetX = `0.0f`
	)

inlineinherited

◆ onEvent()

virtual bool G3D::GuiScrollBar::onEvent ( const GEvent & event )

overrideprotectedvirtual

Events are only delivered (by GuiWindow) to a GuiControl when the control has the key focus.

If the control does not consume the event, the event is delivered to each of its GUI parents in order, back to the window's root pane.

Key focus is transferred during a mouse down event.

Reimplemented from G3D::GuiControl.

◆ rect()

const Rect2D& G3D::GuiControl::rect ( ) const

inherited

Referenced by G3D::GuiNumberBox< int >::render(), G3D::GuiNumberBox< int >::setRect(), and G3D::GuiNumberBox< int >::setUnitsSize().

◆ render()

virtual void G3D::GuiScrollBar::render	(	RenderDevice *	rd,
		const shared_ptr< GuiTheme > &	theme,
		bool	ancestorsEnabled
	)		const

overridevirtual

Only methods on theme may be called from this method by default.

To make arbitrary RenderDevice calls, wrap them in GuiTheme::pauseRendering ... GuiTheme::resumeRendering.

Parameters

ancestorsEnabled Draw as disabled if this is false or if enabled() is false.

Implements G3D::GuiControl.

◆ setCaption()

virtual void G3D::GuiControl::setCaption ( const GuiText & caption )

virtualinherited

Reimplemented in G3D::GuiNumberBox< Value >, G3D::GuiNumberBox< float >, G3D::GuiNumberBox< int >, G3D::GuiTextureBox, and G3D::GuiPane.

Referenced by G3D::GuiNumberBox< int >::setCaption().

◆ setCaptionHeight()

virtual void G3D::GuiControl::setCaptionHeight ( float c )

virtualinherited

◆ setCaptionWidth()

virtual void G3D::GuiControl::setCaptionWidth ( float c )

virtualinherited

◆ setEnabled()

virtual void G3D::GuiControl::setEnabled ( bool e )

virtualinherited

Reimplemented in G3D::GuiNumberBox< Value >, G3D::GuiNumberBox< float >, G3D::GuiNumberBox< int >, and G3D::GuiFrameBox.

Referenced by G3D::GuiNumberBox< int >::setEnabled().

◆ setEventSource()

void G3D::GuiControl::setEventSource ( GuiControl * c )

inlineinherited

◆ setExtent()

void G3D::GuiScrollBar::setExtent ( float extent )

inline

◆ setFloatValue()

void G3D::GuiScrollBar::setFloatValue ( float f )

inlineprotected

Set value on the range set the value of thumb pos; used only in render and on event.

to set value of thumb pos use setThumbPos

◆ setFocused()

void G3D::GuiControl::setFocused ( bool b )

inherited

Grab or release keyboard focus.

◆ setHeight()

void G3D::GuiControl::setHeight ( float h )

inherited

◆ setMax()

void G3D::GuiScrollBar::setMax ( float max )

inline

◆ setPosition() [1/2]

void G3D::GuiControl::setPosition ( const Vector2 & v )

inherited

◆ setPosition() [2/2]

void G3D::GuiControl::setPosition	(	float	x,
		float	y
	)

inherited

◆ setRect()

virtual void G3D::GuiControl::setRect ( const Rect2D & rect )

virtualinherited

If you explicitly change the rectangle of a control, the containing pane may clip its borders.

Call pack() on the containing pane (or window) to resize that container appropriately.

Reimplemented in G3D::GuiNumberBox< Value >, G3D::GuiNumberBox< float >, G3D::GuiNumberBox< int >, G3D::GuiTextureBox, G3D::GuiPane, G3D::GuiTextBox, G3D::GuiDropDownList, G3D::GuiScrollPane, G3D::GuiTabPane, G3D::GuiContainer, G3D::GuiFrameBox, G3D::GuiRadioButton, and G3D::GuiCheckBox.

◆ setSize() [1/2]

void G3D::GuiControl::setSize ( const Vector2 & v )

inherited

Referenced by G3D::GuiPane::addRadioButton().

◆ setSize() [2/2]

void G3D::GuiControl::setSize	(	float	x,
		float	y
	)

inherited

◆ setThumbPos()

void G3D::GuiScrollBar::setThumbPos ( float pos )

inline

◆ setVisible()

void G3D::GuiControl::setVisible ( bool b )

inherited

◆ setWidth()

void G3D::GuiControl::setWidth ( float w )

inherited

◆ theme()

shared_ptr<GuiTheme> G3D::GuiControl::theme ( ) const

inherited

Referenced by G3D::GuiPane::addRadioButton(), G3D::GuiScrollPane::borderDimensionsBump(), G3D::GuiScrollPane::borderStartBump(), G3D::GuiNumberBox< int >::render(), G3D::GuiScrollPane::scrollBarDimesionsBump(), and G3D::GuiScrollPane::scrollBarStartBump().

◆ toolStyle()

virtual bool G3D::GuiControl::toolStyle ( ) const

inlinevirtualinherited

Return true if this is in tool button style.

Reimplemented in G3D::GuiRadioButton, G3D::GuiButton, and G3D::GuiCheckBox.

◆ toOSWindowCoords() [1/2]

Vector2 G3D::GuiControl::toOSWindowCoords ( const Vector2 & v ) const

inherited

Returns the coordinates of v, which is in the coordinate system of this object, relative to the OSWindow on which it will be rendered.

Referenced by G3D::GuiControl::toOSWindowCoords().

◆ toOSWindowCoords() [2/2]

Rect2D G3D::GuiControl::toOSWindowCoords ( const Rect2D & r ) const

inlineinherited

◆ updateScroll()

void G3D::GuiScrollBar::updateScroll ( )

protected

◆ visible()

bool G3D::GuiControl::visible ( ) const

inherited

◆ window()

GuiWindow* G3D::GuiControl::window ( ) const

inherited

Get the window containing this control.

Friends And Related Function Documentation

◆ GuiPane

friend class GuiPane

friend

◆ GuiWindow

friend class GuiWindow

friend

Member Data Documentation

◆ m_caption

GuiText G3D::GuiControl::m_caption

protectedinherited

Referenced by G3D::GuiNumberBox< int >::render().

◆ m_captionHeight

float G3D::GuiControl::m_captionHeight

protectedinherited

◆ m_captionWidth

float G3D::GuiControl::m_captionWidth

protectedinherited

Referenced by G3D::GuiNumberBox< int >::setRect().

◆ m_clickRect

Rect2D G3D::GuiControl::m_clickRect

protectedinherited

Rect bounds used for mouse actions.

Updated by setRect.

Referenced by G3D::GuiControl::clickRect().

◆ m_dragStart

Vector2 G3D::GuiScrollBar::m_dragStart

protected

Position from which the mouse drag started, relative to m_gui.m_clientRect.

When dragging the thumb, the cursor may not be centered on the thumb the way it is when the mouse clicks on the track.

◆ m_dragStartValue

float G3D::GuiScrollBar::m_dragStartValue

protected

◆ m_enabled

bool G3D::GuiControl::m_enabled

protectedinherited

Referenced by G3D::GuiControl::findControlUnderMouse(), G3D::GuiNumberBox< int >::findControlUnderMouse(), and G3D::GuiNumberBox< int >::render().

◆ m_eventSource

GuiControl* G3D::GuiControl::m_eventSource

protectedinherited

Sent events should appear to be from this object, which is usually "this".

Other controls can set the event source to create compound controls that seem atomic from the outside.

Referenced by G3D::GuiSlider< int >::GuiSlider(), G3D::GuiNumberBox< Value >::MyTextBox::MyTextBox(), and G3D::GuiControl::setEventSource().

◆ m_extent

float G3D::GuiScrollBar::m_extent

protected

Referenced by floatValue(), maxValue(), setExtent(), setFloatValue(), and setThumbPos().

◆ m_gui

GuiWindow* G3D::GuiControl::m_gui

protectedinherited

The window that ultimately contains this control.

◆ m_maxValue

float G3D::GuiScrollBar::m_maxValue

protected

Referenced by maxValue(), setMax(), and setThumbPos().

◆ m_parent

GuiContainer* G3D::GuiControl::m_parent

protectedinherited

Parent pane.

◆ m_rect

Rect2D G3D::GuiControl::m_rect

protectedinherited

Rect bounds used for rendering and layout.

Relative to the enclosing pane's clientRect.

Referenced by G3D::GuiControl::findControlUnderMouse(), G3D::GuiNumberBox< int >::render(), G3D::GuiNumberBox< int >::setCaption(), and G3D::GuiNumberBox< int >::setRect().

◆ m_state

State G3D::GuiScrollBar::m_state

protected

◆ m_value

Pointer<float> G3D::GuiScrollBar::m_value

protected

Referenced by floatValue(), setFloatValue(), and setThumbPos().

◆ m_vertical

bool G3D::GuiScrollBar::m_vertical

protected

◆ m_visible

bool G3D::GuiControl::m_visible

protectedinherited

Referenced by G3D::GuiControl::findControlUnderMouse(), G3D::GuiNumberBox< int >::findControlUnderMouse(), and G3D::GuiNumberBox< int >::render().

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Friends

Member Enumeration Documentation

◆ anonymous enum

◆ State

Constructor & Destructor Documentation

◆ GuiScrollBar()

Member Function Documentation

◆ caption()

◆ captionHeight()

◆ captionWidth()

◆ clickRect()

◆ defaultCaptionHeight()

◆ defaultCaptionWidth()

◆ enabled()

◆ findControlUnderMouse()

◆ fireEvent()

◆ floatValue()

◆ focused()

◆ fromOSWindowCoords()

◆ getAllBounds()

◆ maxValue()

◆ mouseOver()

◆ moveBy() [1/2]

◆ moveBy() [2/2]

◆ moveRightOf() [1/2]

◆ moveRightOf() [2/2]

◆ onEvent()

◆ rect()

◆ render()

◆ setCaption()

◆ setCaptionHeight()

◆ setCaptionWidth()

◆ setEnabled()

◆ setEventSource()

◆ setExtent()

◆ setFloatValue()

◆ setFocused()

◆ setHeight()

◆ setMax()

◆ setPosition() [1/2]

◆ setPosition() [2/2]

◆ setRect()

◆ setSize() [1/2]

◆ setSize() [2/2]

◆ setThumbPos()

◆ setVisible()

◆ setWidth()

◆ theme()

◆ toolStyle()

◆ toOSWindowCoords() [1/2]

◆ toOSWindowCoords() [2/2]

◆ updateScroll()

◆ visible()

◆ window()

Friends And Related Function Documentation

◆ GuiPane

◆ GuiWindow

Member Data Documentation

◆ m_caption

◆ m_captionHeight

◆ m_captionWidth

◆ m_clickRect

◆ m_dragStart

◆ m_dragStartValue

◆ m_enabled

◆ m_eventSource

◆ m_extent

◆ m_gui

◆ m_maxValue

◆ m_parent

◆ m_rect

◆ m_state

◆ m_value

◆ m_vertical

◆ m_visible