CSLXSISubComponentAttributeList Class Reference

This class represents an XSI_SubComponentAttributeList template. More...

#include <XSISubComponentAttributeList.h>

Inheritance diagram for CSLXSISubComponentAttributeList:

CSLTemplate CSIBCNode CSLCOLLADASubComponentAttributeList List of all members.

Public Types
typedef CSLArrayProxy< SI_Float,
SI_Float, 1 > 		 CSLFloatArray

Public Member Functions
  CSLXSISubComponentAttributeList (CSLScene *in_pScene, CSLModel *in_pModel, CdotXSITemplate *in_pTemplate)
virtual  ~CSLXSISubComponentAttributeList ()
SI_Int  GetCount ()
virtual SI_Char *  GetSemantic ()
virtual SI_Void  SetSemantic (SI_Char *in_Semantic)
EAttributeType  GetAttributeType ()
virtual SI_Void  SetAttributeType (EAttributeType in_AttributeType)
CSLFloatArray *  GetAttributeArray ()
virtual ETemplateType  Type ()
virtual SI_Error  Synchronize ()

Detailed Description

This class represents an XSI_SubComponentAttributeList template.

Describes a sub-component attribute list for dotXSI 5.0+ (see the XSI_SubComponentAttributeList template reference).

This class holds a list of values for a specific attribute of a given type and semantic. It allows an attribute (position, normal, color, texcoord, etc.) to be associated with vertices or polynodes.

Member Typedef Documentation

typedef CSLArrayProxy<SI_Float, SI_Float, 1> CSLFloatArray

Proxy class that allows modifying a list of SI_Int like an array.

Constructor & Destructor Documentation

CSLXSISubComponentAttributeList ( CSLScene *  in_pScene,
CSLModel *  in_pModel,
CdotXSITemplate *  in_pTemplate  
)

Constructor

Parameters:
[in]  in_pScene  Parent scene
[in]  in_pModel  Parent model
[in]  in_pTemplate  Refered template
Returns:
an instance of CSLXSISubComponentAttributeList

virtual ~CSLXSISubComponentAttributeList (  )  [virtual]

Destructor

Member Function Documentation

SI_Int GetCount (  ) 

Returns the number of values in the attribute list.

Returns:
Number of attribute values.

virtual SI_Char* GetSemantic (  )  [inline, virtual]

Returns the semantic of the attribute list.

Returns:
The semantic.

Reimplemented in CSLCOLLADASubComponentAttributeList.

virtual SI_Void SetSemantic ( SI_Char *  in_Semantic  )  [inline, virtual]

Sets the semantic of the attribute list.

Parameters:
[in]  in_Semantic  The semantic.

Reimplemented in CSLCOLLADASubComponentAttributeList.

EAttributeType GetAttributeType (  )  [inline]

Returns the type of the attribute value.

Returns:
Type of the attribute value.

virtual SI_Void SetAttributeType ( EAttributeType  in_AttributeType  )  [virtual]

Sets the type of the attribute value.

Parameters:
[in]  in_AttributeType  Type of the attribute value.

Reimplemented in CSLCOLLADASubComponentAttributeList.

CSLFloatArray* GetAttributeArray (  )  [inline]

Returns the the attribute value array so that the values can be edited.

Returns:
The attribute value array.

virtual ETemplateType Type (  )  [inline, virtual]

Returns the template type

Return values:
CSLTemplate::XSI_SUB_COMPONENT_ATTRIBUTE_LIST  the template type of the sub-component attribute list

Implements CSLTemplate.

virtual SI_Error Synchronize (  )  [virtual]

Commits the current template information

Returns:
Whether or not the commit was successful

Reimplemented from CSLTemplate.

Reimplemented in CSLCOLLADASubComponentAttributeList.

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