DustyEngine::ColorInterpolatedTask Class Reference

Color Interpolation Task interpolates one color into another color over time. More...

#include <dustycolorinterpolatedtask.h>

Inheritance diagram for DustyEngine::ColorInterpolatedTask:

List of all members.

Public Member Functions
	ColorInterpolatedTask ()
virtual	~ColorInterpolatedTask ()
void	SetStartColor (irr::video::SColor sc)
irr::video::SColor	GetStartColor ()
void	SetEndColor (irr::video::SColor ec)
irr::video::SColor	GetEndColor ()
irr::video::SColor	GetCurrentColor ()
void	OnUpdate ()
	OnUpdate() is called by the TaskTree when the time has come to execute the task's code.
Protected Attributes
irr::video::SColor	startColor
irr::video::SColor	endColor
irr::video::SColor	currentColor

---

Detailed Description

Color Interpolation Task interpolates one color into another color over time.

Definition at line 11 of file dustycolorinterpolatedtask.h.

---

Constructor & Destructor Documentation

DustyEngine::ColorInterpolatedTask::ColorInterpolatedTask (   )

virtual DustyEngine::ColorInterpolatedTask::~ColorInterpolatedTask (   )  [virtual]

---

Member Function Documentation

irr::video::SColor DustyEngine::ColorInterpolatedTask::GetCurrentColor (   )  [inline]

GetCurrentColor() returns the current, interpolated color. This is the accessor to get the interpolated color. Returns: Returns the current color according to interpolation, which will be somewhere between start color and end color depending upon how much time has passed. Definition at line 48 of file dustycolorinterpolatedtask.h.

irr::video::SColor DustyEngine::ColorInterpolatedTask::GetEndColor (   )  [inline]

GetEndColor() returns the ending color of the task. Returns: Returns the end interpolation color Definition at line 41 of file dustycolorinterpolatedtask.h.

irr::video::SColor DustyEngine::ColorInterpolatedTask::GetStartColor (   )  [inline]

GetStartColor() gives the beginning color of interpolation. Returns: Returns the starting color of interpolation. Definition at line 27 of file dustycolorinterpolatedtask.h.

void DustyEngine::ColorInterpolatedTask::OnUpdate (   )  [virtual]

OnUpdate() is called by the TaskTree when the time has come to execute the task's code. OnUpdate is typically the most important function. OnUpdate is only called when enough time has passed or every frame, depending upon what the priority of the task is. If you want code to execute on a time-based basis, put that code here and add the task to the tree. Reimplemented from DustyEngine::InterpolatedTask.

void DustyEngine::ColorInterpolatedTask::SetEndColor (  irr::video::SColor  ec  )  [inline]

SetEndColor() sets the ending color for interpolation. Parameters: ec,:  The ending color for interpolation. Definition at line 34 of file dustycolorinterpolatedtask.h.

void DustyEngine::ColorInterpolatedTask::SetStartColor (  irr::video::SColor  sc  )  [inline]

SetStartColor() sets the beginning color for the interpolation. Parameters: sc,:  The beginning color. Definition at line 20 of file dustycolorinterpolatedtask.h.

---

Member Data Documentation

irr::video::SColor DustyEngine::ColorInterpolatedTask::currentColor [protected]

Definition at line 58 of file dustycolorinterpolatedtask.h.

irr::video::SColor DustyEngine::ColorInterpolatedTask::endColor [protected]

Definition at line 57 of file dustycolorinterpolatedtask.h.

irr::video::SColor DustyEngine::ColorInterpolatedTask::startColor [protected]

Definition at line 56 of file dustycolorinterpolatedtask.h.

---

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

• dustycolorinterpolatedtask.h

---