FCDEffectParameterSampler Class Reference
[COLLADA Effect Classes [ColladaFX]]

A COLLADA sampler effect parameter. More...

#include <FCDEffectParameter.h>

Inheritance diagram for FCDEffectParameterSampler:

List of all members.

Public Types
enum	SamplerType { SAMPLER1D, SAMPLER2D, SAMPLER3D, SAMPLERCUBE }
	The type of sampling to execute. More...
Public Member Functions
	FCDEffectParameterSampler (FCDocument *document)
	Constructor: do not use directly.
virtual	~FCDEffectParameterSampler ()
	Destructor: do not use directly.
virtual Type	GetType () const
	Retrieves the type of effect parameter class.
const char *	GetSurfaceSid () const
	Retrieves the sub-id of the surface parameter.
void	SetSurfaceSid (const char *sid)
	Sets the sub-id of the surface parameter to sample.
SamplerType	GetSamplerType () const
	Retrieves the type of sampling to do.
void	SetSamplerType (SamplerType type)
	Sets the type of sampling to do.
virtual FCDEffectParameter *	Clone ()
	Creates a full copy of the effect parameter.
virtual void	Overwrite (FCDEffectParameter *target)
	[INTERNAL] Overwrites the target parameter with this parameter.
virtual FUStatus	LoadFromXML (xmlNode *parameterNode)
	[INTERNAL] Reads in the effect parameter from a given COLLADA XML tree node.
virtual xmlNode *	WriteToXML (xmlNode *parentNode) const
	[INTERNAL] Writes out the effect parameter to the given COLLADA XML tree node.

---

Detailed Description

A COLLADA sampler effect parameter.

A sampler parameter provides the extra texturing information necessary to correctly sample a surface parameter. There are four types of samplers supported: 1D, 2D, 3D and cube.

---

Member Enumeration Documentation

enum FCDEffectParameterSampler::SamplerType

The type of sampling to execute. Enumerator: SAMPLER2D  1D sampling. SAMPLER3D  2D sampling. SAMPLERCUBE  Cube-map sampling.

---

Constructor & Destructor Documentation

FCDEffectParameterSampler::FCDEffectParameterSampler (  FCDocument *  document  )

Constructor: do not use directly. Instead, use the FCDEffectParameterList::AddParameter function. Parameters: document  The COLLADA document that owns the effect parameter.

virtual FCDEffectParameterSampler::~FCDEffectParameterSampler (   )  [virtual]

Destructor: do not use directly. Instead, use the FCDEffectParameterList::ReleaseParameter function. When released, the effect parameter list will also release all its parameters, if it owns them.

---

Member Function Documentation

virtual FCDEffectParameter* FCDEffectParameterSampler::Clone (   )  [virtual]

Creates a full copy of the effect parameter. Returns: The cloned effect parameter. You will need to delete this pointer. Implements FCDEffectParameter.

SamplerType FCDEffectParameterSampler::GetSamplerType (   )  const [inline]

Retrieves the type of sampling to do. Returns: The sampling type.

const char* FCDEffectParameterSampler::GetSurfaceSid (   )  const [inline]

Retrieves the sub-id of the surface parameter. You will want to search for that sub-id within the parameters to find the FCDEffectParameterSurface object. Returns: The sub-id.

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

Retrieves the type of effect parameter class. Returns: The parameter class type: SAMPLER. Implements FCDEffectParameter.

virtual FUStatus FCDEffectParameterSampler::LoadFromXML (  xmlNode *  parameterNode  )  [virtual]

[INTERNAL] Reads in the effect parameter from a given COLLADA XML tree node. Parameters: parameterNode  The COLLADA XML tree node. Returns: The status of the import. If the status is not successful, it may be dangerous to extract information from the parameter. Reimplemented from FCDEffectParameter.

virtual void FCDEffectParameterSampler::Overwrite (  FCDEffectParameter *  target  )  [virtual]

[INTERNAL] Overwrites the target parameter with this parameter. This function is used during the flattening of materials. Parameters: target  The target parameter to overwrite. Reimplemented from FCDEffectParameter.

void FCDEffectParameterSampler::SetSamplerType (  SamplerType  type  )  [inline]

Sets the type of sampling to do. Parameters: type  The sampling type.

void FCDEffectParameterSampler::SetSurfaceSid (  const char *  sid  )  [inline]

Sets the sub-id of the surface parameter to sample. Parameters: sid  The surface parameter sub-id.

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

[INTERNAL] Writes out the effect parameter to the given COLLADA XML tree node. Parameters: parentNode  The COLLADA XML parent node in which to insert the parameter. Returns: The created element XML tree node. Reimplemented from FCDEffectParameter.

---

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

• FCDocument/FCDEffectParameter.h

---