CSLUserData Class Reference

This class represents an XSI_UserData template. More...

#include <XSIUserData.h>

Inheritance diagram for CSLUserData:

CSLTemplate CSIBCNode List of all members.

Public Types

typedef CSLArrayProxy< SI_UByte,
SI_UByte, 1 > 
CSLUByteArray
  Unsigned Byte array proxy class that works like an array of SI_UByte.
typedef CSLArrayProxy< SI_Int,
SI_Int, 1 > 
CSLIntArray
  Int array proxy class that works like an array of SI_Int.

Public Member Functions

  CSLUserData (CSLScene *in_pScene, CSLModel *in_pModel, CdotXSITemplate *in_pTemplate)
virtual  ~CSLUserData ()
  Destructor.
ETemplateType  Type ()
SI_Error  Synchronize ()
SI_UByte *  GetUserDataListPtr ()
CSLUByteArray GetUserDataList ()
SI_Int  GetUserDataCount ()
SI_Int *  GetSubElementListPtr ()
CSLIntArray GetSubElementList ()
SI_Int  GetSubElementCount ()

Detailed Description

This class represents an XSI_UserData template.

Defines user-defined data (see the XSI_UserData template reference).

See also:
CSLUserDataList
Since:
dotXSI 3.6


Constructor & Destructor Documentation

CSLUserData ( CSLScene in_pScene,
CSLModel in_pModel,
CdotXSITemplate in_pTemplate  
)

Constructor

Parameters:
[in]  in_pScene  Parent scene
[in]  in_pModel  Parent model
[in]  in_pTemplate  Referred template


Member Function Documentation

ETemplateType Type (  )  [inline, virtual]

Returns the type of this template

Return values:
CSLTemplate::XSI_USER_DATA  The type of this template

Implements CSLTemplate.

SI_Error Synchronize (  )  [virtual]

Commits semantic layer data

Returns:
Whether or not commit was a success

Reimplemented from CSLTemplate.

SI_UByte* GetUserDataListPtr (  ) 

Returns pointer the user data array

Returns:
Pointer to the array containing the user data

CSLUByteArray* GetUserDataList (  ) 

Returns the user data array

Returns:
Array of user data

SI_Int GetUserDataCount (  ) 

Returns the size of the user data array

Returns:
Size of the user data

SI_Int* GetSubElementListPtr (  ) 

Returns a pointer to the sub element array

Returns:
Pointer to the array containing indices for all affected vertices/edges/polygons

CSLIntArray* GetSubElementList (  ) 

Returns the sub element array

Returns:
Pointer to the array containing indices for all affected vertices/edges/polygons

SI_Int GetSubElementCount (  ) 

Returns the number of sub elements

Returns:
Number of sub elements indices


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