CSLImageData Class Reference

This class represents an XSI_ImageData template. More...

#include <XSIImageData.h>

Inheritance diagram for CSLImageData:

CSLTemplate CSIBCNode List of all members.

Public Types
enum   ECompressionType { SI_UNCOMPRESSED = 0 }
  Defines the various compression types. More...
typedef CSLArrayProxy< SI_Int,
SI_Int, 1 > 		 CSLIntArray

Public Member Functions
  CSLImageData (CSLScene *in_pScene, CSLModel *in_pModel, CdotXSITemplate *in_pTemplate)
virtual  ~CSLImageData ()
  Destructor.
SI_Error  Synchronize ()
ETemplateType  Type ()
SI_Void  SetImageData (CSIBCArray< SI_Int > &in_Data)
SI_Int  GetImageDataCount ()
CSLIntArray *  GetImageDataList ()
SI_Int *  GetImageDataListPtr ()
ECompressionType  GetCompressionType ()
SI_Void  SetCompressionType (ECompressionType in_Type)

Detailed Description

This class represents an XSI_ImageData template.

Base class to define the raw pixel information of an image for dotXSI 5.0+ (see the XSI_ImageData template reference).

Since:
dotXSI 3.6

Member Typedef Documentation

typedef CSLArrayProxy<SI_Int, SI_Int, 1> CSLIntArray

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

Member Enumeration Documentation

enum ECompressionType

Defines the various compression types.

Enumerator:
SI_UNCOMPRESSED  No compression

Constructor & Destructor Documentation

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

Member Function Documentation

SI_Error Synchronize (  )  [virtual]

Commits Semantic Layer data

Returns:
Whether or not commit was a success

Reimplemented from CSLTemplate.

ETemplateType Type (  )  [inline, virtual]

Returns the type of this template

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

Implements CSLTemplate.

SI_Void SetImageData ( CSIBCArray< SI_Int > &  in_Data  ) 

Sets the raw color information of the image

Parameters:
[in]  in_Data  Array containing the raw color information

SI_Int GetImageDataCount (  ) 

Returns the size of the image data color information

Returns:
size of the image data color information

CSLIntArray* GetImageDataList (  ) 

Returns the color information array

Returns:
Array of color information

SI_Int* GetImageDataListPtr (  ) 

Returns a pointer to the raw color information of the image

Returns:
Pointer to the array containing the color information

ECompressionType GetCompressionType (  ) 

Returns the compression type of the image

Returns:
The type of compression

SI_Void SetCompressionType ( ECompressionType  in_Type  ) 

Sets the compression type of the image

Parameters:
[in]  in_Type  The type of compression

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