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

#include <fadequad.h>

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

Public Member Functions

 FadeQuad ()
 
void getColor (float &r, float &g, float &b) const
 Get the current color of the quad. More...
 
void setColor (float r, float g, float b)
 Set the current color of the quad. More...
 
void getWaitTime (float &wait) const
 Get the time to wait until fading begins. More...
 
void setWaitTime (float wait)
 Set the time to wait until fading begins. More...
 
void getRunTime (float &run) const
 Get the time the quad is fading. More...
 
void setRunTime (float run)
 Set the time the quad is fading. More...
 
void fadeIn ()
 Start a fade in. More...
 
void fadeOut ()
 Start a fade out. More...
 
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 Types

enum  FadeType { kFadeNone, kFadeIn, kFadeOut }
 

Private Attributes

FadeType _fadeType
 
float _r
 
float _g
 
float _b
 
float _opacity
 
uint32 _wait
 
uint32 _run
 
uint32 _start
 

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 34 of file fadequad.h.

Member Enumeration Documentation

◆ FadeType

Enumerator
kFadeNone 
kFadeIn 
kFadeOut 

Definition at line 62 of file fadequad.h.

Constructor & Destructor Documentation

◆ FadeQuad()

Graphics::Aurora::FadeQuad::FadeQuad ( )

Definition at line 36 of file fadequad.cpp.

Member Function Documentation

◆ calculateDistance()

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

Calculate the object's distance.

Implements Graphics::Renderable.

Definition at line 81 of file fadequad.cpp.

◆ fadeIn()

void Graphics::Aurora::FadeQuad::fadeIn ( )

Start a fade in.

Definition at line 69 of file fadequad.cpp.

References _fadeType, _start, EventMan, kFadeIn, and Graphics::Renderable::show().

Referenced by Engines::KotOR::Functions::setGlobalFadeIn().

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

◆ fadeOut()

void Graphics::Aurora::FadeQuad::fadeOut ( )

Start a fade out.

Definition at line 75 of file fadequad.cpp.

References _fadeType, _start, EventMan, kFadeOut, and Graphics::Renderable::show().

Referenced by Engines::KotOR::Functions::setGlobalFadeOut().

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

◆ getColor()

void Graphics::Aurora::FadeQuad::getColor ( float &  r,
float &  g,
float &  b 
) const

Get the current color of the quad.

Definition at line 41 of file fadequad.cpp.

References _b, _g, and _r.

◆ getRunTime()

void Graphics::Aurora::FadeQuad::getRunTime ( float &  run) const

Get the time the quad is fading.

Definition at line 61 of file fadequad.cpp.

References _run.

◆ getWaitTime()

void Graphics::Aurora::FadeQuad::getWaitTime ( float &  wait) const

Get the time to wait until fading begins.

Definition at line 53 of file fadequad.cpp.

References _wait.

◆ render()

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

Render the object.

Implements Graphics::Renderable.

Definition at line 84 of file fadequad.cpp.

References _b, _fadeType, _g, _opacity, _r, _run, _start, _wait, EventMan, FLT_MAX, kFadeIn, kFadeNone, kFadeOut, Graphics::kRenderPassOpaque, Graphics::kRenderPassTransparent, MAX(), MIN(), and pass.

Here is the call graph for this function:

◆ setColor()

void Graphics::Aurora::FadeQuad::setColor ( float  r,
float  g,
float  b 
)

Set the current color of the quad.

Definition at line 47 of file fadequad.cpp.

References _b, _g, and _r.

Referenced by Engines::KotOR::Functions::setGlobalFadeIn(), and Engines::KotOR::Functions::setGlobalFadeOut().

Here is the caller graph for this function:

◆ setRunTime()

void Graphics::Aurora::FadeQuad::setRunTime ( float  run)

Set the time the quad is fading.

Definition at line 65 of file fadequad.cpp.

References _run.

Referenced by Engines::KotOR::Functions::setGlobalFadeIn(), and Engines::KotOR::Functions::setGlobalFadeOut().

Here is the caller graph for this function:

◆ setWaitTime()

void Graphics::Aurora::FadeQuad::setWaitTime ( float  wait)

Set the time to wait until fading begins.

Definition at line 57 of file fadequad.cpp.

References _wait.

Referenced by Engines::KotOR::Functions::setGlobalFadeIn(), and Engines::KotOR::Functions::setGlobalFadeOut().

Here is the caller graph for this function:

Member Data Documentation

◆ _b

float Graphics::Aurora::FadeQuad::_b
private

Definition at line 70 of file fadequad.h.

Referenced by getColor(), render(), and setColor().

◆ _fadeType

FadeType Graphics::Aurora::FadeQuad::_fadeType
private

Definition at line 68 of file fadequad.h.

Referenced by fadeIn(), fadeOut(), and render().

◆ _g

float Graphics::Aurora::FadeQuad::_g
private

Definition at line 70 of file fadequad.h.

Referenced by getColor(), render(), and setColor().

◆ _opacity

float Graphics::Aurora::FadeQuad::_opacity
private

Definition at line 71 of file fadequad.h.

Referenced by render().

◆ _r

float Graphics::Aurora::FadeQuad::_r
private

Definition at line 70 of file fadequad.h.

Referenced by getColor(), render(), and setColor().

◆ _run

uint32 Graphics::Aurora::FadeQuad::_run
private

Definition at line 73 of file fadequad.h.

Referenced by getRunTime(), render(), and setRunTime().

◆ _start

uint32 Graphics::Aurora::FadeQuad::_start
private

Definition at line 74 of file fadequad.h.

Referenced by fadeIn(), fadeOut(), and render().

◆ _wait

uint32 Graphics::Aurora::FadeQuad::_wait
private

Definition at line 72 of file fadequad.h.

Referenced by getWaitTime(), render(), and setWaitTime().


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