xoreos  0.0.5
Public Member Functions | Private Member Functions | Private Attributes | List of all members
Engines::Jade::GUIBackground Class Reference

#include <guibackground.h>

Inheritance diagram for Engines::Jade::GUIBackground:
Inheritance graph
[legend]
Collaboration diagram for Engines::Jade::GUIBackground:
Collaboration graph
[legend]

Public Member Functions

 GUIBackground (const Common::UString &type=kBackgroundTypeMenu, bool front=false)
 
 ~GUIBackground ()
 
void setType (const Common::UString &type)
 
void calculateDistance ()
 Calculate the object's distance. More...
 
void render (Graphics::RenderPass pass)
 Render the object. 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) 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 ()
 
- Public Member Functions inherited from Events::Notifyable
 Notifyable ()
 
virtual ~Notifyable ()
 

Private Member Functions

void update ()
 
bool tryBackground (int x, int y)
 
void notifyResized (int oldWidth, int oldHeight, int newWidth, int newHeight)
 

Private Attributes

Graphics::Aurora::TextureHandle _texture
 
Common::UString _type
 
int _screenWidth
 
int _screenHeight
 
int _vertexX1
 
int _vertexX2
 
int _vertexY1
 
int _vertexY2
 
bool _render
 

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

Definition at line 50 of file guibackground.h.

Constructor & Destructor Documentation

◆ GUIBackground()

Engines::Jade::GUIBackground::GUIBackground ( const Common::UString type = kBackgroundTypeMenu,
bool  front = false 
)

Definition at line 44 of file guibackground.cpp.

References Graphics::Renderable::_distance, _screenHeight, _screenWidth, FLT_MAX, update(), and WindowMan.

Here is the call graph for this function:

◆ ~GUIBackground()

Engines::Jade::GUIBackground::~GUIBackground ( )

Definition at line 55 of file guibackground.cpp.

References Graphics::Renderable::hide().

Here is the call graph for this function:

Member Function Documentation

◆ calculateDistance()

void Engines::Jade::GUIBackground::calculateDistance ( )
virtual

Calculate the object's distance.

Implements Graphics::Renderable.

Definition at line 63 of file guibackground.cpp.

◆ notifyResized()

void Engines::Jade::GUIBackground::notifyResized ( int  oldWidth,
int  oldHeight,
int  newWidth,
int  newHeight 
)
privatevirtual

Reimplemented from Events::Notifyable.

Definition at line 140 of file guibackground.cpp.

References _screenHeight, _screenWidth, and update().

Here is the call graph for this function:

◆ render()

void Engines::Jade::GUIBackground::render ( Graphics::RenderPass  pass)
virtual

◆ setType()

void Engines::Jade::GUIBackground::setType ( const Common::UString type)

Definition at line 59 of file guibackground.cpp.

References _type.

◆ tryBackground()

bool Engines::Jade::GUIBackground::tryBackground ( int  x,
int  y 
)
private

◆ update()

void Engines::Jade::GUIBackground::update ( )
private

Definition at line 107 of file guibackground.cpp.

References _screenHeight, _screenWidth, ARRAYSIZE, Graphics::kResolutions, and tryBackground().

Referenced by GUIBackground(), and notifyResized().

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

Member Data Documentation

◆ _render

bool Engines::Jade::GUIBackground::_render
private

Definition at line 74 of file guibackground.h.

Referenced by render(), and tryBackground().

◆ _screenHeight

int Engines::Jade::GUIBackground::_screenHeight
private

Definition at line 67 of file guibackground.h.

Referenced by GUIBackground(), notifyResized(), render(), tryBackground(), and update().

◆ _screenWidth

int Engines::Jade::GUIBackground::_screenWidth
private

Definition at line 66 of file guibackground.h.

Referenced by GUIBackground(), notifyResized(), render(), tryBackground(), and update().

◆ _texture

Graphics::Aurora::TextureHandle Engines::Jade::GUIBackground::_texture
private

Definition at line 62 of file guibackground.h.

Referenced by render(), and tryBackground().

◆ _type

Common::UString Engines::Jade::GUIBackground::_type
private

Definition at line 64 of file guibackground.h.

Referenced by setType(), and tryBackground().

◆ _vertexX1

int Engines::Jade::GUIBackground::_vertexX1
private

Definition at line 69 of file guibackground.h.

Referenced by render(), and tryBackground().

◆ _vertexX2

int Engines::Jade::GUIBackground::_vertexX2
private

Definition at line 70 of file guibackground.h.

Referenced by render(), and tryBackground().

◆ _vertexY1

int Engines::Jade::GUIBackground::_vertexY1
private

Definition at line 71 of file guibackground.h.

Referenced by render(), and tryBackground().

◆ _vertexY2

int Engines::Jade::GUIBackground::_vertexY2
private

Definition at line 72 of file guibackground.h.

Referenced by render(), and tryBackground().


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