A class that allows the user to select from a list of options using a menu. More...

#include <omGraphicsGUIOptionMenu.h>

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

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

Public Member Functions
	OptionMenu ()
	Create a new option menu with no width or height positioned at the origin. More...

	OptionMenu (const Rectangle &newRectangle)
	Create a new empty option menu which occupies the specified rectangular region. More...

Size	getItemCount () const
	Return the total number of items that are part of this option menu. More...

MenuItem *	getItem (Index itemIndex) const
	Return a pointer to the item at the specified index in this option menu. More...

Bool	addItem (MenuItem *newItem)
	Add the specified item to this option menu. More...

Bool	insertItem (Index itemIndex, MenuItem *newItem)
	Insert the specified item at the given index in this option menu. More...

Bool	setItem (Index itemIndex, MenuItem *newItem)
	Replace the specified item at the given index in this option menu. More...

Bool	removeItem (const MenuItem *oldItem)
	Remove the specified item from this option menu. More...

Bool	removeItemAtIndex (Index itemIndex)
	Remove the item at the specified index from this option menu. More...

void	clearItems ()
	Remove all items from this option menu. More...

Int	getSelectedItemIndex () const
	Return the index of the currently selected item in this menu. More...

void	setSelectedItemIndex (Int newSelectedItemIndex)
	Set the index of the currently selected item in this menu. More...

Bool	getIsOpen () const
	Return whether or not this option menu is currently open, with the popup menu showing. More...

const Menu &	getMenu () const
	Return a const reference to the menu object for this option menu. More...

const TextStyle &	getTextStyle () const
	Return a reference to the text style that is used to render the text for a option menu. More...

void	setTextStyle (const TextStyle &newTextStyle)
	Set the text style that is used to render the text for a option menu. More...

Delegate &	getDelegate ()
	Return a reference to the delegate which responds to events for this option menu. More...

const Delegate &	getDelegate () const
	Return a reference to the delegate which responds to events for this option menu. More...

void	setDelegate (const Delegate &newDelegate)
	Return a reference to the delegate which responds to events for this option menu. More...

virtual Bool	drawSelf (GUIRenderer &renderer, const AABB3f &parentBounds) const
	Draw this option menu using the specified GUI renderer to the given parent coordinate system bounds. More...

virtual Bool	mouseButtonEvent (const MouseButtonEvent &event)
	Handle the specified mouse button event for the entire option menu. 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...

virtual Bool	keyEvent (const KeyEvent &event)
	Handle the specified keyboard event that occured when this object had focus. 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...

Static Public Attributes
static const Border	DEFAULT_BORDER
	The default border that is used for an option menu. More...

static const Color4f	DEFAULT_BACKGROUND_COLOR
	The default background color that is used for an option menu's area. More...

static const Color4f	DEFAULT_BORDER_COLOR
	The default border color that is used for an option menu. More...

static const Color4f	DEFAULT_ARROW_COLOR
	The default color for the down arrow for an option menu. More...

static const Color4f	DEFAULT_DIVIDER_COLOR
	The default color for the down arrow divider line for an option menu. More...

Detailed Description

A class that allows the user to select from a list of options using a menu.

Each item is represented by a MenuItem.

Constructor & Destructor Documentation

om::graphics::gui::objects::OptionMenu::OptionMenu ( )

Create a new option menu with no width or height positioned at the origin.

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

Create a new empty option menu which occupies the specified rectangular region.

Member Function Documentation

Size om::graphics::gui::objects::OptionMenu::getItemCount ( ) const

inline

Return the total number of items that are part of this option menu.

MenuItem* om::graphics::gui::objects::OptionMenu::getItem ( Index itemIndex ) const

inline

Return a pointer to the item at the specified index in this option menu.

Bool om::graphics::gui::objects::OptionMenu::addItem ( MenuItem * newItem )

inline

Add the specified item to this option menu.

If the specified item pointer is NULL, the method fails and FALSE is returned. Otherwise, the item is appended to the end of the menu and TRUE is returned.

Bool om::graphics::gui::objects::OptionMenu::insertItem	(	Index	itemIndex,
		MenuItem *	newItem
	)

inline

Insert the specified item at the given index in this option menu.

If the specified item pointer is NULL, the method fails and FALSE is returned. Otherwise, the item is inserted at the given index in the menu and TRUE is returned.

Bool om::graphics::gui::objects::OptionMenu::setItem	(	Index	itemIndex,
		MenuItem *	newItem
	)

inline

Replace the specified item at the given index in this option menu.

If the specified item pointer is NULL or if the item has an invalid type, the method fails and FALSE is returned. Otherwise, the item is inserted at the given index in the menu and TRUE is returned.

Bool om::graphics::gui::objects::OptionMenu::removeItem ( const MenuItem * oldItem )

inline

Remove the specified item from this option menu.

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

Bool om::graphics::gui::objects::OptionMenu::removeItemAtIndex ( Index itemIndex )

inline

Remove the item at the specified index from this option menu.

If the specified index is invalid, FALSE is returned and the Menu is unaltered. Otherwise, the item at that index is removed and TRUE is returned.

void om::graphics::gui::objects::OptionMenu::clearItems ( )

inline

Remove all items from this option menu.

Int om::graphics::gui::objects::OptionMenu::getSelectedItemIndex ( ) const

inline

Return the index of the currently selected item in this menu.

If there is no currently selected item, -1 is returned.

void om::graphics::gui::objects::OptionMenu::setSelectedItemIndex ( Int newSelectedItemIndex )

inline

Set the index of the currently selected item in this menu.

If an invalid index is specified, such as -1, the selected item is cleared.

Bool om::graphics::gui::objects::OptionMenu::getIsOpen ( ) const

inline

Return whether or not this option menu is currently open, with the popup menu showing.

const Menu& om::graphics::gui::objects::OptionMenu::getMenu ( ) const

inline

Return a const reference to the menu object for this option menu.

This method is provided primarily so that renderers can access the menu to draw it. The returned object should not be modified directly.

const TextStyle& om::graphics::gui::objects::OptionMenu::getTextStyle ( ) const

inline

Return a reference to the text style that is used to render the text for a option menu.

void om::graphics::gui::objects::OptionMenu::setTextStyle ( const TextStyle & newTextStyle )

inline

Set the text style that is used to render the text for a option menu.

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

inline

Return a reference to the delegate which responds to events for this option menu.

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

inline

Return a reference to the delegate which responds to events for this option menu.

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

inline

Return a reference to the delegate which responds to events for this option menu.

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

virtual

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

The method returns whether or not the option menu was successfully drawn.

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

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

virtual

Handle the specified mouse button event for the entire option menu.

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

Member Data Documentation

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

static

The default border that is used for an option menu.

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

static

The default background color that is used for an option menu's area.

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

static

The default border color that is used for an option menu.

const Color4f om::graphics::gui::objects::OptionMenu::DEFAULT_ARROW_COLOR

static

The default color for the down arrow for an option menu.

const Color4f om::graphics::gui::objects::OptionMenu::DEFAULT_DIVIDER_COLOR

static

The default color for the down arrow divider line for an option menu.

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

omGraphicsGUIOptionMenu.h

Classes

Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation