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

#include <highlightableguiquad.h>

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

Public Member Functions

 HighlightableGUIQuad (const Common::UString &texture, float x1, float y1, float x2, float y2, float tX1=0.0f, float tY1=0.0f, float tX2=1.0f, float tY2=1.0f)
 
 ~HighlightableGUIQuad ()
 
void render (RenderPass pass)
 Render the object. More...
 
- Public Member Functions inherited from Graphics::Aurora::GUIQuad
 GUIQuad (const Common::UString &texture, float x1, float y1, float x2, float y2, float tX1=0.0f, float tY1=0.0f, float tX2=1.0f, float tY2=1.0f)
 
 GUIQuad (Graphics::GUIElement::GUIElementType type, const Common::UString &texture, float x1, float y1, float x2, float y2, float tX1=0.0f, float tY1=0.0f, float tX2=1.0f, float tY2=1.0f)
 
 GUIQuad (TextureHandle texture, float x1, float y1, float x2, float y2, float tX1=0.0f, float tY1=0.0f, float tX2=1.0f, float tY2=1.0f)
 
 ~GUIQuad ()
 
void getPosition (float &x, float &y, float &z) const
 Get the current position of the quad. More...
 
void setPosition (float x, float y, float z=-FLT_MAX)
 Set the current position of the quad. More...
 
void setRotation (float angle)
 Set the current rotation of the quad in degrees. More...
 
void getColor (float &r, float &g, float &b, float &a) const
 Get the current color of the quad. More...
 
void setColor (float r, float g, float b, float a)
 Set the current color of the quad. More...
 
void setTexture (const Common::UString &texture)
 Set the current texture of the quad. More...
 
void setTexture (TextureHandle texture)
 Set the current texture of the quad. More...
 
void setScissor (int x, int y, int width, int height)
 Set the scissor test parameters. More...
 
float getWidth () const
 Return the quad's width. More...
 
float getHeight () const
 Return the quad's height. More...
 
void setWidth (float w)
 Set the quad's width. More...
 
void setHeight (float h)
 Set the quad's height. More...
 
void setXOR (bool enabled)
 Enable/Disable XOR mode. More...
 
void setScissor (bool enabled)
 Enable/Disable Scissor Test. More...
 
bool isIn (float x, float y) const
 Is the point within the quad? More...
 
void calculateDistance ()
 Calculate the object's distance. 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 renderImmediate (const glm::mat4 &parentTransform)
 For shader based systems, don't sort anything, render this right_now. 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 highlightableguiquad.h.

Constructor & Destructor Documentation

◆ HighlightableGUIQuad()

Graphics::Aurora::HighlightableGUIQuad::HighlightableGUIQuad ( const Common::UString texture,
float  x1,
float  y1,
float  x2,
float  y2,
float  tX1 = 0.0f,
float  tY1 = 0.0f,
float  tX2 = 1.0f,
float  tY2 = 1.0f 
)

Definition at line 27 of file highlightableguiquad.cpp.

◆ ~HighlightableGUIQuad()

Graphics::Aurora::HighlightableGUIQuad::~HighlightableGUIQuad ( )

Definition at line 33 of file highlightableguiquad.cpp.

Member Function Documentation

◆ render()

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

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