Om  1.0.0
A universal framework for multimedia simulation
Classes | Public Member Functions | List of all members
om::graphics::gui::objects::TagView Class Reference

A class that provides a GUI for managing text tags. More...

#include <omGraphicsGUITagView.h>

Inheritance diagram for om::graphics::gui::objects::TagView:
om::graphics::gui::objects::GUIObject om::gui::input::InputHandler

Classes

class  Delegate
 A class that contains function objects that recieve TagView events. More...
 

Public Member Functions

 TagView ()
 Create a new tag view with value 0 and positioned at the origin of its coordinate system. More...
 
 TagView (const Rectangle &newRectangle)
 Create a new tag view which occupies the specified rectangular region with value 0. More...
 
 TagView (const Rectangle &newRectangle, Double newValue)
 Create a new tag view which places the specified number value within the given rectangle. More...
 
 ~TagView ()
 Destroy this tag view and release its internal resources. More...
 
Size getTagCount () const
 Return the number of tags there are in the tag view. More...
 
const UTF8String & getTag (Index tagIndex) const
 Return the string for the tag at the specified index in this tag view. More...
 
Bool getTagIndex (const UTF8String &tagText, Index &index) const
 Get the index of the tag with the specified tag string. More...
 
Bool addTag (const UTF8String &newTag)
 Add a new tag to the tag view. More...
 
Bool insertTag (Index tagIndex, const UTF8String &newTag)
 Insert a new tag in the tag view at the specified index. More...
 
void removeTag (Index tagIndex)
 Remove the tag at the specified index from this tag view. More...
 
void clearTags ()
 Remove all tags from this tag view. More...
 
const fonts::TextStylegetTextStyle () const
 Return a reference to the text style that is used to render the text for a tag view. More...
 
void setTextStyle (const fonts::TextStyle &newTextStyle)
 Set the text style that is used to render the text for a tag view. More...
 
Float getTextSize () const
 Return the nominal font size of the text in this tag view. More...
 
void setTextSize (Float newFontSize)
 Set the nominal font size of the text in this tag view. More...
 
FontgetFont () const
 Return a pointer to the font to use in this tag view. More...
 
Bool setFont (Font *newFont)
 Set the font to use in this tag view. More...
 
const TextLayoutgetTextLayout () const
 Return the font layout used for this tag view. More...
 
void setTextLayout (const TextLayout &newTextLayout)
 Set the font layout used for this tag view. More...
 
const OrigingetTextAlignment () const
 Return an object that describes how this tag view's text is aligned. More...
 
void setTextAlignment (const Origin &newTextAlignment)
 Set an object that describes how this tag view's text is aligned. More...
 
void setTextAlignment (Origin::XOrigin newXOrigin, Origin::YOrigin newYOrigin)
 Set an object that describes how this tag view's text is aligned. More...
 
const Color4f & getTextColor () const
 Return the text color for a tag view. More...
 
void setTextColor (const Color4f &newTextColor)
 Set the text color for a tag view. More...
 
const TextFieldgetTextField () const
 Return a reference to the underlying tag view for this tag view that handles text display. More...
 
const ButtongetAddButton () const
 Return a reference to the button that allows the user to add a new tag. More...
 
const ImageViewgetTagIcon () const
 Return a reference to an icon that displays a tag in the text field's area. More...
 
virtual Bool setBorder (const Border &newBorder)
 Set an object that describes this tag view's border. More...
 
virtual Bool setBorderColor (const Color4f &newBorderColor)
 Set the border color for a tag view. More...
 
virtual Bool setBackgroundColor (const Color4f &newBackgroundColor)
 Set the background color for this tag view's text area. More...
 
const Color4f & getSelectionColor () const
 Return the selection color for a tag view. More...
 
void setSelectionColor (const Color4f &newSelectionColor)
 Set the selection color for a tag view. More...
 
const Color4f & getFocusColor () const
 Return the focus color for a tag view. More...
 
void setFocusColor (const Color4f &newFocusColor)
 Set the focus color for a tag view. More...
 
virtual Bool setSize (const Vector3f &newSize)
 Set the 3D size of this tag view along each of its local axes. More...
 
virtual Bool resizeForContent ()
 Resize this tag view to fit tightly around its contents. More...
 
virtual Bool setFocus (Bool newHasFocus)
 Set whether or not this tag view currently has keyboard focus at its level in the GUI hierarchy. More...
 
virtual void update (Float dt)
 Update the current internal state of this tag view for the specified time interval in seconds. More...
 
virtual Bool guiEvent (const GUIEvent &event)
 Handle the specified GUI event that occured when this tag view had focus. More...
 
virtual Bool textEvent (const TextEvent &text)
 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...
 
DelegategetDelegate ()
 Return a reference to the delegate which responds to events for this tag view. More...
 
const DelegategetDelegate () const
 Return a reference to the delegate which responds to events for this tag view. More...
 
void setDelegate (const Delegate &newDelegate)
 Return a reference to the delegate which responds to events for this tag view. 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 RectanglegetRectangle () const
 Return a reference to this GUI object's rectangle. More...
 
const Vector3fgetSize () const
 Return a reference to the 3D size of this object along each of its local axes. More...
 
const Vector2fgetSizeXY () 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 Vector3fgetScale () const
 Return a reference to the 3D scaling factor of this object along each of its local axes. More...
 
const Vector2fgetScaleXY () 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 Vector3fgetPosition () const
 Return the position of this GUI object's origin relative to its parent's coordinate origin. More...
 
const Vector2fgetPositionXY () 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 Matrix3fgetRotation () 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...
 
OrigingetOrigin ()
 Return the alignment of the coordinate origin for this object. More...
 
const OrigingetOrigin () 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...
 
GUIStylegetStyle () 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 RectangleStylegetRectangleStyle () 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 BordergetBorder () 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 MargingetBorderMargin () 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 GUIObjectFlagsgetFlags () const
 Return a const reference to the flags for this GUI object. More...
 
Bool flagIsSet (GUIObjectFlags::Flag flag) const
 Return whether or not the specified boolan flag is set for this GUI object. More...
 
virtual Bool setFlags (const GUIObjectFlags &newFlags)
 Set the flags for this GUI object. More...
 
Bool setFlag (GUIObjectFlags::Flag flag, Bool newIsSet=true)
 Set whether or not the specified boolan flag is set for this GUI object. More...
 
Bool getIsVisible () const
 Return whether or not this GUI object should be drawn to the screen. More...
 
void setIsVisible (Bool newIsVisible)
 Set whether or not this GUI object should be drawn to the screen. More...
 
Bool hasFocus () const
 Return whether or not this GUI object currently has keyboard focus at its level in the GUI hierarchy. More...
 
- Public Member Functions inherited from om::gui::input::InputHandler
virtual ~InputHandler ()
 Destroy an input handler. More...
 

Detailed Description

A class that provides a GUI for managing text tags.

By convention, all of the tags in a tag view are unique when compared in a case- insensitive manner.

Constructor & Destructor Documentation

om::graphics::gui::objects::TagView::TagView ( )

Create a new tag view with value 0 and positioned at the origin of its coordinate system.

om::graphics::gui::objects::TagView::TagView ( const Rectangle newRectangle)

Create a new tag view which occupies the specified rectangular region with value 0.

om::graphics::gui::objects::TagView::TagView ( const Rectangle newRectangle,
Double  newValue 
)

Create a new tag view which places the specified number value within the given rectangle.

om::graphics::gui::objects::TagView::~TagView ( )

Destroy this tag view and release its internal resources.

Member Function Documentation

Size om::graphics::gui::objects::TagView::getTagCount ( ) const
inline

Return the number of tags there are in the tag view.

const UTF8String& om::graphics::gui::objects::TagView::getTag ( Index  tagIndex) const
inline

Return the string for the tag at the specified index in this tag view.

Bool om::graphics::gui::objects::TagView::getTagIndex ( const UTF8String &  tagText,
Index index 
) const

Get the index of the tag with the specified tag string.

A case-insensitive comparison is performed to find the tag with the given text.

Bool om::graphics::gui::objects::TagView::addTag ( const UTF8String &  newTag)

Add a new tag to the tag view.

Bool om::graphics::gui::objects::TagView::insertTag ( Index  tagIndex,
const UTF8String &  newTag 
)

Insert a new tag in the tag view at the specified index.

void om::graphics::gui::objects::TagView::removeTag ( Index  tagIndex)

Remove the tag at the specified index from this tag view.

void om::graphics::gui::objects::TagView::clearTags ( )

Remove all tags from this tag view.

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

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

void om::graphics::gui::objects::TagView::setTextStyle ( const fonts::TextStyle newTextStyle)
inline

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

Float om::graphics::gui::objects::TagView::getTextSize ( ) const
inline

Return the nominal font size of the text in this tag view.

void om::graphics::gui::objects::TagView::setTextSize ( Float  newFontSize)
inline

Set the nominal font size of the text in this tag view.

Font* om::graphics::gui::objects::TagView::getFont ( ) const
inline

Return a pointer to the font to use in this tag view.

Bool om::graphics::gui::objects::TagView::setFont ( Font newFont)
inline

Set the font to use in this tag view.

The method returns whether or not the new font was able to be used.

const TextLayout& om::graphics::gui::objects::TagView::getTextLayout ( ) const
inline

Return the font layout used for this tag view.

void om::graphics::gui::objects::TagView::setTextLayout ( const TextLayout newTextLayout)
inline

Set the font layout used for this tag view.

const Origin& om::graphics::gui::objects::TagView::getTextAlignment ( ) const
inline

Return an object that describes how this tag view's text is aligned.

void om::graphics::gui::objects::TagView::setTextAlignment ( const Origin newTextAlignment)
inline

Set an object that describes how this tag view's text is aligned.

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

Set an object that describes how this tag view's text is aligned.

const Color4f& om::graphics::gui::objects::TagView::getTextColor ( ) const
inline

Return the text color for a tag view.

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

Set the text color for a tag view.

const TextField& om::graphics::gui::objects::TagView::getTextField ( ) const
inline

Return a reference to the underlying tag view for this tag view that handles text display.

const Button& om::graphics::gui::objects::TagView::getAddButton ( ) const
inline

Return a reference to the button that allows the user to add a new tag.

const ImageView& om::graphics::gui::objects::TagView::getTagIcon ( ) const
inline

Return a reference to an icon that displays a tag in the text field's area.

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

Set an object that describes this tag view's border.

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

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

Set the border color for a tag view.

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

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

Set the background color for this tag view's text area.

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

const Color4f& om::graphics::gui::objects::TagView::getSelectionColor ( ) const
inline

Return the selection color for a tag view.

void om::graphics::gui::objects::TagView::setSelectionColor ( const Color4f &  newSelectionColor)
inline

Set the selection color for a tag view.

const Color4f& om::graphics::gui::objects::TagView::getFocusColor ( ) const
inline

Return the focus color for a tag view.

void om::graphics::gui::objects::TagView::setFocusColor ( const Color4f &  newFocusColor)
inline

Set the focus color for a tag view.

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

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

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

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

Resize this tag view to fit tightly around its contents.

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

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

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

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

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

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

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

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

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

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

virtual Bool om::graphics::gui::objects::TagView::textEvent ( const TextEvent text)
virtual

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

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

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

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

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

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

Handle the specified mouse motion event that occurred.

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

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

Handle the specified mouse button event that occurred.

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

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

Handle the specified mouse wheel event that occurred.

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

Delegate& om::graphics::gui::objects::TagView::getDelegate ( )
inline

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

const Delegate& om::graphics::gui::objects::TagView::getDelegate ( ) const
inline

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

void om::graphics::gui::objects::TagView::setDelegate ( const Delegate newDelegate)
inline

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

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

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

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

The default implementation draws nothing and returns TRUE.

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


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