CSLImage Class Reference

This class represents an XSI_Image template. More...

#include <XSIImage.h>

Inheritance diagram for CSLImage:

CSLTemplate CSIBCNode List of all members.

Public Types
enum   EChannels {
  SI_RGB = 3,
  SI_RGBA = 4
}
  Defines the number of channels of an image. More...
enum   EColorDepth {
  SI_24BITS = 24,
  SI_32BITS = 32
}
  Defines the supported color depths for images. More...

Public Member Functions
  CSLImage (CSLScene *in_pScene, CSLModel *in_pModel, CdotXSITemplate *in_pTemplate)
virtual  ~CSLImage ()
  Destructor.
SI_Error  Synchronize ()
ETemplateType  Type ()
virtual CSLAnimatableType *  ParameterFromName (SI_Char *in_szName)
virtual CSLAnimatableType *  ParameterFromType (EFCurveType in_Type, SI_Char *in_szParameterName)
SI_Char *  GetSourceFile ()
SI_Void  SetSourceFile (SI_Char *in_szFilename)
SI_Int  GetWidth ()
SI_Void  SetWidth (SI_Int in_nSize)
SI_Int  GetHeight ()
SI_Void  SetHeight (SI_Int in_nSize)
EChannels  GetChannels ()
SI_Void  SetChannels (EChannels in_Channel)
EColorDepth  GetColorDepth ()
SI_Void  SetColorDepth (EColorDepth in_Depth)
SI_Float  GetCropMinX ()
SI_Void  SetCropMinX (SI_Float in_fCrop)
SI_Float  GetCropMaxX ()
SI_Void  SetCropMaxX (SI_Float in_fCrop)
SI_Float  GetCropMinY ()
SI_Void  SetCropMinY (SI_Float in_fCrop)
SI_Float  GetCropMaxY ()
SI_Void  SetCropMaxY (SI_Float in_fCrop)
SI_Float  GetFrameRate ()
SI_Void  SetFrameRate (SI_Float in_nRate=0.0)
SI_Int  GetFirstFrame ()
SI_Void  SetFirstFrame (SI_Int in_nFrame)
SI_Int  GetLastFrame ()
SI_Void  SetLastFrame (SI_Int in_nFrame)
CSLImageData *  CreateImageData ()
SI_Error  DestroyImageData ()
CSLImageData *  ConnectImageData (CSLImageData *in_pImageData)
CSLImageData *  ImageData ()
CSLImageFX *  CreateImageFX ()
SI_Error  DestroyImageFX ()
CSLImageFX *  ConnectImageFX (CSLImageFX *in_pToConnect)
CSLImageFX *  ImageFX ()
CSLImageFX2 *  CreateImageFX2 ()
SI_Error  DestroyImageFX2 ()
CSLImageFX2 *  ConnectImageFX2 (CSLImageFX2 *in_pToConnect)
CSLImageFX2 *  ImageFX2 ()

Detailed Description

This class represents an XSI_Image template.

Base class to describe an image for dotXSI 5.0+ (see the XSI_Image template reference).

Since:
dotXSI 3.6

Member Enumeration Documentation

enum EChannels

Defines the number of channels of an image.

Enumerator:
SI_RGB  red, green and blue channels>
SI_RGBA  red, green, blue and alpha channels>

enum EColorDepth

Defines the supported color depths for images.

Enumerator:
SI_24BITS  24 bits>
SI_32BITS  32 bits>

Constructor & Destructor Documentation

CSLImage ( 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  Template type

Implements CSLTemplate.

virtual CSLAnimatableType* ParameterFromName ( SI_Char *  in_szName  )  [virtual]

Returns a proxy to the specified parameter.

Parameters:
[in]  in_szName  Name of the parameter
Returns:
Pointer to a parameter proxy.

Reimplemented from CSLTemplate.

virtual CSLAnimatableType* ParameterFromType ( EFCurveType  in_Type,
SI_Char *  in_szParameterName  
) [virtual]

Returns a proxy to the specified parameter.

Parameters:
[in]  in_Type  Type of parameter
[in]  in_szParameterName  Name of the parameter if the type is SI_PARAMETER
Returns:
Pointer to a parameter proxy.

Reimplemented from CSLTemplate.

SI_Char* GetSourceFile (  ) 

Returns the filename of the image

Returns:
Filename

SI_Void SetSourceFile ( SI_Char *  in_szFilename  ) 

Sets the filename of the image

Parameters:
[in]  in_szFilename  Filename

SI_Int GetWidth (  ) 

Returns the horizontal resolution of the image

Returns:
Size
Note:
A source file name and the internally stored CSLImageData class are mutually exclusive. Setting the source file therefore deletes the image data on your behalf.

SI_Void SetWidth ( SI_Int  in_nSize  ) 

Sets the horizontal resolution of the image

Parameters:
[in]  in_nSize  Size

SI_Int GetHeight (  ) 

Returns the vertical resolution of the image

Returns:
Size

SI_Void SetHeight ( SI_Int  in_nSize  ) 

Sets the vertical resolution of the image

Parameters:
[in]  in_nSize  Size

EChannels GetChannels (  ) 

Returns the number of channels for a pixel

Returns:
Number of channels

SI_Void SetChannels ( EChannels  in_Channel  ) 

Sets the number of channels for a pixel

Parameters:
[in]  in_Channel  Number of channels

EColorDepth GetColorDepth (  ) 

Returns the color depth of the image

Returns:
Color depth

SI_Void SetColorDepth ( EColorDepth  in_Depth  ) 

Sets the color depth of the image

Parameters:
[in]  in_Depth  Color depth

SI_Float GetCropMinX (  ) 

Returns the minimum horizontal crop value

Returns:
Crop value

SI_Void SetCropMinX ( SI_Float  in_fCrop  ) 

Sets the minimum horizontal crop value

Parameters:
[in]  in_fCrop  Crop value

SI_Float GetCropMaxX (  ) 

Returns the maximum horizontal crop value

Returns:
Crop value

SI_Void SetCropMaxX ( SI_Float  in_fCrop  ) 

Sets the maximum horizontal crop value

Parameters:
[in]  in_fCrop  Crop value

SI_Float GetCropMinY (  ) 

Returns the minimum vertical crop value

Returns:
Crop value

SI_Void SetCropMinY ( SI_Float  in_fCrop  ) 

Sets the minimum vertical crop value

Parameters:
[in]  in_fCrop  Crop value

SI_Float GetCropMaxY (  ) 

Returns the maximum vertical crop value

Returns:
Crop value

SI_Void SetCropMaxY ( SI_Float  in_fCrop  ) 

Sets the maximum vertical crop value

Parameters:
[in]  in_fCrop  Crop value

SI_Float GetFrameRate (  ) 

Returns the frame rate

Returns:
Actual frame rate
Note:
A frame rate of 0 refers to the scene frame rate

SI_Void SetFrameRate ( SI_Float  in_nRate = 0.0  ) 

Sets the frame rate

Parameters:
[in]  in_nRate  Actual frame rate
Note:
A frame rate of 0 refers to the scene frame rate

SI_Int GetFirstFrame (  ) 

Returns the first frame

Returns:
Frame number

SI_Void SetFirstFrame ( SI_Int  in_nFrame  ) 

Sets the first frame

Parameters:
[in]  in_nFrame  Frame number

SI_Int GetLastFrame (  ) 

Returns the last frame

Returns:
Frame number

SI_Void SetLastFrame ( SI_Int  in_nFrame  ) 

Sets the last frame

Parameters:
[in]  in_nFrame  Frame number

CSLImageData* CreateImageData (  ) 

Allocates and connect a new image data

Returns:
Newly allocated image data. Null if there was already one.

SI_Error DestroyImageData (  ) 

Destroys the Image Data

Returns:
Whether or not the image data could be destroyed

CSLImageData* ConnectImageData ( CSLImageData *  in_pImageData  ) 

Connects the image data

Note:
A source file name and the internally stored CSLImageData class are mutually exclusive. Setting an image data therefore clears the source file name.
Parameters:
[in]  in_pImageData  New image data to use

CSLImageData* ImageData (  ) 

Returns the image data

Note:
A source file name and the internally stored CSLImageData class are mutually exclusive. Setting an image data therefore clears the source file name.
Returns:
Image data

CSLImageFX* CreateImageFX (  ) 

Creates a new Image FX

Returns:
The new ImageFX or null if there's already one

SI_Error DestroyImageFX (  ) 

Destroys the Image FX

Returns:
Whether or not the ImageFX could be destroyed

CSLImageFX* ConnectImageFX ( CSLImageFX *  in_pToConnect  ) 

Connects an exisiting Image FX

Parameters:
[in]  in_pToConnect  Pointer to the ImageFX to use
Returns:
The added ImageFX or null if there's already one

CSLImageFX* ImageFX (  ) 

Returns a pointer to the Image FX

Returns:
Pointer to the Image FX

CSLImageFX2* CreateImageFX2 (  ) 

Creates a new Image FX 2

Returns:
The new ImageFX2 or null if there's already one

SI_Error DestroyImageFX2 (  ) 

Destroys the Image FX 2

Returns:
Whether or not the ImageFX2 could be destroyed

CSLImageFX2* ConnectImageFX2 ( CSLImageFX2 *  in_pToConnect  ) 

Connects an exisiting Image FX 2

Parameters:
[in]  in_pToConnect  Pointer to the ImageFX2 to use
Returns:
The added ImageFX2 or null if there's already one

CSLImageFX2* ImageFX2 (  ) 

Returns a pointer to the Image FX 2

Returns:
Pointer to the Image FX 2

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