xoreos  0.0.5
Public Member Functions | List of all members
Graphics::Aurora::HighlightableText Class Reference

#include <highlightabletext.h>

Inheritance diagram for Graphics::Aurora::HighlightableText:
Inheritance graph
[legend]
Collaboration diagram for Graphics::Aurora::HighlightableText:
Collaboration graph
[legend]

Public Member Functions

 HighlightableText (const FontHandle &font, float w, float h, const Common::UString &str, float r=1.0f, float g=1.0f, float b=1.0f, float a=1.0f, float halign=kHAlignLeft, float valign=kVAlignTop)
 
 ~HighlightableText ()
 
void render (RenderPass pass)
 Render the object. More...
 
- Public Member Functions inherited from Graphics::Aurora::Text
 Text (const FontHandle &font, const Common::UString &str, float r=1.0f, float g=1.0f, float b=1.0f, float a=1.0f, float halign=kHAlignLeft, float valign=kVAlignTop)
 
 Text (const FontHandle &font, float w, float h, const Common::UString &str, float r=1.0f, float g=1.0f, float b=1.0f, float a=1.0f, float halign=kHAlignLeft, float valign=kVAlignTop)
 
 Text (Graphics::GUIElement::GUIElementType type, const FontHandle &font, float w, float h, const Common::UString &str, float r=1.0f, float g=1.0f, float b=1.0f, float a=1.0f, float halign=kHAlignLeft, float valign=kVAlignTop)
 
 ~Text ()
 
const Common::UStringget () const
 
const Common::UStringgetFont () const
 
void getPosition (float &x, float &y, float &z) const
 
void getColor (float &r, float &g, float &b, float &a) const
 
float getHorizontalAlign () const
 
float getVerticalAlign () const
 
void set (const Common::UString &str, float maxWidth=0.0f, float maxHeight=0.0f)
 
void setText (const Common::UString &str)
 
void setPosition (float x, float y, float z=-FLT_MAX)
 
void setSize (float width, float height)
 
void setColor (float r, float g, float b, float a)
 
void unsetColor ()
 
void setHorizontalAlign (float halign)
 
void setVerticalAlign (float valign)
 
void setFont (const Common::UString &fnt)
 Change the font of the text. More...
 
void disableColorTokens (bool disabled)
 Disable parsing <c color tokens into actual coloring. More...
 
bool empty ()
 
float getHeight (const Common::UString &text) const
 
size_t getLineCount () const
 
float getWidth () const
 
float getHeight () const
 
void calculateDistance ()
 Calculate the object's distance. More...
 
void render (RenderPass pass)
 Render the object. More...
 
bool isIn (float x, float y) const
 Is that point within the object? More...
 
void renderImmediate (const glm::mat4 &parentTransform)
 For shader based systems, don't sort anything, render this right_now. More...
 
- Public Member Functions inherited from Graphics::GUIElement
 GUIElement (GUIElementType type)
 
 ~GUIElement ()
 
- Public Member Functions inherited from Graphics::Renderable
 Renderable (RenderableType type)
 
 ~Renderable ()
 
bool operator< (const Queueable &q) const
 
virtual void advanceTime (float dt)
 Advance time (used by renderables with animations). More...
 
virtual void queueRender (const glm::mat4 &parentTransform)
 Queue the object for later rendering. More...
 
double getDistance () const
 Get the distance of the object from the viewer. More...
 
uint32 getID () const
 Get the object's unique ID. More...
 
bool isClickable () const
 Is the object clickable? More...
 
void setClickable (bool clickable)
 Set the object's clickable state. More...
 
const Common::UStringgetTag () const
 Get the object's tag. More...
 
void setTag (const Common::UString &tag)
 Set the object's tag. More...
 
bool isVisible () const
 Is the object visible? More...
 
virtual void show ()
 Show the object. More...
 
virtual void hide ()
 Hide the object. More...
 
virtual bool isIn (float x, float y, float z) const
 Is that point within the object? More...
 
virtual bool isIn (float x1, float y1, float z1, float x2, float y2, float z2) const
 Does the line from x1.y1.z1 to x2.y2.z2 intersect with the object? More...
 
- Public Member Functions inherited from Graphics::Queueable
 Queueable ()
 
virtual ~Queueable ()
 
- Public Member Functions inherited from Graphics::Aurora::Highlightable
 Highlightable ()
 
virtual ~Highlightable ()
 
bool isHighlightable () const
 
void setHighlightable (bool highlightable)
 
bool isHightlighted () const
 
void setHighlighted (bool hightlighted)
 
void setHighlightDelta (float r, float g, float b, float a)
 Set how much the quad changes per render. More...
 
void setHighlightUpperBound (float r, float g, float b, float a)
 When any of the quad properties are greater than this bound, the signs of the delta floats will flip. More...
 
void setHighlightLowerBound (float r, float g, float b, float a)
 When any of the quad properties are less than this bound, the signs of the delta floats will flip. More...
 
void getHighlightedLowerBound (float &r, float &g, float &b, float &a) const
 

Additional Inherited Members

- Public Types inherited from Graphics::GUIElement
enum  GUIElementType { kGUIElementFront = kRenderableTypeGUIFront, kGUIElementBack = kRenderableTypeGUIBack, kGUIElementConsole = kRenderableTypeConsole }
 
- Protected Member Functions inherited from Graphics::Renderable
void resort ()
 
void lockFrame ()
 
void unlockFrame ()
 
void lockFrameIfVisible ()
 
void unlockFrameIfVisible ()
 
- Protected Member Functions inherited from Graphics::Queueable
bool isInQueue (QueueType queue) const
 
void addToQueue (QueueType queue)
 
void removeFromQueue (QueueType queue)
 
void lockQueue (QueueType queue)
 
void unlockQueue (QueueType queue)
 
void sortQueue (QueueType queue)
 
- Protected Member Functions inherited from Graphics::Aurora::Highlightable
void flipHighlightDelta ()
 
void incrementColor (float initialR, float initialG, float initialB, float initialA, float &r, float &g, float &b, float &a)
 
- Protected Attributes inherited from Graphics::Renderable
QueueType _queueExists
 
QueueType _queueVisible
 
uint32 _id
 
bool _clickable
 
Common::UString _tag
 
double _distance
 The distance of the object from the viewer. More...
 

Detailed Description

Definition at line 31 of file highlightabletext.h.

Constructor & Destructor Documentation

◆ HighlightableText()

Graphics::Aurora::HighlightableText::HighlightableText ( const FontHandle font,
float  w,
float  h,
const Common::UString str,
float  r = 1.0f,
float  g = 1.0f,
float  b = 1.0f,
float  a = 1.0f,
float  halign = kHAlignLeft,
float  valign = kVAlignTop 
)

Definition at line 27 of file highlightabletext.cpp.

◆ ~HighlightableText()

Graphics::Aurora::HighlightableText::~HighlightableText ( )

Definition at line 31 of file highlightabletext.cpp.

Member Function Documentation

◆ render()

void Graphics::Aurora::HighlightableText::render ( RenderPass  pass)
virtual

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