om::graphics::gui::objects::ScrollView Class Reference

A class that provides a scrolling content area that allows viewing of large scale GUI objects. More...

#include <omGraphicsGUIScrollView.h>

Inheritance diagram for om::graphics::gui::objects::ScrollView:

Public Member Functions
	ScrollView ()
	Create a new sizeless scroll view positioned at the origin of its coordinate system. More...
	ScrollView (const Rectangle &newRectangle)
	Create a new scroll view which occupies the specified rectangle. More...
virtual Bool	setSize (const Vector3f &newSize)
	Set the size of this scroll along each of its local axes. More...
virtual Bool	resizeForContent ()
	Resize this scroll view to fit tightly around its contents. More...
Bool	getIsResizable () const
	Return whether or not this scroll view is able to be resized by the user by dragging the corner area. More...
void	setIsResizable (Bool newIsResizable)
	Set whether or not this scroll view is able to be resized by the user by dragging the corner area. More...
Float	getSliderWidth () const
	Return the width in vertical screen coordinates of each scoll bar for this scroll view. More...
void	setSliderWidth (Float newSliderWidth)
	Set the width in vertical screen coordinates of each scoll bar for this scroll view. More...
Slider &	getXSlider ()
	Return a reference to the horizontal slider for this scroll view. More...
const Slider &	getXSlider () const
	Return a reference to the horizontal slider for this scroll view. More...
Slider &	getYSlider ()
	Return a reference to the vertical slider for this scroll view. More...
const Slider &	getYSlider () const
	Return a reference to the vertical slider for this scroll view. More...
Origin::YOrigin	getXSliderAlignment () const
	Return an enum value indicating the vertical alignment of the scroll view's horizontal slider. More...
Bool	setXSliderAlignment (Origin::YOrigin newAlignment)
	Set an enum value indicating the vertical alignment of the scroll view's horizontal slider. More...
Origin::XOrigin	getYSliderAlignment () const
	Return an enum value indicating the horizontal alignment of the scroll view's vertical slider. More...
Bool	setYSliderAlignment (Origin::XOrigin newAlignment)
	Set an enum value indicating the horizontal alignment of the scroll view's vertical slider. More...
Bool	getXSliderEnabled () const
	Return whether or not this scroll view's horizontal slider is enabled. More...
void	setXSliderEnabled (Bool newXSliderEnabled)
	Set whether or not this sscroll view's horizontal slider is enabled. More...
Bool	getYSliderEnabled () const
	Return whether or not this scroll view's vertical slider is enabled. More...
void	setYSliderEnabled (Bool newYSliderEnabled)
	Set whether or not this sscroll view's vertical slider is enabled. More...
Size	getObjectCount () const
	Return the total number of GUIObjects that are part of this scroll view. More...
GUIObject *	getObject (Index objectIndex) const
	Return a pointer to the object at the specified index in this scroll view. More...
Bool	addObject (GUIObject *newObject)
	Add the specified object to this scroll view. More...
Bool	removeObject (const GUIObject *oldObject)
	Remove the specified object from this scroll view. More...
void	clearObjects ()
	Remove all objects from this scroll view. More...
virtual Bool	setFocus (Bool newHasFocus)
	Set whether or not this scroll view currently has keyboard focus at its level in the GUI hierarchy. More...
virtual AABB3f	getLocalContentBounds () const
	Return the 3D bounding box for the content view's content display area in its local coordinate frame. More...
AABB3f	getLocalContentBoundsTotal () const
	Return the total 3D bounding box of this scroll view's content in its local coordinate system. More...
AABB2f	getLocalContentBoundsTotalXY () const
	Return the total bounding box of this scroll view's content in its local coordinate system. More...
AABB3f	getLocalContentBoundsVisible () const
	Return the visible 3D bounding box of this scroll view's content in its local coordinate system. More...
AABB2f	getLocalContentBoundsVisibleXY () const
	Return the visible bounding box of this scroll view's content in its local coordinate system. More...
AABB2f	getLocalCornerBoundsXY () const
	Return the bounding box for the scroll view's dragable corner in the local coordinate system. More...
virtual void	update (Float dt)
	Update the current internal state of this scroll view for the specified time interval in seconds. More...
virtual Bool	drawSelf (GUIRenderer &renderer, const AABB3f &parentBounds) const
	Draw this object using the specified GUI renderer to the given parent coordinate system bounds. More...
virtual Bool	guiEvent (const GUIEvent &event)
	Handle the specified GUI event that occured when this scroll view had focus. More...
virtual Bool	textEvent (const TextEvent &event)
	Handle the specified text input event that occured when this scroll view had focus. More...
virtual Bool	keyEvent (const KeyEvent &event)
	Handle the specified keyboard event that occured when this scroll view had focus. More...
virtual Bool	mouseMotionEvent (const MouseMotionEvent &event)
	Handle the specified mouse motion event that occurred. More...
virtual Bool	mouseButtonEvent (const MouseButtonEvent &event)
	Handle the specified mouse button event that occurred. More...
virtual Bool	mouseWheelEvent (const MouseWheelEvent &event)
	Handle the specified mouse wheel event that occurred. More...
Float	getScrollSpeed () const
	Return the scale factor that is used to scale the mouse scrolling speed. More...
void	setScrollSpeed (Float newScrollSpeed)
	Set the scale factor that is used to scale the mouse scrolling speed. More...
Public Member Functions inherited from om::graphics::gui::objects::GUIObject
	GUIObject ()
	Create a default visible GUI object positioned at the origin (0,0) with 0 width and 0 height. More...
	GUIObject (const RectangleStyle &newRectangleStyle)
	Create a visible GUI object positioned at the origin (0,0) with 0 width and 0 height and the given rectangle style. More...
	GUIObject (const Rectangle &newRectangle)
	Create a visible GUI object that occupies the specified rectangle. More...
	GUIObject (const Rectangle &newRectangle, const RectangleStyle &newRectangleStyle)
	Create a visible GUI object that occupies the specified rectangle and rectangle style. More...
virtual	~GUIObject ()
	Destory the GUI object, releasing all internal resources. More...
const Rectangle &	getRectangle () const
	Return a reference to this GUI object's rectangle. More...
const Vector3f &	getSize () const
	Return a reference to the 3D size of this object along each of its local axes. More...
const Vector2f &	getSizeXY () const
	Return a reference to the 2D scaling factor of this object along each of its local axes. More...
Bool	setSize (const Vector2f &newSizeXY)
	Set the 2D size of this object along the X and Y local axes. More...
Bool	setSize (Float newWidth, Float newHeight)
	Set the 2D size of this object along the X and Y local axes. More...
Bool	setSizeX (Float newWidth)
	Set the size of this object along the X axis. More...
Bool	setSizeY (Float newHeight)
	Set the size of this object along the Y axis. More...
Bool	setSizeZ (Float newDepth)
	Set the size of this object along the Z axis. More...
void	fillParent (const Vector3f &parentSize)
	Resize and resposition this object so that it fills the specified parent bounding box size. More...
const Vector3f &	getScale () const
	Return a reference to the 3D scaling factor of this object along each of its local axes. More...
const Vector2f &	getScaleXY () const
	Return a reference to the 2D scaling factor of this object along each of its local axes. More...
virtual Bool	setScale (const Vector3f &newScale)
	Set the 3D scaling factor of this object along each of its local axes. More...
Bool	setScale (const Vector2f &newScaleXY)
	Set the 2D scaling factor of this object along the X and Y local axes. More...
Bool	setScale (Float newScaleX, Float newScaleY)
	Set the 2D scaling factor of this object along the X and Y local axes. More...
Bool	setScale (Float newScale)
	Set the scaling factor of this object along all 3 axes. More...
const Vector3f &	getPosition () const
	Return the position of this GUI object's origin relative to its parent's coordinate origin. More...
const Vector2f &	getPositionXY () const
	Return the 2D position of this GUI object's origin relative to its parent's coordinate origin. More...
Bool	setPosition (const Vector2f &newPosition)
	Set the position of this GUI object's origin relative to its parent's coordinate origin. More...
virtual Bool	setPosition (const Vector3f &newPosition)
	Set the position of this GUI object's origin relative to its parent's coordinate origin. More...
const Matrix3f &	getRotation () const
	Return a 3x3 orthonormal matrix indicating the basis of this object's coordinate frame. More...
virtual Bool	setRotation (const Matrix3f &newRotation)
	Set a 3x3 orthonormal matrix indicating the basis of this object's coordinate frame. More...
Bool	setRotation (Float radians)
	Set the rotation of this GUI object to be along the Z-axis with a rotation specified in radians. More...
Bool	setRotationDegrees (Float degrees)
	Set the rotation of this GUI object to be along the Z-axis with a rotation specified in degrees. More...
Origin &	getOrigin ()
	Return the alignment of the coordinate origin for this object. More...
const Origin &	getOrigin () const
	Return the alignment of the coordinate origin for this object. More...
virtual Bool	setOrigin (const Origin &newPositionOrigin)
	Set the alignment of the coordinate origin for this object. More...
void	setOrigin (Origin::XOrigin newXOrigin, Origin::YOrigin newYOrigin)
	Set the XY alignment of the coordinate origin for this object. More...
void	setOrigin (Origin::XOrigin newXOrigin, Origin::YOrigin newYOrigin, Origin::ZOrigin newZOrigin)
	Set the XYZ alignment of the coordinate origin for this object. More...
AABB2f	getBoundsInParent (const AABB2f &parentBounds) const
	Return the 2D bounding box of this object in the coordinate frame of the specified parent bounding box. More...
AABB3f	getBoundsInParent (const AABB3f &parentBounds) const
	Return the 3D bounding box of this object in the coordinate frame of the specified parent bounding box. More...
AABB2f	getLocalBoundsXY () const
	Return the 2D bounding box of this object in its local coordinate frame. More...
AABB3f	getLocalBounds () const
	Return the 3D bounding box of this object in its local coordinate frame. More...
Vector2f	getLocalCenterXY () const
	Return the 2D center of this object's rectangle in its local coordinate frame. More...
Vector3f	getLocalCenter () const
	Return the 3D center of this object's rectangle in its local coordinate frame. More...
Matrix4f	getTransformMatrix (const AABB3f &parentBounds) const
	Return the object-space-to-parent-space homogeneous transformation matrix for the given parent bounding box. More...
Vector2f	transformToLocal (const Vector2f &pointInParent, const AABB2f &parentBounds) const
	Transform a 3D point in the parent coordinate system into this object's coordinate system. More...
Vector3f	transformToLocal (const Vector3f &pointInParent, const AABB3f &parentBounds) const
	Transform a 3D point in the parent coordinate system into this object's coordinate system. More...
Vector2f	transformFromLocal (const Vector2f &localPoint, const AABB2f &parentBounds) const
	Transform a 2D point in this object's local coordinate system into its parent's coordinate system. More...
Vector3f	transformFromLocal (const Vector3f &localPoint, const AABB3f &parentBounds) const
	Transform a 3D point in this object's local coordinate system into its parent's coordinate system. More...
Vector2f	transformVectorToLocal (const Vector2f &vectorInParent) const
	Transform a 3D vector in the parent coordinate system into this object's coordinate system. More...
Vector3f	transformVectorToLocal (const Vector3f &vectorInParent) const
	Transform a 3D vector in the parent coordinate system into this object's coordinate system. More...
Vector2f	transformVectorFromLocal (const Vector2f &localVector) const
	Transform a 2D vector in this object's local coordinate system into its parent's coordinate system. More...
Vector3f	transformVectorFromLocal (const Vector3f &localVector) const
	Transform a 3D vector in this object's local coordinate system into its parent's coordinate system. More...
MouseButtonEvent	transformEventToLocal (const MouseButtonEvent &event, const AABB2f &parentBounds) const
	Transform a mouse button event in the parent coordinate system into this object's coordinate system. More...
MouseButtonEvent	transformEventFromLocal (const MouseButtonEvent &event, const AABB2f &parentBounds) const
	Transform a mouse button event in this object's local coordinate system into its parent's coordinate system. More...
MouseMotionEvent	transformEventToLocal (const MouseMotionEvent &event, const AABB2f &parentBounds) const
	Transform a mouse motion event in the parent coordinate system into this object's coordinate system. More...
MouseMotionEvent	transformEventFromLocal (const MouseMotionEvent &event, const AABB2f &parentBounds) const
	Transform a mouse motion event in this object's local coordinate system into its parent's coordinate system. More...
MouseWheelEvent	transformEventToLocal (const MouseWheelEvent &event, const AABB2f &parentBounds) const
	Transform a mouse wheel event in the parent coordinate system into this object's coordinate system. More...
MouseWheelEvent	transformEventFromLocal (const MouseWheelEvent &event, const AABB2f &parentBounds) const
	Transform a mouse wheel event in this object's local coordinate system into its parent's coordinate system. More...
virtual Bool	containsLocalPoint (const Vector2f &localPoint) const
	Return whether or not this GUI object contains the specified local 2D point within its local bounds. More...
virtual Bool	containsLocalPoint (const Vector3f &localPoint) const
	Return whether or not this GUI object contains the specified local 3D point within its local bounds. More...
AABB2f	getLocalContentBoundsXY () const
	Return the 2D bounding box for the object's rectangle inside area in its local coordinate frame. More...
GUIStyle *	getStyle () const
	Return a pointer to the style object to use when drawing this GUI object. More...
void	setStyle (GUIStyle *newStyle)
	Set a pointer to the style object to use when drawing this GUI object. More...
const RectangleStyle &	getRectangleStyle () const
	Return an object that describes the style of the main outside rectangle of this object. More...
virtual Bool	setRectangleStyle (const RectangleStyle &newRectangleStyle)
	Set an object that describes the style of the main outside rectangle of this object. More...
const Border &	getBorder () const
	Return an object that describes the border for this object's main rectangle. More...
virtual Bool	setBorder (const Border &newBorder)
	Set an object that describes the border for this object's main rectangle. More...
Float	getBorderWidth () const
	Return the width of this object's main rectangle border. More...
Bool	setBorderWidth (Float newWidth)
	Set the width of this object's main rectangle border. More...
Float	getBorderRadius () const
	Return the corner radius of this object's main rectangle border. More...
Bool	setBorderRadius (Float newRadius)
	Set the corner radius of this object's main rectangle border. More...
const Margin &	getBorderMargin () const
	Return an object that describes the padding between the exterior and interior of the object's main rectangle. More...
Bool	setBorderMargin (const Margin &newMargin)
	Set an object that describes the padding between the exterior and interior of the object's main rectangle. More...
const Color4f &	getBackgroundColor () const
	Return the background color for this object's main rectangle. More...
virtual Bool	setBackgroundColor (const Color4f &newBackgroundColor)
	Set the background color for this object's main rectangle. More...
const Color4f &	getBorderColor () const
	Return the border color used when rendering the object's main rectangle. More...
virtual Bool	setBorderColor (const Color4f &newBorderColor)
	Set the border color used when rendering the object's main rectangle. More...
const GUIObjectFlags &	getFlags () const
	Return a const reference to the flags for this GUI object. More...
Bool	flagIsSet (GUIObjectFlags::Flag flag) const
	Return whether or not the specified boolan flag is set for this GUI object. More...
virtual Bool	setFlags (const GUIObjectFlags &newFlags)
	Set the flags for this GUI object. More...
Bool	setFlag (GUIObjectFlags::Flag flag, Bool newIsSet=true)
	Set whether or not the specified boolan flag is set for this GUI object. More...
Bool	getIsVisible () const
	Return whether or not this GUI object should be drawn to the screen. More...
void	setIsVisible (Bool newIsVisible)
	Set whether or not this GUI object should be drawn to the screen. More...
Bool	hasFocus () const
	Return whether or not this GUI object currently has keyboard focus at its level in the GUI hierarchy. More...
Public Member Functions inherited from om::gui::input::InputHandler
virtual	~InputHandler ()
	Destroy an input handler. More...

Static Public Attributes
static const Float	DEFAULT_SLIDER_WIDTH
	The default width that is used for a scroll view's sliders. More...
static const Float	DEFAULT_MIN_SLIDER_SIZE
	The default minimum size that is used for a scroll view's sliders. More...
static const Float	DEFAULT_SCROLL_SPEED
	The default scale factor that is used to scale the mouse scrolling speed. More...
static const Border	DEFAULT_BORDER
	The default border that is used for a scroll view. More...
static const Color4f	DEFAULT_BACKGROUND_COLOR
	The default background color that is used for a scroll view's area. More...
static const Color4f	DEFAULT_BORDER_COLOR
	The default border color that is used for a scroll view. More...

Detailed Description

A class that provides a scrolling content area that allows viewing of large scale GUI objects.

Constructor & Destructor Documentation

om::graphics::gui::objects::ScrollView::ScrollView

(

)

Create a new sizeless scroll view positioned at the origin of its coordinate system.

om::graphics::gui::objects::ScrollView::ScrollView

(

const Rectangle &

newRectangle

)

Create a new scroll view which occupies the specified rectangle.

Member Function Documentation

virtual Bool om::graphics::gui::objects::ScrollView::setSize ( const Vector3f &  newSize )

virtual

Set the size of this scroll along each of its local axes.

Reimplemented from om::graphics::gui::objects::GUIObject.

virtual Bool om::graphics::gui::objects::ScrollView::resizeForContent ( )

virtual

Resize this scroll view to fit tightly around its contents.

Reimplemented from om::graphics::gui::objects::GUIObject.

Bool om::graphics::gui::objects::ScrollView::getIsResizable ( ) const

inline

Return whether or not this scroll view is able to be resized by the user by dragging the corner area.

void om::graphics::gui::objects::ScrollView::setIsResizable ( Bool  newIsResizable )

inline

Set whether or not this scroll view is able to be resized by the user by dragging the corner area.

Float om::graphics::gui::objects::ScrollView::getSliderWidth ( ) const

inline

Return the width in vertical screen coordinates of each scoll bar for this scroll view.

void om::graphics::gui::objects::ScrollView::setSliderWidth ( Float  newSliderWidth )

inline

Set the width in vertical screen coordinates of each scoll bar for this scroll view.

Slider& om::graphics::gui::objects::ScrollView::getXSlider ( )

inline

Return a reference to the horizontal slider for this scroll view.

const Slider& om::graphics::gui::objects::ScrollView::getXSlider ( ) const

inline

Return a reference to the horizontal slider for this scroll view.

Slider& om::graphics::gui::objects::ScrollView::getYSlider ( )

inline

Return a reference to the vertical slider for this scroll view.

const Slider& om::graphics::gui::objects::ScrollView::getYSlider ( ) const

inline

Return a reference to the vertical slider for this scroll view.

Origin::YOrigin om::graphics::gui::objects::ScrollView::getXSliderAlignment ( ) const

inline

Return an enum value indicating the vertical alignment of the scroll view's horizontal slider.

Bool om::graphics::gui::objects::ScrollView::setXSliderAlignment

(

Origin::YOrigin

newAlignment

)

Set an enum value indicating the vertical alignment of the scroll view's horizontal slider.

This alignment must be either Origin::TOP or Origin::BOTTOM. Any other alignment will not be accepted and the method will return FALSE, indicating failure.

Origin::XOrigin om::graphics::gui::objects::ScrollView::getYSliderAlignment ( ) const

inline

Return an enum value indicating the horizontal alignment of the scroll view's vertical slider.

Bool om::graphics::gui::objects::ScrollView::setYSliderAlignment

(

Origin::XOrigin

newAlignment

)

Set an enum value indicating the horizontal alignment of the scroll view's vertical slider.

This alignment must be either Origin::LEFT or Origin::RIGHT. Any other alignment will not be accepted and the method will return FALSE, indicating failure.

Bool om::graphics::gui::objects::ScrollView::getXSliderEnabled ( ) const

inline

Return whether or not this scroll view's horizontal slider is enabled.

void om::graphics::gui::objects::ScrollView::setXSliderEnabled ( Bool  newXSliderEnabled )

inline

Set whether or not this sscroll view's horizontal slider is enabled.

Bool om::graphics::gui::objects::ScrollView::getYSliderEnabled ( ) const

inline

Return whether or not this scroll view's vertical slider is enabled.

void om::graphics::gui::objects::ScrollView::setYSliderEnabled ( Bool  newYSliderEnabled )

inline

Set whether or not this sscroll view's vertical slider is enabled.

Size om::graphics::gui::objects::ScrollView::getObjectCount ( ) const

inline

Return the total number of GUIObjects that are part of this scroll view.

GUIObject* om::graphics::gui::objects::ScrollView::getObject ( Index  objectIndex ) const

inline

Return a pointer to the object at the specified index in this scroll view.

Objects are stored in back-to-front sorted order, such that the object with index 0 is the furthest toward the back of the object ordering.

Bool om::graphics::gui::objects::ScrollView::addObject

(

GUIObject *

newObject

)

Add the specified object to this scroll view.

If the specified object pointer is NULL, the method fails and FALSE is returned. Otherwise, the object is inserted in the front-to-back order of the scroll view's objects and TRUE is returned.

Bool om::graphics::gui::objects::ScrollView::removeObject

(

const GUIObject *

oldObject

)

Remove the specified object from this scroll view.

If the given object is part of this scroll view, the method removes it and returns TRUE. Otherwise, if the specified object is not found, the method doesn't modify the scroll view and FALSE is returned.

void om::graphics::gui::objects::ScrollView::clearObjects

(

)

Remove all objects from this scroll view.

virtual Bool om::graphics::gui::objects::ScrollView::setFocus ( Bool  newHasFocus )

virtual

Set whether or not this scroll view currently has keyboard focus at its level in the GUI hierarchy.

Reimplemented from om::graphics::gui::objects::GUIObject.

virtual AABB3f om::graphics::gui::objects::ScrollView::getLocalContentBounds ( ) const

virtual

Return the 3D bounding box for the content view's content display area in its local coordinate frame.

Reimplemented from om::graphics::gui::objects::GUIObject.

AABB3f om::graphics::gui::objects::ScrollView::getLocalContentBoundsTotal ( ) const

inline

Return the total 3D bounding box of this scroll view's content in its local coordinate system.

AABB2f om::graphics::gui::objects::ScrollView::getLocalContentBoundsTotalXY

(

)

const

Return the total bounding box of this scroll view's content in its local coordinate system.

AABB3f om::graphics::gui::objects::ScrollView::getLocalContentBoundsVisible ( ) const

inline

Return the visible 3D bounding box of this scroll view's content in its local coordinate system.

AABB2f om::graphics::gui::objects::ScrollView::getLocalContentBoundsVisibleXY

(

)

const

Return the visible bounding box of this scroll view's content in its local coordinate system.

The returned bounding box depends on the positioning of the scroll view's sliders and the total size of the content.

AABB2f om::graphics::gui::objects::ScrollView::getLocalCornerBoundsXY

(

)

const

Return the bounding box for the scroll view's dragable corner in the local coordinate system.

virtual void om::graphics::gui::objects::ScrollView::update ( Float  dt )

virtual

Update the current internal state of this scroll view for the specified time interval in seconds.

Reimplemented from om::graphics::gui::objects::GUIObject.

virtual Bool om::graphics::gui::objects::ScrollView::drawSelf ( GUIRenderer &  renderer, const AABB3f &  parentBounds  ) const

virtual

Draw this object using the specified GUI renderer to the given parent coordinate system bounds.

The method returns whether or not the object was successfully drawn.

The default implementation draws nothing and returns TRUE.

Reimplemented from om::graphics::gui::objects::GUIObject.

virtual Bool om::graphics::gui::objects::ScrollView::guiEvent ( const GUIEvent &  event )

virtual

Handle the specified GUI event that occured when this scroll view had focus.

Reimplemented from om::gui::input::InputHandler.

virtual Bool om::graphics::gui::objects::ScrollView::textEvent ( const TextEvent &  event )

virtual

Handle the specified text input event that occured when this scroll view had focus.

Reimplemented from om::gui::input::InputHandler.

virtual Bool om::graphics::gui::objects::ScrollView::keyEvent ( const KeyEvent &  event )

virtual

Handle the specified keyboard event that occured when this scroll view had focus.

Reimplemented from om::gui::input::InputHandler.

virtual Bool om::graphics::gui::objects::ScrollView::mouseMotionEvent ( const MouseMotionEvent &  event )

virtual

Handle the specified mouse motion event that occurred.

Reimplemented from om::gui::input::InputHandler.

virtual Bool om::graphics::gui::objects::ScrollView::mouseButtonEvent ( const MouseButtonEvent &  event )

virtual

Handle the specified mouse button event that occurred.

Reimplemented from om::gui::input::InputHandler.

virtual Bool om::graphics::gui::objects::ScrollView::mouseWheelEvent ( const MouseWheelEvent &  event )

virtual

Handle the specified mouse wheel event that occurred.

Reimplemented from om::gui::input::InputHandler.

Float om::graphics::gui::objects::ScrollView::getScrollSpeed ( ) const

inline

Return the scale factor that is used to scale the mouse scrolling speed.

void om::graphics::gui::objects::ScrollView::setScrollSpeed ( Float  newScrollSpeed )

inline

Set the scale factor that is used to scale the mouse scrolling speed.

Member Data Documentation

const Float om::graphics::gui::objects::ScrollView::DEFAULT_SLIDER_WIDTH

static

The default width that is used for a scroll view's sliders.

const Float om::graphics::gui::objects::ScrollView::DEFAULT_MIN_SLIDER_SIZE

static

The default minimum size that is used for a scroll view's sliders.

const Float om::graphics::gui::objects::ScrollView::DEFAULT_SCROLL_SPEED

static

The default scale factor that is used to scale the mouse scrolling speed.

const Border om::graphics::gui::objects::ScrollView::DEFAULT_BORDER

static

The default border that is used for a scroll view.

const Color4f om::graphics::gui::objects::ScrollView::DEFAULT_BACKGROUND_COLOR

static

The default background color that is used for a scroll view's area.

const Color4f om::graphics::gui::objects::ScrollView::DEFAULT_BORDER_COLOR

static

The default border color that is used for a scroll view.

---

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

• omGraphicsGUIScrollView.h