Billboard Resource. More...

#include <deBillboard.h>

Inheritance diagram for deBillboard:

Public Types
typedef deTObjectReference< deBillboard >	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
const decDVector &	GetPosition () const
	Position. More...

void	SetPosition (const decDVector &position)
	Set position. More...

const decVector &	GetAxis () const
	Axis. More...

void	SetAxis (const decVector &axis)
	Set axis. More...

const decVector2 &	GetSize () const
	Size. More...

void	SetSize (const decVector2 &size)
	Set size. More...

const decVector2 &	GetOffset () const
	Offset. More...

void	SetOffset (const decVector2 &offset)
	Set offset. More...

deSkin *	GetSkin () const
	Skin or NULL if not assigned. More...

void	SetSkin (deSkin *skin)
	Set skin. More...

deDynamicSkin *	GetDynamicSkin () const
	Dynamic skin or NULL if not assigned. More...

void	SetDynamicSkin (deDynamicSkin *dynamicSkin)
	Set dynamic skin. More...

bool	GetLocked () const
	Billboard is locked. More...

void	SetLocked (bool locked)
	Set billboard is locked. More...

bool	GetSpherical () const
	Billboard is spherical. More...

void	SetSpherical (bool spherical)
	Set if billboard is spherical. More...

bool	GetSizeFixedToScreen () const
	Billboard size is fixed to the screen size. More...

void	SetSizeFixedToScreen (bool sizeFixedToScreen)
	Set if billboard size is fixed to the screen size. More...

bool	GetVisible () const
	Billboard is visible. More...

void	SetVisible (bool visible)
	Set if billboard is visible. More...

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

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

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

void	SetPeerGraphic (deBaseGraphicBillboard *peer)
	Set graphic system 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...

deBillboard *	GetLLWorldPrev () const
	Previous billboard in the parent world linked list. More...

void	SetLLWorldPrev (deBillboard *billboard)
	Set next billboard in the parent world linked list. More...

deBillboard *	GetLLWorldNext () const
	Next billboard in the parent world linked list. More...

void	SetLLWorldNext (deBillboard *billboard)
	Set next billboard 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
	deBillboard (deBillboardManager *manager)
	Create new billboard. More...

virtual	~deBillboard ()
	Cleas up billboard. 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

Billboard Resource.

Billboards are rectangular objects that are different from components in that they are flat and oriented relative to the camera. Billboards can be locked in which case they are oriented along an axis or free in which case they are oriented around their position. Furthermore billboards are either spherical in which case they are oriented relative to the camera position or planar in which case they are oriented relative to the camera near plane. The image of the billboard is either a skin or a dynamic skin and has a 2 dimensional size as well as a 2 dimensional offset relative to the position and orientation axis. The y component of the size and offset moves along the orientation axis and therefore is aligned along the up direction in the camera view. The x component moves perpendicular to the orientation axis relative to the camera view and therefore is aligned along the right direction in the camera view. By default billboards are axis oriented with a world-up axis and are spherical.

Member Typedef Documentation

◆ Ref

typedef deTObjectReference<deBillboard> deBillboard::Ref

Type holding strong reference.

Constructor & Destructor Documentation

◆ deBillboard()

deBillboard::deBillboard ( deBillboardManager * manager )

Create new billboard.

◆ ~deBillboard()

virtual deBillboard::~deBillboard ( )

protectedvirtual

Cleas up billboard.

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

◆ GetAxis()

const decVector& deBillboard::GetAxis ( ) const

inline

Axis.

◆ GetDynamicSkin()

deDynamicSkin* deBillboard::GetDynamicSkin ( ) const

inline

Dynamic skin or NULL if not assigned.

◆ GetLayerMask()

const decLayerMask& deBillboard::GetLayerMask ( ) const

inline

Layer mask.

◆ GetLLWorldNext()

deBillboard* deBillboard::GetLLWorldNext ( ) const

inline

Next billboard in the parent world linked list.

◆ GetLLWorldPrev()

deBillboard* deBillboard::GetLLWorldPrev ( ) const

inline

Previous billboard in the parent world linked list.

◆ GetLocked()

bool deBillboard::GetLocked ( ) const

inline

Billboard is locked.

◆ GetOffset()

const decVector2& deBillboard::GetOffset ( ) const

inline

Offset.

◆ GetParentWorld()

deWorld* deBillboard::GetParentWorld ( ) const

inline

Parent world or NULL.

◆ GetPeerGraphic()

deBaseGraphicBillboard* deBillboard::GetPeerGraphic ( ) const

inline

Graphic system peer or NULL if not set.

◆ GetPosition()

const decDVector& deBillboard::GetPosition ( ) const

inline

Position.

◆ GetSize()

const decVector2& deBillboard::GetSize ( ) const

inline

Size.

◆ GetSizeFixedToScreen()

bool deBillboard::GetSizeFixedToScreen ( ) const

inline

Billboard size is fixed to the screen size.

◆ GetSkin()

deSkin* deBillboard::GetSkin ( ) const

inline

Skin or NULL if not assigned.

◆ GetSpherical()

bool deBillboard::GetSpherical ( ) const

inline

Billboard is spherical.

◆ GetVisible()

bool deBillboard::GetVisible ( ) const

inline

Billboard is visible.

◆ SetAxis()

void deBillboard::SetAxis ( const decVector & axis )

Set axis.

◆ SetDynamicSkin()

void deBillboard::SetDynamicSkin ( deDynamicSkin * dynamicSkin )

Set dynamic skin.

◆ SetLayerMask()

void deBillboard::SetLayerMask ( const decLayerMask & layerMask )

Set layer mask.

◆ SetLLWorldNext()

void deBillboard::SetLLWorldNext ( deBillboard * billboard )

Set next billboard in the parent world linked list.

◆ SetLLWorldPrev()

void deBillboard::SetLLWorldPrev ( deBillboard * billboard )

Set next billboard in the parent world linked list.

◆ SetLocked()

void deBillboard::SetLocked ( bool locked )

Set billboard is locked.

◆ SetOffset()

void deBillboard::SetOffset ( const decVector2 & offset )

Set offset.

◆ SetParentWorld()

void deBillboard::SetParentWorld ( deWorld * world )

Set parent world or NULL.

◆ SetPeerGraphic()

void deBillboard::SetPeerGraphic ( deBaseGraphicBillboard * peer )

Set graphic system peer or NULL if not set.

◆ SetPosition()

void deBillboard::SetPosition ( const decDVector & position )

Set position.

◆ SetSize()

void deBillboard::SetSize ( const decVector2 & size )

Set size.

◆ SetSizeFixedToScreen()

void deBillboard::SetSizeFixedToScreen ( bool sizeFixedToScreen )

Set if billboard size is fixed to the screen size.

◆ SetSkin()

void deBillboard::SetSkin ( deSkin * skin )

Set skin.

◆ SetSpherical()

void deBillboard::SetSpherical ( bool spherical )

Set if billboard is spherical.

◆ SetVisible()

void deBillboard::SetVisible ( bool visible )

Set if billboard is visible.

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

deBillboard.h

Public Types

Public Member Functions

Constructors and Destructors

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Ref

Constructor & Destructor Documentation

◆ deBillboard()

◆ ~deBillboard()

Member Function Documentation

◆ GetAxis()

◆ GetDynamicSkin()

◆ GetLayerMask()

◆ GetLLWorldNext()

◆ GetLLWorldPrev()

◆ GetLocked()

◆ GetOffset()

◆ GetParentWorld()

◆ GetPeerGraphic()

◆ GetPosition()

◆ GetSize()

◆ GetSizeFixedToScreen()

◆ GetSkin()

◆ GetSpherical()

◆ GetVisible()

◆ SetAxis()

◆ SetDynamicSkin()

◆ SetLayerMask()

◆ SetLLWorldNext()

◆ SetLLWorldPrev()

◆ SetLocked()

◆ SetOffset()

◆ SetParentWorld()

◆ SetPeerGraphic()

◆ SetPosition()

◆ SetSize()

◆ SetSizeFixedToScreen()

◆ SetSkin()

◆ SetSpherical()

◆ SetVisible()