FCDExternalReference Class Reference
[COLLADA Document Object Model.]

A COLLADA external reference for an entity instance. More...

#include <FCDExternalReference.h>

Inheritance diagram for FCDExternalReference:

List of all members.

Public Member Functions
	FCDExternalReference (FCDocument *document, const FUUri &uri)
	Constructor: do not use directly.
virtual	~FCDExternalReference ()
	Destructor: do not use directly.
virtual Type	GetType () const
	Retrieves the entity instance class type.
FCDEntity::Type	GetEntityType () const
	Retrieves the type of the entity that is referenced.
void	SetEntityType (FCDEntity::Type type)
	Sets the type of the entity that is referenced.
const FUUri &	GetUri () const
	Retrieves the URI of the external reference.
void	SetUri (const FUUri &_uri)
	Sets the URI of the external reference.
const fstring &	GetFilename () const
	Retrieves the filename of the COLLADA document referenced.
void	SetFilename (const fchar *filename)
	Sets the filename of the COLLADA document referenced.
void	SetFilename (const fstring &filename)
	See above.
fstring	GetObjectId () const
	Retrieves the COLLADA id of the external entity.
void	SetObjectId (const fchar *daeId)
	Sets the COLLADA id of the external entity.
void	SetObjectId (const fstring &daeId)
	See above.
virtual xmlNode *	WriteToXML (xmlNode *parentNode) const
	[INTERNAL] Writes out the entity instance to the given COLLADA XML tree node.

---

Detailed Description

A COLLADA external reference for an entity instance.

COLLADA supports many types of external references. FCollada only exposes external references within the visual scene graph.

---

Constructor & Destructor Documentation

FCDExternalReference::FCDExternalReference (  FCDocument *  document, const FUUri &  uri )

Constructor: do not use directly. Instead, use the appropriate allocation function. For visual scene node instances: FCDSceneNode::AddInstance, with the entity pointer set to NULL. Parameters: document  The COLLADA document that owns the reference. uri  The URI of the referenced entity.

virtual FCDExternalReference::~FCDExternalReference (   )  [inline, virtual]

Destructor: do not use directly. Instead, use the appropriate release function. For visual scene node instances: FCDSceneNode::ReleaseInstance.

---

Member Function Documentation

FCDEntity::Type FCDExternalReference::GetEntityType (   )  const [inline]

Retrieves the type of the entity that is referenced. Returns: The type of the external entity.

const fstring& FCDExternalReference::GetFilename (   )  const [inline]

Retrieves the filename of the COLLADA document referenced. Returns: The referenced document filename.

fstring FCDExternalReference::GetObjectId (   )  const [inline]

Retrieves the COLLADA id of the external entity. Returns: The COLLADA id.

virtual Type FCDExternalReference::GetType (   )  const [inline, virtual]

Retrieves the entity instance class type. Returns: The class type: EXTERNAL_REFERENCE. Reimplemented from FCDEntityInstance.

const FUUri& FCDExternalReference::GetUri (   )  const [inline]

Retrieves the URI of the external reference. This points to the COLLADA document and the id of the referenced entity. Returns: The referenced entity URI.

void FCDExternalReference::SetEntityType (  FCDEntity::Type  type  )  [inline]

Sets the type of the entity that is referenced. Parameters: type  The type of the external entity.

void FCDExternalReference::SetFilename (  const fchar *  filename  )

Sets the filename of the COLLADA document referenced. Parameters: filename  The referenced document filename.

void FCDExternalReference::SetObjectId (  const fchar *  daeId  )  [inline]

Sets the COLLADA id of the external entity. Parameters: daeId  The COLLADA id.

void FCDExternalReference::SetUri (  const FUUri &  _uri  )  [inline]

Sets the URI of the external reference. This points to the COLLADA document and the id of the referenced entity. Parameters: _uri  The referenced entity URL.

virtual xmlNode* FCDExternalReference::WriteToXML (  xmlNode *  parentNode  )  const [virtual]

[INTERNAL] Writes out the entity instance to the given COLLADA XML tree node. Parameters: parentNode  The COLLADA XML parent node in which to insert the node. Returns: The created XML tree node. Reimplemented from FCDEntityInstance.

---

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

• FCDocument/FCDExternalReference.h

---