CSLXSISubComponentList Class Reference

This class represents an XSI_SubComponentList template. More...

#include <XSISubComponentList.h>

Inheritance diagram for CSLXSISubComponentList:

CSLTemplate CSIBCNode CSLXSIPolygonList CSLXSITriangleList CSLXSITriangleStripList CSLXSIVertexList CSLCOLLADAPolygonList CSLCOLLADATriangleList CSLCOLLADAVertexList List of all members.

Public Types

typedef CSLArrayProxy< SI_Int,
SI_Int, 1 > 
CSLIntArray
typedef CSLArrayProxy< SI_Char *,
SI_Char *, 1 > 
CSLStringArray

Public Member Functions

  CSLXSISubComponentList (CSLScene *in_pScene, CSLModel *in_pModel, CdotXSITemplate *in_pTemplate)
virtual  ~CSLXSISubComponentList ()
SI_Int  GetCount ()
virtual SI_Error  SetCount (SI_Int)
SI_Int  GetAttributeCount ()
SI_Int  AddAttribute (SI_Char *)
SI_Error  RemoveAttribute ()
SI_Error  ClearAttribute ()
CSLIntArray GetAttributeIndices (SI_Int in_iIndex)
CSIBCArray< CSLIntArray * > *  GetAttributeIndicesArray ()
CSLStringArray GetAttributeNameArray ()
CSLArrayProxy< SI_Int, SI_Int, 1 > *  GetAttributeByName (SI_Char *in_pName)
CSIBCString GetSemantic (int in_iIndx)
SI_Void  SetSemantic (int in_iIndx, CSIBCString in_szSemantic)
CSIBCString GetSource (int in_iIndx)
SI_Void  SetSource (int in_iIndx, CSIBCString in_szSource)

Detailed Description

This class represents an XSI_SubComponentList template.

Describes a subcomponent list base class for dotXSI 5.0+ (see the XSI_SubComponentList template reference).

This class holds a list of attribute references. Each attributes list is referenced by name and a corresponding indices array matches the sub component node with the attribute value.

CSLXSISubComponentList allows an element composed of sub-component (vertex list, polygon list, etc.) to referenced attributes (position, normal, colors, etc.) for its nodes, by name. A corresponding indices array is associated to each attribute reference to match the subcomponent node with the attribute value.


Member Typedef Documentation

typedef CSLArrayProxy<SI_Int, SI_Int, 1> CSLIntArray

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

Reimplemented in CSLXSIPolygonList, and CSLXSITriangleStripList.

typedef CSLArrayProxy<SI_Char*, SI_Char*, 1> CSLStringArray

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


Constructor & Destructor Documentation

CSLXSISubComponentList ( 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 CSLXSISubComponentList

virtual ~CSLXSISubComponentList (  )  [virtual]

Destructor


Member Function Documentation

SI_Int GetCount (  ) 

Returns the number of node (polynode/vertex/etc.) in this sub component list.

Returns:
Number of sub component node.

virtual SI_Error SetCount ( SI_Int   )  [virtual]

Sets the number of node (polynode/vertex/etc.) in this sub component list.

Returns:
Error code.

Reimplemented in CSLXSIPolygonList, CSLXSITriangleList, and CSLXSITriangleStripList.

SI_Int GetAttributeCount (  ) 

Returns the number of attribute accessors.

Returns:
Number of attribute accessors.

SI_Int AddAttribute ( SI_Char *   ) 

Creates a new attribute accessor element.

Returns:
The index of the newly created attribute elements.

SI_Error RemoveAttribute (  ) 

Removes the last attribute accessor.

Returns:
Error code.

SI_Error ClearAttribute (  ) 

Removes all the attribute accessors.

Returns:
Error code.

CSLIntArray* GetAttributeIndices ( SI_Int  in_iIndex  ) 

Returns the attribute indices.

Parameters:
[in]  in_iIndex  Index of attribute index to find
Returns:
Attribute indices.

CSIBCArray<CSLIntArray*>* GetAttributeIndicesArray (  ) 

Returns the attribute indices array.

Returns:
Attribute indices array.

CSLStringArray* GetAttributeNameArray (  ) 

Returns the attribute name array.

Returns:
Attribute name array.

CSLArrayProxy<SI_Int, SI_Int, 1>* GetAttributeByName ( SI_Char *  in_pName  ) 

Returns the index of the first attribute with the specified name from the array.

Parameters:
[in]  in_pName  Name of attribute to find
Returns:
The attribute indices array of the attibute with the specified name.

CSIBCString& GetSemantic ( int  in_iIndx  ) 

Returns the associated semantic

Parameters:
[in]  in_iIndx  Index of semantic to find
Returns:
The semantic

SI_Void SetSemantic ( int  in_iIndx,
CSIBCString  in_szSemantic  
)

Sets the associated semantic

Parameters:
[in]  in_iIndx  Index of source to set
[in]  in_szSemantic  Semantic to set

CSIBCString& GetSource ( int  in_iIndx  ) 

Returns the associated Source

Parameters:
[in]  in_iIndx  Index of source to find
Returns:
The Source

SI_Void SetSource ( int  in_iIndx,
CSIBCString  in_szSource  
)

Sets the associated Source

Parameters:
[in]  in_iIndx  Index of source to set
[in]  in_szSource  Source to set


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