CSLUserData Class Reference

#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

Defines user-defined data (see the XSI_UserData template reference).
Note:
This template was introduced in dotXSI Version 3.6
See also:
CSLUserDataList

Constructor & Destructor Documentation

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

Constructor

Parameters:
in_pScene  Parent scene
in_pModel  Parent model
in_pTemplate  Refered template

Member Function Documentation

ETemplateType Type (  )  [inline, virtual]

Gets the type of this template

Returns:
ETemplateType The type of this template: XSI_USER_DATA

Implements CSLTemplate.

SI_Error Synchronize (  )  [virtual]

Commits semantic layer data

Returns:
SI_Error Whether or not commit was a success

Reimplemented from CSLTemplate.

SI_UByte* GetUserDataListPtr (  ) 

Gets pointer the user data array

Returns:
SI_Int Pointer to the array containing the user data

CSLUByteArray* GetUserDataList (  ) 

Gets the user data array

Returns:
CSLUByteArray Array of user data

SI_Int GetUserDataCount (  ) 

Gets the size of the user data array

Returns:
SI_Int size of the user data

SI_Int* GetSubElementListPtr (  ) 

Gets a pointer to the sub element array

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

CSLIntArray* GetSubElementList (  ) 

Gets the sub element array

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

SI_Int GetSubElementCount (  ) 

Gets the number of sub elements

Returns:
SI_Int Number of sub elements indices

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