FCDEffectParameterSurfaceInit Class Reference
[COLLADA Effect Classes [ColladaFX]]

A surface initialization method. More...

#include <FCDEffectParameterSurface.h>

Inheritance diagram for FCDEffectParameterSurfaceInit:

FCDEffectParameterSurfaceInitAsNull FCDEffectParameterSurfaceInitAsTarget FCDEffectParameterSurfaceInitCube FCDEffectParameterSurfaceInitFrom FCDEffectParameterSurfaceInitPlanar FCDEffectParameterSurfaceInitVolume List of all members.

Public Member Functions

 FCDEffectParameterSurfaceInit ()
 Constructor: builds a new surface initialization method.
virtual ~FCDEffectParameterSurfaceInit ()
 Destructor.
virtual FCDEffectParameterSurfaceInitFactory::InitType GetInitType () const =0
 Retrieves the initialization type.
void Clone (FCDEffectParameterSurfaceInit *clone)
 Copies all member variables into clone.
virtual FCDEffectParameterSurfaceInitClone ()=0
 Creates a full copy of the surface initialization parameter.

Detailed Description

A surface initialization method.

In COLLADA 1.4.1, this information was added to support complex surface types. There are six types of initialization methods, described in the InitType enumerated type. Expect the FROM initialization type in the large majority of cases.


Member Function Documentation

virtual FCDEffectParameterSurfaceInit* FCDEffectParameterSurfaceInit::Clone  )  [pure virtual]
 

Creates a full copy of the surface initialization parameter.

Returns:
The surface initialization parameter. You will need to delete this pointer.

Implemented in FCDEffectParameterSurfaceInitCube, FCDEffectParameterSurfaceInitVolume, FCDEffectParameterSurfaceInitFrom, FCDEffectParameterSurfaceInitAsNull, FCDEffectParameterSurfaceInitAsTarget, and FCDEffectParameterSurfaceInitPlanar.

void FCDEffectParameterSurfaceInit::Clone FCDEffectParameterSurfaceInit clone  ) 
 

Copies all member variables into clone.

Parameters:
clone a valid pointer to a FCDEffectParameterSurfaceInit object

virtual FCDEffectParameterSurfaceInitFactory::InitType FCDEffectParameterSurfaceInit::GetInitType  )  const [pure virtual]
 

Retrieves the initialization type.

You cannot modify this value. To change the initialization type of a surface parameter, create a new surface initialization structure of the correct type.

Returns:
The initialization type.

Implemented in FCDEffectParameterSurfaceInitCube, FCDEffectParameterSurfaceInitVolume, FCDEffectParameterSurfaceInitFrom, FCDEffectParameterSurfaceInitAsNull, FCDEffectParameterSurfaceInitAsTarget, and FCDEffectParameterSurfaceInitPlanar.


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