A class that provides a text and/or image label that wraps a child GUI object. More...

#include <omGraphicsGUILabel.h>

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

Public Member Functions
	Label ()
	Create a new label with no text content or labelled object. More...

	Label (const UTF8String &newText)
	Create a new label that uses the specified text. More...

	Label (const UTF8String &newText, const GUIImage &newImage)
	Create a new label that uses the specified text and image icon. More...

GUIObject *	getObject () const
	Return a pointer to the object that is labeled by this label. More...

void	setObject (GUIObject *newObject)
	Set a pointer to the object that is labeled by this label. More...

const GUIImage &	getImage () const
	Return a const reference to the image that is displayed with this label. More...

void	setImage (const GUIImage &newImage)
	Set the image that is displayed with this label. More...

const Origin &	getImageAlignment () const
	Return an object that describes how this label's image is aligned within the label area. More...

void	setImageAlignment (const Origin &newAlignment)
	Set an object that describes how this label's image is aligned within the label area. More...

const Color4f &	getImageColor () const
	Return the tint color for this image view's image. More...

void	setImageColor (const Color4f &newImageColor)
	Set the tint color for this image view's image. More...

const UTF8String &	getText () const
	Return a reference to a string containing the text contents of this label. More...

void	setText (const UTF8String &newLabelText)
	Set the text contents of this label as a string. More...

const Origin &	getTextAlignment () const
	Return an object that describes how the label text is aligned in its bounding area. More...

void	setTextAlignment (const Origin &newTextAlignment)
	Set an object that describes how the label text is aligned in its bounding area. More...

void	setTextAlignment (Origin::XOrigin newXOrigin, Origin::YOrigin newYOrigin)
	Set how the label text is aligned in its bounding area. More...

const Origin &	getLabelAlignment () const
	Return an object that describes how this label is aligned relative to the labeled object. More...

void	setLabelAlignment (const Origin &newLabelAlignment)
	Set how this label is aligned relative to the labeled object. More...

void	setLabelAlignment (Origin::XOrigin newXOrigin, Origin::YOrigin newYOrigin)
	Set how this label is aligned relative to the labeled object. More...

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

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

Float	getTextSize () const
	Return the nominal font size of the text in this label. More...

void	setTextSize (Float newFontSize)
	Set the nominal font size of the text in this label. More...

Font *	getFont () const
	Return a pointer to the font to use for this label's text. More...

void	setFont (Font *newFont)
	Set the font to use for this label's text. More...

const TextLayout &	getTextLayout () const
	Return the text layout used for this label's text. More...

void	setTextLayout (const TextLayout &newTextLayout)
	Set the text layout used for this label's text. More...

const Color4f &	getTextColor () const
	Return the color for the label's text. More...

void	setTextColor (const Color4f &newTextColor)
	Set the color for the label's text. More...

Public Member Functions inherited from om::graphics::gui::objects::GUIObjectWrapper
	GUIObjectWrapper ()
	Create a new GUI object wrapper that has no object to wrap. More...

	GUIObjectWrapper (GUIObject *wrappedObject)
	Create a GUI object wrapper that wraps the specified object. More...

GUIObject *	getWrappedObject () const
	Return a pointer to the GUI object that is being wrapped by this one. More...

void	setWrappedObject (GUIObject *newWrappedObject)
	Set a pointer to the GUI object that is being wrapped by this one. More...

virtual Bool	setPosition (const Vector3f &newPosition)
	Set the position of this object's origin relative to its parent's coordinate origin. More...

virtual Bool	setRotation (const Matrix3f &newRotation)
	Set a 3x3 orthonormal matrix indicating the basis of this object's coordinate frame. More...

virtual Bool	setScale (const Vector3f &newScale)
	Set the 3D scaling factor of this object along each of its local axes. More...

virtual Bool	setOrigin (const Origin &newPositionOrigin)
	Set the alignment of the coordinate origin for this object. More...

virtual Bool	setSize (const Vector3f &newSize)
	Set the 3D size of this object along each of its local axes. More...

virtual Bool	resizeForContent ()
	Resize this object to fit tightly around its contents. More...

virtual Bool	setFocus (Bool newHasFocus)
	Set whether or not this object currently has keyboard focus at its level in the GUI hierarchy. More...

virtual Bool	setFlags (const GUIObjectFlags &newFlags)
	Set the flags for this GUI object. More...

virtual Bool	setRectangleStyle (const RectangleStyle &newRectangleStyle)
	Set an object that describes the style of the main outside rectangle of this object. More...

virtual Bool	setBorder (const Border &newBorder)
	Set an object that describes this object's border. More...

virtual Bool	setBorderColor (const Color4f &newBorderColor)
	Set the border color for an object. More...

virtual Bool	setBackgroundColor (const Color4f &newBackgroundColor)
	Set the background color for this object's area. More...

virtual Bool	guiEvent (const GUIEvent &event)
	Handle the specified GUI input 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	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...

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

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

const Matrix3f &	getRotation () const
	Return 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...

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

const Border &	getBorder () const
	Return 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...

const Color4f &	getBorderColor () const
	Return 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...

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 Origin	DEFAULT_LABEL_ALIGNMENT
	The default alignment that is used for a label relative to its labeled object. More...

static const Float	DEFAULT_TEXT_SIZE
	The default font size that is used for a text view's text. More...

static const Origin	DEFAULT_TEXT_ALIGNMENT
	The default alignment that is used for a label's text within its bounding area. More...

static const Color4f	DEFAULT_TEXT_COLOR
	The default color that is used for a label's text. More...

static const Border	DEFAULT_BORDER
	The default border that is used for a label. More...

static const Color4f	DEFAULT_BORDER_COLOR
	The default border color that is used for a label's area. More...

static const Color4f	DEFAULT_BACKGROUND_COLOR
	The default background color that is used for a label's area. More...

Detailed Description

A class that provides a text and/or image label that wraps a child GUI object.

Constructor & Destructor Documentation

om::graphics::gui::objects::Label::Label ( )

Create a new label with no text content or labelled object.

om::graphics::gui::objects::Label::Label ( const UTF8String & newText )

Create a new label that uses the specified text.

om::graphics::gui::objects::Label::Label	(	const UTF8String &	newText,
		const GUIImage &	newImage
	)

Create a new label that uses the specified text and image icon.

Member Function Documentation

GUIObject* om::graphics::gui::objects::Label::getObject ( ) const

inline

Return a pointer to the object that is labeled by this label.

void om::graphics::gui::objects::Label::setObject ( GUIObject * newObject )

inline

Set a pointer to the object that is labeled by this label.

const GUIImage& om::graphics::gui::objects::Label::getImage ( ) const

inline

Return a const reference to the image that is displayed with this label.

void om::graphics::gui::objects::Label::setImage ( const GUIImage & newImage )

inline

Set the image that is displayed with this label.

const Origin& om::graphics::gui::objects::Label::getImageAlignment ( ) const

inline

Return an object that describes how this label's image is aligned within the label area.

void om::graphics::gui::objects::Label::setImageAlignment ( const Origin & newAlignment )

inline

Set an object that describes how this label's image is aligned within the label area.

const Color4f& om::graphics::gui::objects::Label::getImageColor ( ) const

inline

Return the tint color for this image view's image.

void om::graphics::gui::objects::Label::setImageColor ( const Color4f & newImageColor )

inline

Set the tint color for this image view's image.

const UTF8String& om::graphics::gui::objects::Label::getText ( ) const

inline

Return a reference to a string containing the text contents of this label.

void om::graphics::gui::objects::Label::setText ( const UTF8String & newLabelText )

Set the text contents of this label as a string.

const Origin& om::graphics::gui::objects::Label::getTextAlignment ( ) const

inline

Return an object that describes how the label text is aligned in its bounding area.

void om::graphics::gui::objects::Label::setTextAlignment ( const Origin & newTextAlignment )

inline

Set an object that describes how the label text is aligned in its bounding area.

void om::graphics::gui::objects::Label::setTextAlignment	(	Origin::XOrigin	newXOrigin,
		Origin::YOrigin	newYOrigin
	)

inline

Set how the label text is aligned in its bounding area.

const Origin& om::graphics::gui::objects::Label::getLabelAlignment ( ) const

inline

Return an object that describes how this label is aligned relative to the labeled object.

void om::graphics::gui::objects::Label::setLabelAlignment ( const Origin & newLabelAlignment )

inline

Set how this label is aligned relative to the labeled object.

void om::graphics::gui::objects::Label::setLabelAlignment	(	Origin::XOrigin	newXOrigin,
		Origin::YOrigin	newYOrigin
	)

inline

Set how this label is aligned relative to the labeled object.

const fonts::TextStyle& om::graphics::gui::objects::Label::getTextStyle ( ) const

inline

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

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

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

Float om::graphics::gui::objects::Label::getTextSize ( ) const

inline

Return the nominal font size of the text in this label.

void om::graphics::gui::objects::Label::setTextSize ( Float newFontSize )

inline

Set the nominal font size of the text in this label.

Font* om::graphics::gui::objects::Label::getFont ( ) const

inline

Return a pointer to the font to use for this label's text.

void om::graphics::gui::objects::Label::setFont ( Font * newFont )

inline

Set the font to use for this label's text.

const TextLayout& om::graphics::gui::objects::Label::getTextLayout ( ) const

inline

Return the text layout used for this label's text.

void om::graphics::gui::objects::Label::setTextLayout ( const TextLayout & newTextLayout )

inline

Set the text layout used for this label's text.

const Color4f& om::graphics::gui::objects::Label::getTextColor ( ) const

inline

Return the color for the label's text.

void om::graphics::gui::objects::Label::setTextColor ( const Color4f & newTextColor )

inline

Set the color for the label's text.

Member Data Documentation

const Origin om::graphics::gui::objects::Label::DEFAULT_LABEL_ALIGNMENT

static

The default alignment that is used for a label relative to its labeled object.

const Float om::graphics::gui::objects::Label::DEFAULT_TEXT_SIZE

static

The default font size that is used for a text view's text.

const Origin om::graphics::gui::objects::Label::DEFAULT_TEXT_ALIGNMENT

static

The default alignment that is used for a label's text within its bounding area.

const Color4f om::graphics::gui::objects::Label::DEFAULT_TEXT_COLOR

static

The default color that is used for a label's text.

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

static

The default border that is used for a label.

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

static

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

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

static

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

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

omGraphicsGUILabel.h

Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation