FCDObject Class Reference
[COLLADA Document Object Model.]

A basic COLLADA document object. More...

#include <FCDObject.h>

Inheritance diagram for FCDObject:

FUObject FCDAnimated FCDAnimationChannel FCDAnimationCurve FCDAnimationMultiCurve FCDEffectCode FCDEffectParameter FCDEffectParameterList FCDEffectPass FCDEffectPassShader FCDEffectProfile FCDEffectTechnique FCDENode FCDEntityInstance FCDExtra FCDGeometryMesh FCDGeometryPolygons FCDGeometrySpline FCDMorphController FCDMorphTarget FCDObjectWithId FCDSkinController FCDTransform List of all members.

Public Member Functions

 FCDObject (FCDocument *document)
 Constructor: sets the COLLADA document object.
virtual ~FCDObject ()
 Destructor.
FCDocumentGetDocument ()
 Retrieves the COLLADA document which owns this object.
FCDocumentGetDocument () const
 See above.
void * GetUserHandle () const
 Retrieves the object's user-specified handle.
void SetUserHandle (void *handle)
 Sets the object's user-specified handle.

Detailed Description

A basic COLLADA document object.

All the objects owned by the COLLADA document derive from this class. The FCDocument object is accessible through this interface to all the object which it owns.

Space for an handle which has no meaning to FCollada is available in this base class, for our users. You can therefore attach your own objects to most FCollada objects. If you assign memory buffers to the user-specified handle, be aware that FCollada will make no attempt to release it.


Constructor & Destructor Documentation

FCDObject::FCDObject FCDocument document  ) 
 

Constructor: sets the COLLADA document object.

Parameters:
document The COLLADA document which owns this object.


Member Function Documentation

FCDocument* FCDObject::GetDocument  )  [inline]
 

Retrieves the COLLADA document which owns this object.

Returns:
The COLLADA document.

void* FCDObject::GetUserHandle  )  const [inline]
 

Retrieves the object's user-specified handle.

This handle is available for users and has no meaning to FCollada.

Returns:
The object user-specified handle.

void FCDObject::SetUserHandle void *  handle  )  [inline]
 

Sets the object's user-specified handle.

This handle is available for users and has no meaning to FCollada.

Parameters:
handle The user-specified handle.


The documentation for this class was generated from the following file:
Generated on Fri May 12 16:44:43 2006 for FCollada by  doxygen 1.4.6-NO