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

#include <highlightable.h>

Inheritance diagram for Graphics::Aurora::Highlightable:
Inheritance graph
[legend]

Public Member Functions

 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
 

Protected Member Functions

void flipHighlightDelta ()
 
void incrementColor (float initialR, float initialG, float initialB, float initialA, float &r, float &g, float &b, float &a)
 

Private Attributes

bool _highlightable
 
bool _isHighlighted
 
float _deltaR
 
float _deltaG
 
float _deltaB
 
float _deltaA
 
float _upperBoundR
 
float _upperBoundG
 
float _upperBoundB
 
float _upperBoundA
 
float _lowerBoundR
 
float _lowerBoundG
 
float _lowerBoundB
 
float _lowerBoundA
 
uint32 _prevIncTime
 

Detailed Description

Definition at line 30 of file highlightable.h.

Constructor & Destructor Documentation

◆ Highlightable()

Graphics::Aurora::Highlightable::Highlightable ( )

Definition at line 28 of file highlightable.cpp.

◆ ~Highlightable()

Graphics::Aurora::Highlightable::~Highlightable ( )
virtual

Definition at line 36 of file highlightable.cpp.

Member Function Documentation

◆ flipHighlightDelta()

void Graphics::Aurora::Highlightable::flipHighlightDelta ( )
protected

Definition at line 84 of file highlightable.cpp.

References _deltaA, _deltaB, _deltaG, and _deltaR.

Referenced by incrementColor().

Here is the caller graph for this function:

◆ getHighlightedLowerBound()

void Graphics::Aurora::Highlightable::getHighlightedLowerBound ( float &  r,
float &  g,
float &  b,
float &  a 
) const

Definition at line 77 of file highlightable.cpp.

References _lowerBoundA, _lowerBoundB, _lowerBoundG, and _lowerBoundR.

Referenced by Engines::WidgetCheckBox::enter(), and Engines::KotORJadeWidget::setHighlight().

Here is the caller graph for this function:

◆ incrementColor()

void Graphics::Aurora::Highlightable::incrementColor ( float  initialR,
float  initialG,
float  initialB,
float  initialA,
float &  r,
float &  g,
float &  b,
float &  a 
)
protected

Definition at line 91 of file highlightable.cpp.

References _deltaA, _deltaB, _deltaG, _deltaR, _lowerBoundA, _lowerBoundB, _lowerBoundG, _lowerBoundR, _prevIncTime, _upperBoundA, _upperBoundB, _upperBoundG, _upperBoundR, EventMan, and flipHighlightDelta().

Referenced by Graphics::Aurora::HighlightableGUIQuad::render(), and Graphics::Aurora::HighlightableText::render().

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

◆ isHighlightable()

bool Graphics::Aurora::Highlightable::isHighlightable ( ) const

Definition at line 40 of file highlightable.cpp.

References _highlightable.

Referenced by Engines::WidgetCheckBox::enter(), Engines::WidgetCheckBox::leave(), Graphics::Aurora::HighlightableGUIQuad::render(), Graphics::Aurora::HighlightableText::render(), and Engines::KotORJadeWidget::setHighlight().

Here is the caller graph for this function:

◆ isHightlighted()

bool Graphics::Aurora::Highlightable::isHightlighted ( ) const

Definition at line 48 of file highlightable.cpp.

References _isHighlighted.

Referenced by Graphics::Aurora::HighlightableGUIQuad::render(), and Graphics::Aurora::HighlightableText::render().

Here is the caller graph for this function:

◆ setHighlightable()

void Graphics::Aurora::Highlightable::setHighlightable ( bool  highlightable)

Definition at line 44 of file highlightable.cpp.

References _highlightable.

Referenced by Engines::WidgetButton::setDefaultHighlighting(), Engines::WidgetProtoItem::setDefaultHighlighting(), Engines::WidgetCheckBox::setQuadHighlighting(), and Engines::WidgetCheckBox::setTextHighlighting().

Here is the caller graph for this function:

◆ setHighlightDelta()

void Graphics::Aurora::Highlightable::setHighlightDelta ( float  r,
float  g,
float  b,
float  a 
)

Set how much the quad changes per render.

Positive number increment the color, negative numbers decrement it.

Definition at line 56 of file highlightable.cpp.

References _deltaA, _deltaB, _deltaG, and _deltaR.

Referenced by Engines::WidgetButton::setDefaultHighlighting(), Engines::WidgetProtoItem::setDefaultHighlighting(), and Engines::WidgetCheckBox::setTextHighlighting().

Here is the caller graph for this function:

◆ setHighlighted()

void Graphics::Aurora::Highlightable::setHighlighted ( bool  hightlighted)

Definition at line 52 of file highlightable.cpp.

References _isHighlighted.

Referenced by Engines::WidgetCheckBox::enter(), Engines::WidgetCheckBox::leave(), and Engines::KotORJadeWidget::setHighlight().

Here is the caller graph for this function:

◆ setHighlightLowerBound()

void Graphics::Aurora::Highlightable::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.

Definition at line 63 of file highlightable.cpp.

References _lowerBoundA, _lowerBoundB, _lowerBoundG, and _lowerBoundR.

Referenced by Engines::WidgetButton::setDefaultHighlighting(), Engines::WidgetProtoItem::setDefaultHighlighting(), Engines::WidgetCheckBox::setQuadHighlighting(), Engines::WidgetButton::setStaticHighlight(), and Engines::WidgetCheckBox::setTextHighlighting().

Here is the caller graph for this function:

◆ setHighlightUpperBound()

void Graphics::Aurora::Highlightable::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.

Definition at line 70 of file highlightable.cpp.

References _upperBoundA, _upperBoundB, _upperBoundG, and _upperBoundR.

Referenced by Engines::WidgetButton::setDefaultHighlighting(), Engines::WidgetProtoItem::setDefaultHighlighting(), and Engines::WidgetCheckBox::setTextHighlighting().

Here is the caller graph for this function:

Member Data Documentation

◆ _deltaA

float Graphics::Aurora::Highlightable::_deltaA
private

Definition at line 70 of file highlightable.h.

Referenced by flipHighlightDelta(), incrementColor(), and setHighlightDelta().

◆ _deltaB

float Graphics::Aurora::Highlightable::_deltaB
private

Definition at line 69 of file highlightable.h.

Referenced by flipHighlightDelta(), incrementColor(), and setHighlightDelta().

◆ _deltaG

float Graphics::Aurora::Highlightable::_deltaG
private

Definition at line 68 of file highlightable.h.

Referenced by flipHighlightDelta(), incrementColor(), and setHighlightDelta().

◆ _deltaR

float Graphics::Aurora::Highlightable::_deltaR
private

Definition at line 67 of file highlightable.h.

Referenced by flipHighlightDelta(), incrementColor(), and setHighlightDelta().

◆ _highlightable

bool Graphics::Aurora::Highlightable::_highlightable
private

Definition at line 64 of file highlightable.h.

Referenced by isHighlightable(), and setHighlightable().

◆ _isHighlighted

bool Graphics::Aurora::Highlightable::_isHighlighted
private

Definition at line 65 of file highlightable.h.

Referenced by isHightlighted(), and setHighlighted().

◆ _lowerBoundA

float Graphics::Aurora::Highlightable::_lowerBoundA
private

Definition at line 80 of file highlightable.h.

Referenced by getHighlightedLowerBound(), incrementColor(), and setHighlightLowerBound().

◆ _lowerBoundB

float Graphics::Aurora::Highlightable::_lowerBoundB
private

Definition at line 79 of file highlightable.h.

Referenced by getHighlightedLowerBound(), incrementColor(), and setHighlightLowerBound().

◆ _lowerBoundG

float Graphics::Aurora::Highlightable::_lowerBoundG
private

Definition at line 78 of file highlightable.h.

Referenced by getHighlightedLowerBound(), incrementColor(), and setHighlightLowerBound().

◆ _lowerBoundR

float Graphics::Aurora::Highlightable::_lowerBoundR
private

Definition at line 77 of file highlightable.h.

Referenced by getHighlightedLowerBound(), incrementColor(), and setHighlightLowerBound().

◆ _prevIncTime

uint32 Graphics::Aurora::Highlightable::_prevIncTime
private

Definition at line 82 of file highlightable.h.

Referenced by incrementColor().

◆ _upperBoundA

float Graphics::Aurora::Highlightable::_upperBoundA
private

Definition at line 75 of file highlightable.h.

Referenced by incrementColor(), and setHighlightUpperBound().

◆ _upperBoundB

float Graphics::Aurora::Highlightable::_upperBoundB
private

Definition at line 74 of file highlightable.h.

Referenced by incrementColor(), and setHighlightUpperBound().

◆ _upperBoundG

float Graphics::Aurora::Highlightable::_upperBoundG
private

Definition at line 73 of file highlightable.h.

Referenced by incrementColor(), and setHighlightUpperBound().

◆ _upperBoundR

float Graphics::Aurora::Highlightable::_upperBoundR
private

Definition at line 72 of file highlightable.h.

Referenced by incrementColor(), and setHighlightUpperBound().

The documentation for this class was generated from the following files:
Generated on Sun Nov 18 2018 15:13:55 for xoreos by   doxygen 1.8.14