xoreos  0.0.5
Public Member Functions | Private Member Functions | Private Attributes | List of all members
Graphics::Aurora::FPS Class Reference

An autonomous FPS display. More...

#include <fps.h>

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

Public Member Functions

 FPS (const FontHandle &font)
 
 ~FPS ()
 
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 Events::Notifyable
 Notifyable ()
 
virtual ~Notifyable ()
 

Private Member Functions

void init ()
 
void notifyResized (int oldWidth, int oldHeight, int newWidth, int newHeight)
 

Private Attributes

uint32 _fps
 

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

An autonomous FPS display.

Definition at line 37 of file fps.h.

Constructor & Destructor Documentation

◆ FPS()

Graphics::Aurora::FPS::FPS ( const FontHandle font)

Definition at line 37 of file fps.cpp.

References init().

Here is the call graph for this function:

◆ ~FPS()

Graphics::Aurora::FPS::~FPS ( )

Definition at line 41 of file fps.cpp.

References Graphics::Renderable::hide().

Here is the call graph for this function:

Member Function Documentation

◆ init()

void Graphics::Aurora::FPS::init ( )
private

Definition at line 45 of file fps.cpp.

References notifyResized(), Graphics::Renderable::setTag(), and WindowMan.

Referenced by FPS().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ notifyResized()

void Graphics::Aurora::FPS::notifyResized ( int  oldWidth,
int  oldHeight,
int  newWidth,
int  newHeight 
)
privatevirtual

Reimplemented from Events::Notifyable.

Definition at line 66 of file fps.cpp.

References Graphics::Aurora::Text::setPosition(), and Graphics::Aurora::Text::setSize().

Referenced by init().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ render()

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

Render the object.

Implements Graphics::Renderable.

Definition at line 50 of file fps.cpp.

References _fps, Common::UString::format(), GfxMan, Graphics::kRenderPassOpaque, pass, Graphics::Aurora::Text::render(), and Graphics::Aurora::Text::setText().

Here is the call graph for this function:

Member Data Documentation

◆ _fps

uint32 Graphics::Aurora::FPS::_fps
private

Definition at line 46 of file fps.h.

Referenced by render().


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