CSLUserDataBlob Class Reference

This class represents an XSI_UserDataBlob template. More...

#include <XSIUserData.h>

Inheritance diagram for CSLUserDataBlob:

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.

Public Member Functions

  CSLUserDataBlob (CSLScene *in_pScene, CSLModel *in_pModel, CdotXSITemplate *in_pTemplate, CSLTemplate *in_pAttachTo=NULL)
virtual  ~CSLUserDataBlob ()
  Destructor.
ETemplateType  Type ()
SI_Error  Synchronize ()
SI_UByte *  GetUserDataPtr ()
CSLUByteArray GetUserData ()
SI_Int  GetUserDataSize ()

Detailed Description

This class represents an XSI_UserDataBlob template.

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

See also:
CSLUserDataBlob
Since:
dotXSI 5.0


Constructor & Destructor Documentation

CSLUserDataBlob ( CSLScene in_pScene,
CSLModel in_pModel,
CdotXSITemplate in_pTemplate,
CSLTemplate in_pAttachTo = NULL  
)

Constructor

Parameters:
[in]  in_pScene  Parent scene
[in]  in_pModel  Parent model
[in]  in_pTemplate  Referred template
[in]  in_pAttachTo  Template to attach to


Member Function Documentation

ETemplateType Type (  )  [inline, virtual]

Returns the type of this template

Return values:
CSLTemplate::XSI_USER_DATA_BLOB  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* GetUserDataPtr (  ) 

Returns pointer the user data array

Returns:
Pointer to the array containing the user data

CSLUByteArray* GetUserData (  ) 

Returns the user data array

Returns:
Array of user data

SI_Int GetUserDataSize (  ) 

Returns the size of the user data array

Returns:
Size of the user data


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