om::graphics::gui::objects::GraphView Class Reference

A class that contains a 2D graph of rectangular cells that can contain child GUI objects. More...

#include <omGraphicsGUIGraphView.h>

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

Classes
class	Delegate
	A class that contains function objects that recieve GraphView events. More...

Public Member Functions
	GraphView ()
	Create a new graph view with no width or height and no visible graph range. More...
	GraphView (const Rectangle &newRectangle, const AABB2f &range)
	Create a new graph view with the given rectangle and visible graph range. More...
const AABB2f &	getRange () const
	Return a 2D range indicating the visible range of values for this graph view's series. More...
void	setRange (const AABB2f &newRange)
	Set a 2D range indicating the visible range of values for this graph view's series. More...
const UTF8String &	getTitle () const
	Return a reference to the string for the title of this graph, describing what it represents. More...
void	setTitle (const UTF8String &newTitle)
	Set a string for the title of this graph, describing what it represents. More...
Bool	getTitleIsEnabled () const
	Return whether or not the main title label for this graph is enabeld. More...
void	setTitleIsEnabled (Bool newTitleIsEnabled)
	Set whether or not the main title label for this graph is enabeld. More...
const fonts::TextStyle &	getTitleStyle () const
	Return a reference to the text style that is used to render the name label for the axis. More...
void	setTitleStyle (const fonts::TextStyle &newTitleStyle)
	Set the text style that is used to render the title label for the axis. More...
const Origin &	getTitleAlignment () const
	Return an object that describes how this graph view's title is aligned. More...
void	setTitleAlignment (const Origin &newTitleAlignment)
	Set an object that describes how this graph view's title is aligned. More...
const GlyphLayout &	getTitleLayout () const
	Return an object indicating the arrangement of title glyphs for the graph view title. More...
GraphViewAxis &	getXAxis ()
	Return an object that describes the appearance of the horizontal graph axis. More...
const GraphViewAxis &	getXAxis () const
	Return an object that describes the appearance of the horizontal graph axis. More...
void	setXAxis (const GraphViewAxis &newXAxis)
	Set an object that describes the appearance of the horizontal graph axis. More...
GraphViewAxis &	getYAxis ()
	Return an object that describes the appearance of the vertical graph axis. More...
const GraphViewAxis &	getYAxis () const
	Return an object that describes the appearance of the vertical graph axis. More...
void	setYAxis (const GraphViewAxis &newYAxis)
	Set an object that describes the appearance of the vertical graph axis. More...
Size	getSeriesCount () const
	Return the total number of series that are part of this graph view. More...
Index	addSeries (IndexedPrimitiveType type, const Color4f &color=Color4f::BLACK, Float weight=Float(2))
	Add a new series to this graph view with the specified type and attributes. More...
IndexedPrimitiveType	getSeriesType (Index seriesIndex) const
	Return the type of the graph series which has the specified index in this graph view. More...
void	setSeriesType (Index seriesIndex, IndexedPrimitiveType newType)
	Set the type of the graph series which has the specified index in this graph view. More...
const Color4f &	getSeriesColor (Index seriesIndex) const
	Return the color of the graph series which has the specified index in this graph view. More...
void	setSeriesColor (Index seriesIndex, const Color4f &newColor)
	Set the color of the graph series which has the specified index in this graph view. More...
Float	getSeriesWeight (Index seriesIndex) const
	Return the display weight in pixels of the graph series which has the specified index in this graph view. More...
void	setSeriesWeight (Index seriesIndex, Float newWeight)
	Set the display weight in pixels of the graph series which has the specified index in this graph view. More...
const ArrayList< Vector2f > &	getSeriesData (Index seriesIndex) const
	Return a reference to the current array of data points for the specified graph series. More...
void	refresh ()
	Refresh all of the graph view's data for all of its series. More...
void	refreshSeries (Index seriesIndex)
	Refresh the graph series with the specified index in this graph view. More...
AABB2f	getLocalGraphBoundsXY () const
	Return the local bounding box of the graph view's graph area. More...
AABB2f	getLocalGraphContentBoundsXY () const
	Return the local bounding box of the graph view's graph area. More...
AABB2f	getLocalXAxisBoundsXY () const
	Return the local bounding box of the graph view's x axis label area. More...
AABB2f	getLocalYAxisBoundsXY () const
	Return the local bounding box of the graph view's y axis label area. More...
AABB2f	getLocalTitleBoundsXY () const
	Return the local bounding box of the graph view's title area. More...
virtual Bool	drawSelf (GUIRenderer &renderer, const AABB3f &parentBounds) const
	Draw this graph view using the specified GUI renderer to the given parent coordinate system bounds. More...
virtual Bool	keyEvent (const KeyEvent &event)
	Handle the specified keyboard event for the entire graph view. More...
virtual Bool	mouseButtonEvent (const MouseButtonEvent &event)
	Handle the specified mouse button event for the entire graph view. More...
virtual Bool	mouseMotionEvent (const MouseMotionEvent &event)
	Handle the specified mouse motion event for the entire graph view. More...
virtual Bool	mouseWheelEvent (const MouseWheelEvent &event)
	Handle the specified mouse wheel event for the entire graph view. 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...
Delegate &	getDelegate ()
	Return a reference to the delegate which responds to events for this graph view. More...
const Delegate &	getDelegate () const
	Return a reference to the delegate which responds to events for this graph view. More...
void	setDelegate (const Delegate &newDelegate)
	Return a reference to the delegate which responds to events for this graph view. More...
const RectangleStyle &	getGraphStyle () const
	Return an object that describes the style of the graph area rectangle of this graph view. More...
void	setGraphStyle (const RectangleStyle &newGraphStyle)
	Set an object that describes the style of the graph area rectangle of this graph view. 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...
virtual Bool	setSize (const Vector3f &newSize)
	Set the 3D size 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...
virtual Bool	resizeForContent ()
	Resize this object to fit tightly around its contents, if possible. 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...
virtual AABB3f	getLocalContentBounds () const
	Return the 3D 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...
virtual Bool	setFocus (Bool newHasFocus)
	Set whether or not this GUI object currently has keyboard focus at its level in the GUI hierarchy. More...
virtual void	update (Float dt)
	Update the current internal state of this object for the specified time interval in seconds. More...
Public Member Functions inherited from om::gui::input::InputHandler
virtual	~InputHandler ()
	Destroy an input handler. More...
virtual Bool	guiEvent (const GUIEvent &event)
	Handle the specified GUI event that occured when this object had focus. More...
virtual Bool	textEvent (const TextEvent &event)
	Handle the specified text input event that occured when this object had focus. More...

Static Public Attributes
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 graph view. More...
static const Color4f	DEFAULT_BACKGROUND_COLOR
	The default background color that is used for a graph view's area. More...
static const Color4f	DEFAULT_BORDER_COLOR
	The default border color that is used for a graph view. More...
static const Margin	DEFAULT_GRAPH_MARGIN
	The default outside margin that is used for a graph view's graph area. More...
static const Border	DEFAULT_GRAPH_BORDER
	The default border that is used for a graph view's graph area. More...
static const Color4f	DEFAULT_GRAPH_BACKGROUND_COLOR
	The default background color that is used for a graph view's graph area. More...
static const Color4f	DEFAULT_GRAPH_BORDER_COLOR
	The default border color that is used for a graph view's graph area. More...
static const Float	DEFAULT_TITLE_TEXT_SIZE
	The default font size that is used for an graph's title label text. More...
static const Color4f	DEFAULT_TITLE_TEXT_COLOR
	The default color that is used for an graph's title label text. More...

Detailed Description

A class that contains a 2D graph of rectangular cells that can contain child GUI objects.

A graph view is an optionally-bordered rectangular area whose content area (inside the border) is divided into a 2D graph of cells. Each cell can contain any number of child GUI objects.

Constructor & Destructor Documentation

om::graphics::gui::objects::GraphView::GraphView

(

)

Create a new graph view with no width or height and no visible graph range.

om::graphics::gui::objects::GraphView::GraphView	(	const Rectangle &	newRectangle,
		const AABB2f &	range
	)

Create a new graph view with the given rectangle and visible graph range.

Member Function Documentation

const AABB2f& om::graphics::gui::objects::GraphView::getRange ( ) const

inline

Return a 2D range indicating the visible range of values for this graph view's series.

void om::graphics::gui::objects::GraphView::setRange ( const AABB2f &  newRange )

inline

Set a 2D range indicating the visible range of values for this graph view's series.

Changing the visible range for the graph view causes it to refresh the currently visible data points in the same way that refresh() does.

const UTF8String& om::graphics::gui::objects::GraphView::getTitle ( ) const

inline

Return a reference to the string for the title of this graph, describing what it represents.

void om::graphics::gui::objects::GraphView::setTitle

(

const UTF8String &

newTitle

)

Set a string for the title of this graph, describing what it represents.

Bool om::graphics::gui::objects::GraphView::getTitleIsEnabled ( ) const

inline

Return whether or not the main title label for this graph is enabeld.

void om::graphics::gui::objects::GraphView::setTitleIsEnabled ( Bool  newTitleIsEnabled )

inline

Set whether or not the main title label for this graph is enabeld.

const fonts::TextStyle& om::graphics::gui::objects::GraphView::getTitleStyle ( ) const

inline

Return a reference to the text style that is used to render the name label for the axis.

void om::graphics::gui::objects::GraphView::setTitleStyle

(

const fonts::TextStyle &

newTitleStyle

)

Set the text style that is used to render the title label for the axis.

const Origin& om::graphics::gui::objects::GraphView::getTitleAlignment ( ) const

inline

Return an object that describes how this graph view's title is aligned.

void om::graphics::gui::objects::GraphView::setTitleAlignment ( const Origin &  newTitleAlignment )

inline

Set an object that describes how this graph view's title is aligned.

const GlyphLayout& om::graphics::gui::objects::GraphView::getTitleLayout ( ) const

inline

Return an object indicating the arrangement of title glyphs for the graph view title.

GraphViewAxis& om::graphics::gui::objects::GraphView::getXAxis ( )

inline

Return an object that describes the appearance of the horizontal graph axis.

const GraphViewAxis& om::graphics::gui::objects::GraphView::getXAxis ( ) const

inline

Return an object that describes the appearance of the horizontal graph axis.

void om::graphics::gui::objects::GraphView::setXAxis ( const GraphViewAxis &  newXAxis )

inline

Set an object that describes the appearance of the horizontal graph axis.

GraphViewAxis& om::graphics::gui::objects::GraphView::getYAxis ( )

inline

Return an object that describes the appearance of the vertical graph axis.

const GraphViewAxis& om::graphics::gui::objects::GraphView::getYAxis ( ) const

inline

Return an object that describes the appearance of the vertical graph axis.

void om::graphics::gui::objects::GraphView::setYAxis ( const GraphViewAxis &  newYAxis )

inline

Set an object that describes the appearance of the vertical graph axis.

Size om::graphics::gui::objects::GraphView::getSeriesCount ( ) const

inline

Return the total number of series that are part of this graph view.

Index om::graphics::gui::objects::GraphView::addSeries ( IndexedPrimitiveType  type, const Color4f &  color = Color4f::BLACK, Float  weight = Float(2)  )

inline

Add a new series to this graph view with the specified type and attributes.

The method adds a new series to the graph. The data for the series will be refreshed from the delegate the next time that the graph view is drawn.

The method returns the index of the new series.

IndexedPrimitiveType om::graphics::gui::objects::GraphView::getSeriesType ( Index  seriesIndex ) const

inline

Return the type of the graph series which has the specified index in this graph view.

If the specified series index is invalid, SeriesType::UNDEFINED is returned.

void om::graphics::gui::objects::GraphView::setSeriesType ( Index  seriesIndex, IndexedPrimitiveType  newType  )

inline

Set the type of the graph series which has the specified index in this graph view.

If the specified series index is invalid, the method has no effect.

const Color4f& om::graphics::gui::objects::GraphView::getSeriesColor ( Index  seriesIndex ) const

inline

Return the color of the graph series which has the specified index in this graph view.

If the specified series index is invalid, Color4f::ZERO is returned.

void om::graphics::gui::objects::GraphView::setSeriesColor ( Index  seriesIndex, const Color4f &  newColor  )

inline

Set the color of the graph series which has the specified index in this graph view.

If the specified series index is invalid, the method has no effect.

Float om::graphics::gui::objects::GraphView::getSeriesWeight ( Index  seriesIndex ) const

inline

Return the display weight in pixels of the graph series which has the specified index in this graph view.

If the specified series index is invalid, 0 is returned.

void om::graphics::gui::objects::GraphView::setSeriesWeight ( Index  seriesIndex, Float  newWeight  )

inline

Set the display weight in pixels of the graph series which has the specified index in this graph view.

If the specified series index is invalid, the method has no effect.

const ArrayList<Vector2f>& om::graphics::gui::objects::GraphView::getSeriesData ( Index  seriesIndex ) const

inline

Return a reference to the current array of data points for the specified graph series.

The returned array represents the current state of the series, though it may change if the series is updated by the delegate.

void om::graphics::gui::objects::GraphView::refresh

(

)

Refresh all of the graph view's data for all of its series.

The graph view calls the updateSeries delegate method for each series to update its internal data structures with the new data.

void om::graphics::gui::objects::GraphView::refreshSeries

(

Index

seriesIndex

)

Refresh the graph series with the specified index in this graph view.

The graph view calls the updateSeries delegate method to update its internal data structures with the new data.

AABB2f om::graphics::gui::objects::GraphView::getLocalGraphBoundsXY

(

)

const

Return the local bounding box of the graph view's graph area.

AABB2f om::graphics::gui::objects::GraphView::getLocalGraphContentBoundsXY

(

)

const

Return the local bounding box of the graph view's graph area.

AABB2f om::graphics::gui::objects::GraphView::getLocalXAxisBoundsXY

(

)

const

Return the local bounding box of the graph view's x axis label area.

AABB2f om::graphics::gui::objects::GraphView::getLocalYAxisBoundsXY

(

)

const

Return the local bounding box of the graph view's y axis label area.

AABB2f om::graphics::gui::objects::GraphView::getLocalTitleBoundsXY

(

)

const

Return the local bounding box of the graph view's title area.

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

virtual

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

The method returns whether or not the graph view was successfully drawn.

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

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

virtual

Handle the specified keyboard event for the entire graph view.

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

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

virtual

Handle the specified mouse button event for the entire graph view.

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

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

virtual

Handle the specified mouse motion event for the entire graph view.

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

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

virtual

Handle the specified mouse wheel event for the entire graph view.

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

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

inline

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

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

inline

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

Delegate& om::graphics::gui::objects::GraphView::getDelegate ( )

inline

Return a reference to the delegate which responds to events for this graph view.

const Delegate& om::graphics::gui::objects::GraphView::getDelegate ( ) const

inline

Return a reference to the delegate which responds to events for this graph view.

void om::graphics::gui::objects::GraphView::setDelegate ( const Delegate &  newDelegate )

inline

Return a reference to the delegate which responds to events for this graph view.

const RectangleStyle& om::graphics::gui::objects::GraphView::getGraphStyle ( ) const

inline

Return an object that describes the style of the graph area rectangle of this graph view.

void om::graphics::gui::objects::GraphView::setGraphStyle

(

const RectangleStyle &

newGraphStyle

)

Set an object that describes the style of the graph area rectangle of this graph view.

Member Data Documentation

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

static

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

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

static

The default border that is used for a graph view.

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

static

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

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

static

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

const Margin om::graphics::gui::objects::GraphView::DEFAULT_GRAPH_MARGIN

static

The default outside margin that is used for a graph view's graph area.

const Border om::graphics::gui::objects::GraphView::DEFAULT_GRAPH_BORDER

static

The default border that is used for a graph view's graph area.

const Color4f om::graphics::gui::objects::GraphView::DEFAULT_GRAPH_BACKGROUND_COLOR

static

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

const Color4f om::graphics::gui::objects::GraphView::DEFAULT_GRAPH_BORDER_COLOR

static

The default border color that is used for a graph view's graph area.

const Float om::graphics::gui::objects::GraphView::DEFAULT_TITLE_TEXT_SIZE

static

The default font size that is used for an graph's title label text.

const Color4f om::graphics::gui::objects::GraphView::DEFAULT_TITLE_TEXT_COLOR

static

The default color that is used for an graph's title label text.

---

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

• omGraphicsGUIGraphView.h