psEffectAnchorSocket Class Reference

#include <pseffectanchorsocket.h>

List of all members.

Public Member Functions
psEffectAnchor *	Clone () const
	Clones the effect anchor.
bool	Create (const csVector3 &offset, iMeshWrapper *posAttach, bool rotateWithMesh=false)
	Creates the effect anchor.
const csString &	GetSocketName () const
	Gets the name of the socket where this anchor is attached.
bool	Load (iDocumentNode *node)
	Loads the effect anchors from an xml node.
	psEffectAnchorSocket ()
void	SetPosition (const csVector3 &, iSectorList *, const csMatrix3 &)
	Sets a new position for the effect anchor.
void	SetPosition (const csVector3 &, iSector *, const csMatrix3 &)
	Sets a new position for the effect anchor.
void	SetRotBase (const csMatrix3 &)
	Sets the base rotation matrix of the effect anchor.
void	SetSocket (const char *name)
	Sets the socket where this anchor is attached.
bool	Update (csTicks elapsed)
	Updates the effect anchor -- called every frame.
	~psEffectAnchorSocket ()

---

Detailed Description

Definition at line 32 of file pseffectanchorsocket.h.

---

Constructor & Destructor Documentation

psEffectAnchorSocket::psEffectAnchorSocket

(

)

psEffectAnchorSocket::~psEffectAnchorSocket

(

)

---

Member Function Documentation

psEffectAnchor* psEffectAnchorSocket::Clone

(

)

const [virtual]

Clones the effect anchor.

This will almost always be overloaded.

Reimplemented from psEffectAnchor.

bool psEffectAnchorSocket::Create	(	const csVector3 &	offset,
		iMeshWrapper *	posAttach,
		bool	rotateWithMesh = false
	)		[virtual]

Creates the effect anchor.

Parameters:

offset	the offset of the position of the obj.
posAttach	the mesh to attach this anchor to.
rotateWithMesh	Rotate the anchor with the mesh.

Returns:

true on success.

Reimplemented from psEffectAnchor.

const csString& psEffectAnchorSocket::GetSocketName

(

)

const [inline]

Gets the name of the socket where this anchor is attached.

Returns:

the name of the socket.

Definition at line 54 of file pseffectanchorsocket.h.

bool psEffectAnchorSocket::Load

(

iDocumentNode *

node

)

[virtual]

Loads the effect anchors from an xml node.

Parameters:

node	the xml node containing the effect anchor, must be valid.

Returns:

true on success, false otherwise.

Reimplemented from psEffectAnchor.

void psEffectAnchorSocket::SetPosition	(	const csVector3 &	basePos,
		iSectorList *	sectors,
		const csMatrix3 &	transf
	)		[inline, virtual]

Sets a new position for the effect anchor.

Parameters:

basePos	The new position of the anchor.
sectors	The new sectors of the anchor.
transf	The transform of the position.

Reimplemented from psEffectAnchor.

Definition at line 49 of file pseffectanchorsocket.h.

void psEffectAnchorSocket::SetPosition	(	const csVector3 &	basePos,
		iSector *	sector,
		const csMatrix3 &	transf
	)		[inline, virtual]

Sets a new position for the effect anchor.

Parameters:

basePos	The new position of the anchor.
sector	The new sector of the anchor
transf	The transform of the position.

Reimplemented from psEffectAnchor.

Definition at line 48 of file pseffectanchorsocket.h.

void psEffectAnchorSocket::SetRotBase

(

const csMatrix3 &

newRotBase

)

[inline, virtual]

Sets the base rotation matrix of the effect anchor.

Parameters:

newRotBase

The base rotation matrix.

Reimplemented from psEffectAnchor.

Definition at line 47 of file pseffectanchorsocket.h.

void psEffectAnchorSocket::SetSocket

(

const char *

name

)

Sets the socket where this anchor is attached.

Parameters:

name	the name of the socket.

bool psEffectAnchorSocket::Update

(

csTicks

elapsed

)

[virtual]

Updates the effect anchor -- called every frame.

Parameters:

elapsed

the ticks elapsed since last update.

Returns:

false if the anchor is useless and can be removed by its parent effect.

Reimplemented from psEffectAnchor.

---

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

• common/effects/pseffectanchorsocket.h