FCDTargetedEntity Class Reference

A targeted entity. More...

#include <FCDTargetedEntity.h>

Inheritance diagram for FCDTargetedEntity:

List of all members.

Public Member Functions
	FCDTargetedEntity (FCDocument *document, const char *baseId)
	Constructor: do not use directly.
virtual	~FCDTargetedEntity ()
	Destructor: do not use directly.
bool	HasTarget () const
	Retrieves whether a target is defined for this entity.
FCDSceneNode *	GetTargetNode ()
	Retrieves the target visual scene node for this entity.
const FCDSceneNode *	GetTargetNode () const
	See above.
void	SetTargetNode (FCDSceneNode *target)
	Sets the target visual scene node for this entity.
FUStatus	LinkTarget (FCDSceneNode *sceneRoot)
	[INTERNAL] Links the entity with its target.
Protected Member Functions
const string &	GetTargetId ()
	[INTERNAL] Retrieves the COLLADA id of the target entity.
void	SetTargetId (const string &_targetId)
	[INTERNAL] Sets the COLLADA id of the target entity.
void	SetTargetId (const char *_targetId)
	See above.

---

Detailed Description

A targeted entity.

COLLADA doesn't have targeted entity. Therefore: the behavior of a targeted entity is application-defined.

This class is used to support 3dsMax's targeted cameras and lights and we also plan to support Maya's targeted cameras and lights.

See also:

FCDCamera FCDLight

---

Constructor & Destructor Documentation

FCDTargetedEntity::FCDTargetedEntity (  FCDocument *  document, const char *  baseId )

Constructor: do not use directly. Instead, create objects of the up-classes. Parameters: document  The COLLADA document that owns the targeted entity. baseId  The prefix COLLADA id to be used if no COLLADA id is provided.

virtual FCDTargetedEntity::~FCDTargetedEntity (   )  [virtual]

Destructor: do not use directly. Instead, release objects through their libraries or their parent entities.

---

Member Function Documentation

const string& FCDTargetedEntity::GetTargetId (   )  [inline, protected]

[INTERNAL] Retrieves the COLLADA id of the target entity. The actual resolution of the COLLADA id into a visual scene node happens during the LinkTarget function. Returns: The COLLADA id of the target entity.

FCDSceneNode* FCDTargetedEntity::GetTargetNode (   )  [inline]

Retrieves the target visual scene node for this entity. Returns: The target visual scene node.

bool FCDTargetedEntity::HasTarget (   )  const [inline]

Retrieves whether a target is defined for this entity. Returns: Whether a target is defined for this entity.

FUStatus FCDTargetedEntity::LinkTarget (  FCDSceneNode *  sceneRoot  )

[INTERNAL] Links the entity with its target. This function is used during the import of a COLLADA document. Todo: Modify this function to support multiple visual scenes. Parameters: sceneRoot  The root visual scene. Returns: The status of the linkage.

void FCDTargetedEntity::SetTargetId (  const string &  _targetId  )  [inline, protected]

[INTERNAL] Sets the COLLADA id of the target entity. This function is used during the import of a COLLADA document. The actual resolution of the COLLADA id into a visual scene node happens during the LinkTarget function. Parameters: _targetId  A COLLADA id.

void FCDTargetedEntity::SetTargetNode (  FCDSceneNode *  target  )

Sets the target visual scene node for this entity. Parameters: target  The new target node.

---

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

• FCDocument/FCDTargetedEntity.h

---