deSkyController Class Reference

Sky controller. More...

#include <deSkyController.h>

Public Member Functions
Constructors and Destructors
	deSkyController ()
	Create controller. More...
	deSkyController (const deSkyController &controller)
	Create copy of controller. More...
	~deSkyController ()
	Clean up animator. More...
Management
const decString &	GetName () const
	Name. More...
void	SetName (const char *name)
	Set name. More...
float	GetMinimumValue () const
	Minimum value. More...
float	GetMaximumValue () const
	Maximum value. More...
void	SetValueRange (float minValue, float maxValue)
	Set value range. More...
float	GetCurrentValue () const
	Current value. More...
void	SetCurrentValue (float value)
	Set current value. More...
void	IncrementCurrentValue (float incrementBy)
	Increment current value. More...
bool	GetClamp () const
	Clamp current value to range instead of wrapping around at the end points. More...
void	SetClamp (bool clamp)
	Set if current value is clamped to range instead of wrapping around at the end points. More...
bool	GetFrozen () const
	Controller is frozen. More...
void	SetFrozen (bool frozen)
	Set if controller is frozen. More...

Operators
deSkyController &	operator= (const deSkyController &controller)
	Copy controller to this controller. More...

Detailed Description

Sky controller.

Controllers provide the user with control over how the individual layers of a sky. Controllers are written in a way that you can use them without having to do scaling or transformation on your own. You can provide a minimum and maximum value matching your setup. The controller takes care of transforming the current value into the proper 0 to 1 range required for sounds to work with.

Constructor & Destructor Documentation

deSkyController() [1/2]

deSkyController::deSkyController

(

)

Create controller.

deSkyController() [2/2]

deSkyController::deSkyController

(

const deSkyController &

controller

)

Create copy of controller.

~deSkyController()

deSkyController::~deSkyController

(

)

Clean up animator.

Member Function Documentation

GetClamp()

bool deSkyController::GetClamp ( ) const

inline

Clamp current value to range instead of wrapping around at the end points.

GetCurrentValue()

float deSkyController::GetCurrentValue ( ) const

inline

Current value.

GetFrozen()

bool deSkyController::GetFrozen ( ) const

inline

Controller is frozen.

GetMaximumValue()

float deSkyController::GetMaximumValue ( ) const

inline

Maximum value.

GetMinimumValue()

float deSkyController::GetMinimumValue ( ) const

inline

Minimum value.

GetName()

const decString& deSkyController::GetName ( ) const

inline

Name.

IncrementCurrentValue()

void deSkyController::IncrementCurrentValue

(

float

incrementBy

)

Increment current value.

operator=()

deSkyController& deSkyController::operator=

(

const deSkyController &

controller

)

Copy controller to this controller.

SetClamp()

void deSkyController::SetClamp

(

bool

clamp

)

Set if current value is clamped to range instead of wrapping around at the end points.

SetCurrentValue()

void deSkyController::SetCurrentValue

(

float

value

)

Set current value.

SetFrozen()

void deSkyController::SetFrozen

(

bool

frozen

)

Set if controller is frozen.

SetName()

void deSkyController::SetName

(

const char *

name

)

Set name.

SetValueRange()

void deSkyController::SetValueRange	(	float	minValue,
		float	maxValue
	)

Set value range.

---

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

• deSkyController.h