A class that represents the base class for an interactive rectangular region within a GUI. More...

#include <omGraphicsGUIObject.h>

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

Public Member Functions
	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...

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...

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...

virtual Bool	keyEvent (const KeyEvent &event)
	Handle the specified keyboard event that occured when this object had focus. More...

virtual Bool	mouseButtonEvent (const MouseButtonEvent &event)
	Handle the specified mouse button event that occurred. More...

virtual Bool	mouseMotionEvent (const MouseMotionEvent &event)
	Handle the specified mouse motion event that occurred. More...

virtual Bool	mouseWheelEvent (const MouseWheelEvent &event)
	Handle the specified mouse wheel event that occurred. More...

Detailed Description

A class that represents the base class for an interactive rectangular region within a GUI.

Constructor & Destructor Documentation

om::graphics::gui::objects::GUIObject::GUIObject ( )

Create a default visible GUI object positioned at the origin (0,0) with 0 width and 0 height.

om::graphics::gui::objects::GUIObject::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.

om::graphics::gui::objects::GUIObject::GUIObject ( const Rectangle & newRectangle )

Create a visible GUI object that occupies the specified rectangle.

om::graphics::gui::objects::GUIObject::GUIObject	(	const Rectangle &	newRectangle,
		const RectangleStyle &	newRectangleStyle
	)

Create a visible GUI object that occupies the specified rectangle and rectangle style.

virtual om::graphics::gui::objects::GUIObject::~GUIObject ( )

virtual

Destory the GUI object, releasing all internal resources.

Member Function Documentation

const Rectangle& om::graphics::gui::objects::GUIObject::getRectangle ( ) const

inline

Return a reference to this GUI object's rectangle.

This object represents the object's positioning and rotation relative to its parent coordinate system.

const Vector3f& om::graphics::gui::objects::GUIObject::getSize ( ) const

inline

Return a reference to the 3D size of this object along each of its local axes.

const Vector2f& om::graphics::gui::objects::GUIObject::getSizeXY ( ) const

inline

Return a reference to the 2D scaling factor of this object along each of its local axes.

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

virtual

Set the 3D size of this object along each of its local axes.

The method returns whether or not the size of the object was able to be changed.

Reimplemented in om::graphics::gui::objects::TreeView, om::graphics::gui::objects::TagView, om::graphics::gui::objects::TabView, om::graphics::gui::objects::GridView, om::graphics::gui::objects::SplitView, om::graphics::gui::objects::ListView, om::graphics::gui::objects::ButtonBar, om::graphics::gui::objects::TextField, om::graphics::gui::objects::NumberField, om::graphics::gui::objects::GUIObjectWrapper, om::graphics::gui::objects::SearchField, and om::graphics::gui::objects::ScrollView.

Bool om::graphics::gui::objects::GUIObject::setSize ( const Vector2f & newSizeXY )

inline

Set the 2D size of this object along the X and Y local axes.

Bool om::graphics::gui::objects::GUIObject::setSize	(	Float	newWidth,
		Float	newHeight
	)

inline

Set the 2D size of this object along the X and Y local axes.

Bool om::graphics::gui::objects::GUIObject::setSizeX ( Float newWidth )

inline

Set the size of this object along the X axis.

Bool om::graphics::gui::objects::GUIObject::setSizeY ( Float newHeight )

inline

Set the size of this object along the Y axis.

Bool om::graphics::gui::objects::GUIObject::setSizeZ ( Float newDepth )

inline

Set the size of this object along the Z axis.

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

virtual

Resize this object to fit tightly around its contents, if possible.

The method returns whether or not the size was changed. The default implementation does nothing and returns FALSE.

Reimplemented in om::graphics::gui::objects::TreeView, om::graphics::gui::objects::TagView, om::graphics::gui::objects::GridView, om::graphics::gui::objects::ListView, om::graphics::gui::objects::ObjectView, om::graphics::gui::objects::ButtonBar, om::graphics::gui::objects::ImageView, om::graphics::gui::objects::TextField, om::graphics::gui::objects::GUIObjectWrapper, and om::graphics::gui::objects::ScrollView.

void om::graphics::gui::objects::GUIObject::fillParent ( const Vector3f & parentSize )

Resize and resposition this object so that it fills the specified parent bounding box size.

const Vector3f& om::graphics::gui::objects::GUIObject::getScale ( ) const

inline

Return a reference to the 3D scaling factor of this object along each of its local axes.

const Vector2f& om::graphics::gui::objects::GUIObject::getScaleXY ( ) const

inline

Return a reference to the 2D scaling factor of this object along each of its local axes.

virtual Bool om::graphics::gui::objects::GUIObject::setScale ( const Vector3f & newScale )

virtual

Set the 3D scaling factor of this object along each of its local axes.

The method returns whether or not the scale of the object was able to be changed.

Reimplemented in om::graphics::gui::objects::GUIObjectWrapper.

Bool om::graphics::gui::objects::GUIObject::setScale ( const Vector2f & newScaleXY )

inline

Set the 2D scaling factor of this object along the X and Y local axes.

Bool om::graphics::gui::objects::GUIObject::setScale	(	Float	newScaleX,
		Float	newScaleY
	)

inline

Set the 2D scaling factor of this object along the X and Y local axes.

Bool om::graphics::gui::objects::GUIObject::setScale ( Float newScale )

inline

Set the scaling factor of this object along all 3 axes.

const Vector3f& om::graphics::gui::objects::GUIObject::getPosition ( ) const

inline

Return the position of this GUI object's origin relative to its parent's coordinate origin.

const Vector2f& om::graphics::gui::objects::GUIObject::getPositionXY ( ) const

inline

Return the 2D position of this GUI object's origin relative to its parent's coordinate origin.

Bool om::graphics::gui::objects::GUIObject::setPosition ( const Vector2f & newPosition )

inline

Set the position of this GUI object's origin relative to its parent's coordinate origin.

virtual Bool om::graphics::gui::objects::GUIObject::setPosition ( const Vector3f & newPosition )

virtual

Set the position of this GUI object's origin relative to its parent's coordinate origin.

The method returns whether or not the position and origin of the object was able to be changed.

Reimplemented in om::graphics::gui::objects::GUIObjectWrapper.

const Matrix3f& om::graphics::gui::objects::GUIObject::getRotation ( ) const

inline

Return a 3x3 orthonormal matrix indicating the basis of this object's coordinate frame.

virtual Bool om::graphics::gui::objects::GUIObject::setRotation ( const Matrix3f & newRotation )

virtual

Set a 3x3 orthonormal matrix indicating the basis of this object's coordinate frame.

The method returns whether or not the rotation of the object was able to be changed.

Reimplemented in om::graphics::gui::objects::GUIObjectWrapper.

Bool om::graphics::gui::objects::GUIObject::setRotation ( Float radians )

inline

Set the rotation of this GUI object to be along the Z-axis with a rotation specified in radians.

The method returns whether or not the rotation of the object was able to be changed.

Bool om::graphics::gui::objects::GUIObject::setRotationDegrees ( Float degrees )

inline

Set the rotation of this GUI object to be along the Z-axis with a rotation specified in degrees.

The method returns whether or not the rotation of the object was able to be changed.

Origin& om::graphics::gui::objects::GUIObject::getOrigin ( )

inline

Return the alignment of the coordinate origin for this object.

const Origin& om::graphics::gui::objects::GUIObject::getOrigin ( ) const

inline

Return the alignment of the coordinate origin for this object.

virtual Bool om::graphics::gui::objects::GUIObject::setOrigin ( const Origin & newPositionOrigin )

virtual

Set the alignment of the coordinate origin for this object.

The method returns whether or not the origin of the object was able to be changed.

Reimplemented in om::graphics::gui::objects::ButtonBar, and om::graphics::gui::objects::GUIObjectWrapper.

void om::graphics::gui::objects::GUIObject::setOrigin	(	Origin::XOrigin	newXOrigin,
		Origin::YOrigin	newYOrigin
	)

inline

Set the XY alignment of the coordinate origin for this object.

void om::graphics::gui::objects::GUIObject::setOrigin	(	Origin::XOrigin	newXOrigin,
		Origin::YOrigin	newYOrigin,
		Origin::ZOrigin	newZOrigin
	)

inline

Set the XYZ alignment of the coordinate origin for this object.

AABB2f om::graphics::gui::objects::GUIObject::getBoundsInParent ( const AABB2f & parentBounds ) const

inline

Return the 2D bounding box of this object in the coordinate frame of the specified parent bounding box.

AABB3f om::graphics::gui::objects::GUIObject::getBoundsInParent ( const AABB3f & parentBounds ) const

inline

Return the 3D bounding box of this object in the coordinate frame of the specified parent bounding box.

AABB2f om::graphics::gui::objects::GUIObject::getLocalBoundsXY ( ) const

inline

Return the 2D bounding box of this object in its local coordinate frame.

AABB3f om::graphics::gui::objects::GUIObject::getLocalBounds ( ) const

inline

Return the 3D bounding box of this object in its local coordinate frame.

Vector2f om::graphics::gui::objects::GUIObject::getLocalCenterXY ( ) const

inline

Return the 2D center of this object's rectangle in its local coordinate frame.

Vector3f om::graphics::gui::objects::GUIObject::getLocalCenter ( ) const

inline

Return the 3D center of this object's rectangle in its local coordinate frame.

Matrix4f om::graphics::gui::objects::GUIObject::getTransformMatrix ( const AABB3f & parentBounds ) const

inline

Return the object-space-to-parent-space homogeneous transformation matrix for the given parent bounding box.

Vector2f om::graphics::gui::objects::GUIObject::transformToLocal	(	const Vector2f &	pointInParent,
		const AABB2f &	parentBounds
	)		const

inline

Transform a 3D point in the parent coordinate system into this object's coordinate system.

Vector3f om::graphics::gui::objects::GUIObject::transformToLocal	(	const Vector3f &	pointInParent,
		const AABB3f &	parentBounds
	)		const

inline

Transform a 3D point in the parent coordinate system into this object's coordinate system.

Vector2f om::graphics::gui::objects::GUIObject::transformFromLocal	(	const Vector2f &	localPoint,
		const AABB2f &	parentBounds
	)		const

inline

Transform a 2D point in this object's local coordinate system into its parent's coordinate system.

Vector3f om::graphics::gui::objects::GUIObject::transformFromLocal	(	const Vector3f &	localPoint,
		const AABB3f &	parentBounds
	)		const

inline

Transform a 3D point in this object's local coordinate system into its parent's coordinate system.

Vector2f om::graphics::gui::objects::GUIObject::transformVectorToLocal ( const Vector2f & vectorInParent ) const

inline

Transform a 3D vector in the parent coordinate system into this object's coordinate system.

Vector3f om::graphics::gui::objects::GUIObject::transformVectorToLocal ( const Vector3f & vectorInParent ) const

inline

Transform a 3D vector in the parent coordinate system into this object's coordinate system.

Vector2f om::graphics::gui::objects::GUIObject::transformVectorFromLocal ( const Vector2f & localVector ) const

inline

Transform a 2D vector in this object's local coordinate system into its parent's coordinate system.

Vector3f om::graphics::gui::objects::GUIObject::transformVectorFromLocal ( const Vector3f & localVector ) const

inline

Transform a 3D vector in this object's local coordinate system into its parent's coordinate system.

MouseButtonEvent om::graphics::gui::objects::GUIObject::transformEventToLocal	(	const MouseButtonEvent &	event,
		const AABB2f &	parentBounds
	)		const

inline

Transform a mouse button event in the parent coordinate system into this object's coordinate system.

MouseButtonEvent om::graphics::gui::objects::GUIObject::transformEventFromLocal	(	const MouseButtonEvent &	event,
		const AABB2f &	parentBounds
	)		const

inline

Transform a mouse button event in this object's local coordinate system into its parent's coordinate system.

MouseMotionEvent om::graphics::gui::objects::GUIObject::transformEventToLocal	(	const MouseMotionEvent &	event,
		const AABB2f &	parentBounds
	)		const

inline

Transform a mouse motion event in the parent coordinate system into this object's coordinate system.

MouseMotionEvent om::graphics::gui::objects::GUIObject::transformEventFromLocal	(	const MouseMotionEvent &	event,
		const AABB2f &	parentBounds
	)		const

inline

Transform a mouse motion event in this object's local coordinate system into its parent's coordinate system.

MouseWheelEvent om::graphics::gui::objects::GUIObject::transformEventToLocal	(	const MouseWheelEvent &	event,
		const AABB2f &	parentBounds
	)		const

inline

Transform a mouse wheel event in the parent coordinate system into this object's coordinate system.

MouseWheelEvent om::graphics::gui::objects::GUIObject::transformEventFromLocal	(	const MouseWheelEvent &	event,
		const AABB2f &	parentBounds
	)		const

inline

Transform a mouse wheel event in this object's local coordinate system into its parent's coordinate system.

virtual Bool om::graphics::gui::objects::GUIObject::containsLocalPoint ( const Vector2f & localPoint ) const

virtual

Return whether or not this GUI object contains the specified local 2D point within its local bounds.

This method is used to determine whether or not a 2D point is contained within this GUI object's projected area. The default implementation tests against the bounding box of the object. The method may be overidden to handle objects with arbitrary shapes.

Reimplemented in om::graphics::gui::objects::Knob.

virtual Bool om::graphics::gui::objects::GUIObject::containsLocalPoint ( const Vector3f & localPoint ) const

virtual

Return whether or not this GUI object contains the specified local 3D point within its local bounds.

This method is used to determine whether or not a 3D point is contained within this GUI object's volume. The default implementation tests against the bounding box of the object. The method may be overidden to handle objects with arbitrary shapes.

Reimplemented in om::graphics::gui::objects::Knob.

AABB2f om::graphics::gui::objects::GUIObject::getLocalContentBoundsXY ( ) const

inline

Return the 2D bounding box for the object's rectangle inside area in its local coordinate frame.

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

virtual

Return the 3D bounding box for the object's rectangle inside area in its local coordinate frame.

Reimplemented in om::graphics::gui::objects::TabView, and om::graphics::gui::objects::ScrollView.

GUIStyle* om::graphics::gui::objects::GUIObject::getStyle ( ) const

inline

Return a pointer to the style object to use when drawing this GUI object.

void om::graphics::gui::objects::GUIObject::setStyle ( GUIStyle * newStyle )

inline

Set a pointer to the style object to use when drawing this GUI object.

const RectangleStyle& om::graphics::gui::objects::GUIObject::getRectangleStyle ( ) const

inline

Return an object that describes the style of the main outside rectangle of this object.

virtual Bool om::graphics::gui::objects::GUIObject::setRectangleStyle ( const RectangleStyle & newRectangleStyle )

virtual

Set an object that describes the style of the main outside rectangle of this object.

Reimplemented in om::graphics::gui::objects::GUIObjectWrapper.

const Border& om::graphics::gui::objects::GUIObject::getBorder ( ) const

inline

Return an object that describes the border for this object's main rectangle.

virtual Bool om::graphics::gui::objects::GUIObject::setBorder ( const Border & newBorder )

virtual

Set an object that describes the border for this object's main rectangle.

The method returns whether or not the border color was able to be changed.

Reimplemented in om::graphics::gui::objects::NumberField, om::graphics::gui::objects::TextField, om::graphics::gui::objects::TagView, om::graphics::gui::objects::SearchField, om::graphics::gui::objects::Knob, om::graphics::gui::objects::ListView, om::graphics::gui::objects::ButtonBar, and om::graphics::gui::objects::GUIObjectWrapper.

Float om::graphics::gui::objects::GUIObject::getBorderWidth ( ) const

inline

Return the width of this object's main rectangle border.

Bool om::graphics::gui::objects::GUIObject::setBorderWidth ( Float newWidth )

inline

Set the width of this object's main rectangle border.

The method returns whether or not the border width was able to be changed.

Float om::graphics::gui::objects::GUIObject::getBorderRadius ( ) const

inline

Return the corner radius of this object's main rectangle border.

Bool om::graphics::gui::objects::GUIObject::setBorderRadius ( Float newRadius )

inline

Set the corner radius of this object's main rectangle border.

The method returns whether or not the border radius was able to be changed.

const Margin& om::graphics::gui::objects::GUIObject::getBorderMargin ( ) const

inline

Return an object that describes the padding between the exterior and interior of the object's main rectangle.

Bool om::graphics::gui::objects::GUIObject::setBorderMargin ( const Margin & newMargin )

inline

Set an object that describes the padding between the exterior and interior of the object's main rectangle.

The method returns whether or not the border margin was able to be changed.

const Color4f& om::graphics::gui::objects::GUIObject::getBackgroundColor ( ) const

inline

Return the background color for this object's main rectangle.

virtual Bool om::graphics::gui::objects::GUIObject::setBackgroundColor ( const Color4f & newBackgroundColor )

virtual

Set the background color for this object's main rectangle.

The method returns whether or not the border color was able to be changed.

Reimplemented in om::graphics::gui::objects::NumberField, om::graphics::gui::objects::TagView, om::graphics::gui::objects::SearchField, om::graphics::gui::objects::ButtonBar, and om::graphics::gui::objects::GUIObjectWrapper.

const Color4f& om::graphics::gui::objects::GUIObject::getBorderColor ( ) const

inline

Return the border color used when rendering the object's main rectangle.

virtual Bool om::graphics::gui::objects::GUIObject::setBorderColor ( const Color4f & newBorderColor )

virtual

Set the border color used when rendering the object's main rectangle.

The method returns whether or not the border color was able to be changed.

Reimplemented in om::graphics::gui::objects::NumberField, om::graphics::gui::objects::TagView, om::graphics::gui::objects::SearchField, om::graphics::gui::objects::ButtonBar, and om::graphics::gui::objects::GUIObjectWrapper.

const GUIObjectFlags& om::graphics::gui::objects::GUIObject::getFlags ( ) const

inline

Return a const reference to the flags for this GUI object.

Bool om::graphics::gui::objects::GUIObject::flagIsSet ( GUIObjectFlags::Flag flag ) const

inline

Return whether or not the specified boolan flag is set for this GUI object.

virtual Bool om::graphics::gui::objects::GUIObject::setFlags ( const GUIObjectFlags & newFlags )

virtual

Set the flags for this GUI object.

The method returns whether or not the flags were able to be changed.

Reimplemented in om::graphics::gui::objects::GUIObjectWrapper.

Bool om::graphics::gui::objects::GUIObject::setFlag	(	GUIObjectFlags::Flag	flag,
		Bool	newIsSet = `true`
	)

inline

Set whether or not the specified boolan flag is set for this GUI object.

The method returns whether or not the flags were able to be changed.

Bool om::graphics::gui::objects::GUIObject::getIsVisible ( ) const

inline

Return whether or not this GUI object should be drawn to the screen.

void om::graphics::gui::objects::GUIObject::setIsVisible ( Bool newIsVisible )

inline

Set whether or not this GUI object should be drawn to the screen.

Bool om::graphics::gui::objects::GUIObject::hasFocus ( ) const

inline

Return whether or not this GUI object currently has keyboard focus at its level in the GUI hierarchy.

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

virtual

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

This method is usually called by the parent object to indicate that a given object has gained focus in its level of the object hierarchy.

The method returns whether or not the object is able to accept the keyboard focus. The default implementation sets the focus state directly and returns the input state.

If the focus is lost, object that have children should propagate the lost focus down to their children.

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

virtual

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

This method can be used to update animations or other time-based effects that require a regular update interval. This method is usually called once for each frame that is rendered, but could be called at a different rate if desired.

Objects are responsible for calling update() with the same time parameter for all child GUI objects that need to be updated.

virtual Bool om::graphics::gui::objects::GUIObject::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.

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

omGraphicsGUIObject.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation