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

#include <borderquad.h>

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

Public Member Functions

 BorderQuad (const Common::UString &edge, const Common::UString &corner, float x, float y, float w, float h, int dimension=0)
 
void setColor (float r, float g, float b, float a=1.0f)
 Set the color of the border quad. More...
 
void setPosition (float x, float y, float z)
 
void getPosition (float &x, float &y, float &z)
 
void setSize (float w, float h)
 
void getSize (float &w, float &h) const
 
virtual void calculateDistance ()
 Calculate the object's distance. More...
 
void render (RenderPass pass)
 Render the object. More...
 
- 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) const
 Is that point within 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 ()
 

Private Attributes

TextureHandle _edge
 
TextureHandle _corner
 
bool _verticalCut
 
int _edgeWidth
 
int _edgeHeight
 
int _cornerWidth
 
int _cornerHeight
 
float _r
 
float _g
 
float _b
 
float _a
 
float _x
 
float _y
 
float _w
 
float _h
 

Additional Inherited Members

- 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

Definition at line 38 of file borderquad.h.

Constructor & Destructor Documentation

◆ BorderQuad()

Graphics::Aurora::BorderQuad::BorderQuad ( const Common::UString edge,
const Common::UString corner,
float  x,
float  y,
float  w,
float  h,
int  dimension = 0 
)

Member Function Documentation

◆ calculateDistance()

void Graphics::Aurora::BorderQuad::calculateDistance ( )
virtual

Calculate the object's distance.

Implements Graphics::Renderable.

Definition at line 112 of file borderquad.cpp.

◆ getPosition()

void Graphics::Aurora::BorderQuad::getPosition ( float &  x,
float &  y,
float &  z 
)

Definition at line 90 of file borderquad.cpp.

References Graphics::Renderable::_distance, _x, and _y.

◆ getSize()

void Graphics::Aurora::BorderQuad::getSize ( float &  w,
float &  h 
) const

Definition at line 107 of file borderquad.cpp.

References _h, and _w.

◆ render()

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

◆ setColor()

void Graphics::Aurora::BorderQuad::setColor ( float  r,
float  g,
float  b,
float  a = 1.0f 
)

Set the color of the border quad.

Definition at line 72 of file borderquad.cpp.

References _a, _b, _g, and _r.

◆ setPosition()

void Graphics::Aurora::BorderQuad::setPosition ( float  x,
float  y,
float  z 
)

Definition at line 79 of file borderquad.cpp.

References Graphics::Renderable::_distance, _x, _y, Graphics::Renderable::lockFrameIfVisible(), and Graphics::Renderable::unlockFrameIfVisible().

Here is the call graph for this function:

◆ setSize()

void Graphics::Aurora::BorderQuad::setSize ( float  w,
float  h 
)

Definition at line 96 of file borderquad.cpp.

References _edgeHeight, _h, _verticalCut, and _w.

Member Data Documentation

◆ _a

float Graphics::Aurora::BorderQuad::_a
private

Definition at line 66 of file borderquad.h.

Referenced by render(), and setColor().

◆ _b

float Graphics::Aurora::BorderQuad::_b
private

Definition at line 65 of file borderquad.h.

Referenced by render(), and setColor().

◆ _corner

TextureHandle Graphics::Aurora::BorderQuad::_corner
private

Definition at line 56 of file borderquad.h.

Referenced by BorderQuad(), and render().

◆ _cornerHeight

int Graphics::Aurora::BorderQuad::_cornerHeight
private

Definition at line 61 of file borderquad.h.

Referenced by BorderQuad(), and render().

◆ _cornerWidth

int Graphics::Aurora::BorderQuad::_cornerWidth
private

Definition at line 61 of file borderquad.h.

Referenced by BorderQuad(), and render().

◆ _edge

TextureHandle Graphics::Aurora::BorderQuad::_edge
private

Definition at line 56 of file borderquad.h.

Referenced by BorderQuad(), and render().

◆ _edgeHeight

int Graphics::Aurora::BorderQuad::_edgeHeight
private

Definition at line 60 of file borderquad.h.

Referenced by BorderQuad(), render(), and setSize().

◆ _edgeWidth

int Graphics::Aurora::BorderQuad::_edgeWidth
private

Definition at line 60 of file borderquad.h.

Referenced by BorderQuad(), and render().

◆ _g

float Graphics::Aurora::BorderQuad::_g
private

Definition at line 64 of file borderquad.h.

Referenced by render(), and setColor().

◆ _h

float Graphics::Aurora::BorderQuad::_h
private

Definition at line 71 of file borderquad.h.

Referenced by BorderQuad(), getSize(), render(), and setSize().

◆ _r

float Graphics::Aurora::BorderQuad::_r
private

Definition at line 63 of file borderquad.h.

Referenced by render(), and setColor().

◆ _verticalCut

bool Graphics::Aurora::BorderQuad::_verticalCut
private

Definition at line 58 of file borderquad.h.

Referenced by BorderQuad(), render(), and setSize().

◆ _w

float Graphics::Aurora::BorderQuad::_w
private

Definition at line 70 of file borderquad.h.

Referenced by getSize(), render(), and setSize().

◆ _x

float Graphics::Aurora::BorderQuad::_x
private

Definition at line 68 of file borderquad.h.

Referenced by getPosition(), render(), and setPosition().

◆ _y

float Graphics::Aurora::BorderQuad::_y
private

Definition at line 69 of file borderquad.h.

Referenced by getPosition(), render(), and setPosition().


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