Sky instance. More...

#include <deSkyInstance.h>

Inheritance diagram for deSkyInstance:

Public Types
typedef deTObjectReference< deSkyInstance >	Ref
	Type holding strong reference. More...

Public Types inherited from deResource
typedef deTObjectReference< deResource >	Ref
	Type holding strong reference. More...

Public Types inherited from deObject
typedef deTObjectReference< deObject >	Ref
	Type holding strong reference. More...

Public Member Functions
Management
deSky *	GetSky () const
	Sky or NULL if not set. More...

void	SetSky (deSky *sky)
	Set sky or NULL to clear. More...

int	GetOrder () const
	Render order with higher order covering lower order. More...

void	SetOrder (int order)
	Set render order with higher order covering lower order. More...

int	GetControllerCount () const
	Number of controllers. More...

deSkyController &	GetControllerAt (int index) const
	Controller at index. More...

int	IndexOfControllerNamed (const char *name) const
	Index of named controller or -1 if absent. More...

void	NotifyControllerChangedAt (int index)
	Notify peer controller changed. More...

const decLayerMask &	GetLayerMask () const
	Layer mask. More...

void	SetLayerMask (const decLayerMask &layerMask)
	Set layer mask. More...

System Peers
deBaseGraphicSkyInstance *	GetPeerGraphic () const
	Graphic peer or NULL if not set. More...

void	SetPeerGraphic (deBaseGraphicSkyInstance *peer)
	Set graphic peer or NULL if not set. More...

Linked List
deWorld *	GetParentWorld () const
	Parent world or NULL. More...

void	SetParentWorld (deWorld *world)
	Set parent world or NULL. More...

deSkyInstance *	GetLLWorldPrev () const
	Previous sky in the parent world linked list. More...

void	SetLLWorldPrev (deSkyInstance *sky)
	Set next sky in the parent world linked list. More...

deSkyInstance *	GetLLWorldNext () const
	Next sky in the parent world linked list. More...

void	SetLLWorldNext (deSkyInstance *sky)
	Set next sky in the parent world linked list. More...

Public Member Functions inherited from deResource
deResourceManager *	GetResourceManager () const
	Resource manager or NULL if resource is leaking. More...

deEngine *	GetEngine () const
	Game engine object from resource manager. More...

deResource *	GetLLManagerPrev () const
	Previous resource in the resource manager linked list. More...

void	SetLLManagerPrev (deResource *resource)
	Set next resource in the resource manager linked list. More...

deResource *	GetLLManagerNext () const
	Next resource in the resource manager linked list. More...

void	SetLLManagerNext (deResource *resource)
	Set next resource in the resource manager linked list. More...

void	MarkLeaking ()
	Marks the resource leaking. More...

	deResource (deResourceManager *resourceManager)
	Create resource. More...

Public Member Functions inherited from deObject
int	GetRefCount () const
	Reference count. More...

void	AddReference ()
	Add reference increasing reference count by 1. More...

void	FreeReference ()
	Decrease reference count by one and delete object if count reaches 0. More...

	deObject ()
	Create object with reference count of 1. More...

Constructors and Destructors
	deSkyInstance (deSkyInstanceManager *manager)
	Create sky instance. More...

virtual	~deSkyInstance ()
	Clean up the sky instance. More...

Additional Inherited Members
Protected Member Functions inherited from deResource
virtual	~deResource ()
	Clean up resource. More...

Protected Member Functions inherited from deObject
virtual	~deObject ()
	Clean up object. More...

Detailed Description

Sky instance.

Every sky contains a set of layers and controllers indicating how the final sky looks like. While skies define how the sky looks like the actual sky is produced using per instance parameters.

Member Typedef Documentation

◆ Ref

typedef deTObjectReference<deSkyInstance> deSkyInstance::Ref

Type holding strong reference.

Constructor & Destructor Documentation

◆ deSkyInstance()

deSkyInstance::deSkyInstance ( deSkyInstanceManager * manager )

Create sky instance.

◆ ~deSkyInstance()

virtual deSkyInstance::~deSkyInstance ( )

protectedvirtual

Clean up the sky instance.

Note: Subclasses should set their destructor protected too to avoid users accidently deleting a reference counted object through the object pointer. Only FreeReference() is allowed to delete the object.

Member Function Documentation

◆ GetControllerAt()

deSkyController& deSkyInstance::GetControllerAt ( int index ) const

Controller at index.

Exceptions

deeInvalidParam index is less than 0 or greater or equal than GetControllerCount().

◆ GetControllerCount()

int deSkyInstance::GetControllerCount ( ) const

inline

Number of controllers.

◆ GetLayerMask()

const decLayerMask& deSkyInstance::GetLayerMask ( ) const

inline

Layer mask.

◆ GetLLWorldNext()

deSkyInstance* deSkyInstance::GetLLWorldNext ( ) const

inline

Next sky in the parent world linked list.

◆ GetLLWorldPrev()

deSkyInstance* deSkyInstance::GetLLWorldPrev ( ) const

inline

Previous sky in the parent world linked list.

◆ GetOrder()

int deSkyInstance::GetOrder ( ) const

inline

Render order with higher order covering lower order.

◆ GetParentWorld()

deWorld* deSkyInstance::GetParentWorld ( ) const

inline

Parent world or NULL.

◆ GetPeerGraphic()

deBaseGraphicSkyInstance* deSkyInstance::GetPeerGraphic ( ) const

inline

Graphic peer or NULL if not set.

◆ GetSky()

deSky* deSkyInstance::GetSky ( ) const

inline

Sky or NULL if not set.

◆ IndexOfControllerNamed()

int deSkyInstance::IndexOfControllerNamed ( const char * name ) const

Index of named controller or -1 if absent.

◆ NotifyControllerChangedAt()

void deSkyInstance::NotifyControllerChangedAt ( int index )

Notify peer controller changed.

◆ SetLayerMask()

void deSkyInstance::SetLayerMask ( const decLayerMask & layerMask )

Set layer mask.

◆ SetLLWorldNext()

void deSkyInstance::SetLLWorldNext ( deSkyInstance * sky )

Set next sky in the parent world linked list.

◆ SetLLWorldPrev()

void deSkyInstance::SetLLWorldPrev ( deSkyInstance * sky )

Set next sky in the parent world linked list.

◆ SetOrder()

void deSkyInstance::SetOrder ( int order )

Set render order with higher order covering lower order.

◆ SetParentWorld()

void deSkyInstance::SetParentWorld ( deWorld * world )

Set parent world or NULL.

◆ SetPeerGraphic()

void deSkyInstance::SetPeerGraphic ( deBaseGraphicSkyInstance * peer )

Set graphic peer or NULL if not set.

◆ SetSky()

void deSkyInstance::SetSky ( deSky * sky )

Set sky or NULL to clear.

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

deSkyInstance.h

Public Types

Public Member Functions

Constructors and Destructors

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Ref

Constructor & Destructor Documentation

◆ deSkyInstance()

◆ ~deSkyInstance()

Member Function Documentation

◆ GetControllerAt()

◆ GetControllerCount()

◆ GetLayerMask()

◆ GetLLWorldNext()

◆ GetLLWorldPrev()

◆ GetOrder()

◆ GetParentWorld()

◆ GetPeerGraphic()

◆ GetSky()

◆ IndexOfControllerNamed()

◆ NotifyControllerChangedAt()

◆ SetLayerMask()

◆ SetLLWorldNext()

◆ SetLLWorldPrev()

◆ SetOrder()

◆ SetParentWorld()

◆ SetPeerGraphic()

◆ SetSky()