deDecal Class Reference

Decal Resource. More...

#include <deDecal.h>

Inheritance diagram for deDecal:

List of all members.

Public Member Functions
Constructors and Destructors
	deDecal (deDecalManager *manager)
	Creates a new decal.
	~deDecal ()
	Cleans up the decal.
Management
deSkin *	GetSkin () const
	Retrieves the skin.
void	SetSkin (deSkin *skin)
	Sets the skin.
const char *	GetTextureName () const
	Retrieves the texture name.
void	SetTextureName (const char *texture)
	Sets the texture name.
const decVector &	GetPosition () const
	Retrieves the position.
void	SetPosition (const decVector &position)
	Sets the position.
const decQuaternion &	GetOrientation () const
	Retrieves the orientation.
void	SetOrientation (const decQuaternion &orientation)
	Sets the orientation.
const decVector &	GetSize () const
	Retrieves the size.
void	SetSize (const decVector &size)
	Sets the size.
const decVector2 &	GetTextureCoordinatesAt (int index) const
	Retrieves the given texture coordinates.
void	SetTextureCoordinatesAt (int index, const decVector2 &texCoords)
	Sets the given texture coordinates.
bool	GetVisible () const
	Determines if the decal is visible.
void	SetVisible (bool visible)
	Sets if the decal is visible.
Bone States
int	GetBoneStateCount () const
	Retrieves the number of bone states.
void	SetBoneStateCount (int count)
	Sets the number of bone states.
deDecalBoneState &	GetBoneStateAt (int index)
	Retrieves the bone state at the given index.
void	SnapshotBoneStatesFrom (deComponent *component)
	Copies the current bone state from the provided component.
System Peers
deBaseGraphicDecal *	GetGraphicDecal () const
	Retrieves the graphic system peer.
void	SetGraphicDecal (deBaseGraphicDecal *graDecal)
	Sets the graphic system peer.
deBasePhysicsDecal *	GetPhysicsDecal () const
	Retrieves the physics system peer.
void	SetPhysicsDecal (deBasePhysicsDecal *phyDecal)
	Sets the physics system peer.
deBaseAudioDecal *	GetAudioDecal () const
	Retrieves the audio system peer.
void	SetAudioDecal (deBaseAudioDecal *audDecal)
	Sets the audio system peer.

---

Detailed Description

Decal Resource.

Decals are rectangular textures splatted on a curved surface like a component. Decals have a slight offset from the hosting surface hence they cover the surface below. The ordering of the decal determines which decal covers others. A decal is defined by projection parameters. The actual projection is carried out by the Graphic Module. A decal is first located in space using a position and orientation. The size determines the width and height of the decal on the projection plane previously defined. The texture coordinates defined the texture coordinates of the corners of the decal starting in the upper left corner going around the decal in clockwise order. The decal is then projected along the view direction on the geometry it is attached to.

Author:

Plüss Roland

Version:

1.0

Date:

2008

---

Constructor & Destructor Documentation

deDecal::deDecal

(

deDecalManager *

manager )

Creates a new decal.

deDecal::~deDecal

(

)

Cleans up the decal.

---

Member Function Documentation

deBaseAudioDecal* deDecal::GetAudioDecal

(

)

const [inline]

Retrieves the audio system peer.

deDecalBoneState& deDecal::GetBoneStateAt

(

int

index )

Retrieves the bone state at the given index.

int deDecal::GetBoneStateCount

(

)

const [inline]

Retrieves the number of bone states.

deBaseGraphicDecal* deDecal::GetGraphicDecal

(

)

const [inline]

Retrieves the graphic system peer.

const decQuaternion& deDecal::GetOrientation

(

)

const [inline]

Retrieves the orientation.

deBasePhysicsDecal* deDecal::GetPhysicsDecal

(

)

const [inline]

Retrieves the physics system peer.

const decVector& deDecal::GetPosition

(

)

const [inline]

Retrieves the position.

const decVector& deDecal::GetSize

(

)

const [inline]

Retrieves the size.

deSkin* deDecal::GetSkin

(

)

const [inline]

Retrieves the skin.

const decVector2& deDecal::GetTextureCoordinatesAt

(

int

index )

const

Retrieves the given texture coordinates.

const char* deDecal::GetTextureName

(

)

const [inline]

Retrieves the texture name.

bool deDecal::GetVisible

(

)

const [inline]

Determines if the decal is visible.

void deDecal::SetAudioDecal

(

deBaseAudioDecal *

audDecal )

Sets the audio system peer.

void deDecal::SetBoneStateCount

(

int

count )

Sets the number of bone states.

void deDecal::SetGraphicDecal

(

deBaseGraphicDecal *

graDecal )

Sets the graphic system peer.

void deDecal::SetOrientation

(

const decQuaternion &

orientation )

Sets the orientation.

void deDecal::SetPhysicsDecal

(

deBasePhysicsDecal *

phyDecal )

Sets the physics system peer.

void deDecal::SetPosition

(

const decVector &

position )

Sets the position.

void deDecal::SetSize

(

const decVector &

size )

Sets the size.

void deDecal::SetSkin

(

deSkin *

skin )

Sets the skin.

void deDecal::SetTextureCoordinatesAt	(	int	index,
		const decVector2 &	texCoords
	)

Sets the given texture coordinates.

void deDecal::SetTextureName

(

const char *

texture )

Sets the texture name.

void deDecal::SetVisible

(

bool

visible )

Sets if the decal is visible.

void deDecal::SnapshotBoneStatesFrom

(

deComponent *

component )

Copies the current bone state from the provided component.

---

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

• deDecal.h