Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   Compound Members  

CSLImage Class Reference

#include <XSIImage.h>

Inheritance diagram for CSLImage::

CSLTemplate CSIBCNode List of all members.

Public Types

Public Methods


Detailed Description

Class XSIImage

Describes an image

Note:
This template was introduced in dotXSI Version 3.6


Member Enumeration Documentation

enum CSLImage::EChannels
 

Defines the number of channels of an image.

Enumeration values:
SI_RGB  red, green and blue channels>.
SI_RGBA  red, green, blue and alpha channels>.

enum CSLImage::EColorDepth
 

Defines the supported color depths for images.

Enumeration values:
SI_24BITS  24 bits>.
SI_32BITS  32 bits>.


Constructor & Destructor Documentation

CSLImage::CSLImage 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

CSLImageData * CSLImage::ConnectImageData CSLImageData   in_pImageData
 

Connects the image data

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

CSLImageFX * CSLImage::ConnectImageFX CSLImageFX   in_pNewImageFX
 

Connects an exisiting Image FX

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

CSLImageData * CSLImage::CreateImageData  
 

Allocates and connect a new image data

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

CSLImageFX * CSLImage::CreateImageFX  
 

Creates a new Image FX

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

SI_Error CSLImage::DestroyImageData  
 

Destroys the Image Data

Returns:
SI_Error Whether or not the image data could be destroyed

SI_Error CSLImage::DestroyImageFX  
 

Destroys the Image FX

Returns:
SI_Error Whether or not the ImageFX could be destroyed

CSLImage::EChannels CSLImage::GetChannels  
 

Gets the number of channels for a pixel

Returns:
EChannels Number of channels

CSLImage::EColorDepth CSLImage::GetColorDepth  
 

Gets the color depth of the image

Returns:
EColorDepth Color depth

SI_Float CSLImage::GetCropMaxX  
 

Gets the maximum horizontal crop value

Returns:
SI_Float Crop value

SI_Float CSLImage::GetCropMaxY  
 

Gets the maximum vertical crop value

Returns:
SI_Float Crop value

SI_Float CSLImage::GetCropMinX  
 

Gets the minimum horizontal crop value

Returns:
SI_Int Crop value

SI_Float CSLImage::GetCropMinY  
 

Gets the minimum vertical crop value

Returns:
SI_Float Crop value

SI_Int CSLImage::GetFirstFrame  
 

Gets the first frame

Returns:
SI_Int Frame number

SI_Float CSLImage::GetFrameRate  
 

Gets the frame rate

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

SI_Int CSLImage::GetHeight  
 

Gets the vertical resolution of the image

Returns:
SI_Int Size

SI_Int CSLImage::GetLastFrame  
 

Gets the last frame

Returns:
SI_Int Frame number

SI_Char * CSLImage::GetSourceFile  
 

Gets the filename of the image

Returns:
SI_Char Filename

SI_Int CSLImage::GetWidth  
 

Gets the horizontal resolution of the image

Returns:
SI_Int 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.

CSLImageData * CSLImage::ImageData  
 

Gets the image data

Returns:
CSLImageData 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.

CSLImageFX * CSLImage::ImageFX  
 

Gets a pointer to the Image FX

Returns:
CSLImageFX Pointer to the Image FX

CSLAnimatableType * CSLImage::ParameterFromName SI_Char *    in_szName [virtual]
 

Return a proxy to the specified parameter.

Parameters:
in_szName  Name of the parameter
Returns:
CSLAnimatableType* Pointer to a parameter proxy.

Reimplemented from CSLTemplate.

SI_Void CSLImage::SetChannels CSLImage::EChannels    in_Channel
 

Sets the number of channels for a pixel

Parameters:
in_Channel  Number of channels

SI_Void CSLImage::SetColorDepth CSLImage::EColorDepth    in_Depth
 

Sets the color depth of the image

Parameters:
in_Depth  Color depth

SI_Void CSLImage::SetCropMaxX SI_Float    in_fCrop
 

Sets the maximum horizontal crop value

Parameters:
in_fCropCrop  value

SI_Void CSLImage::SetCropMaxY SI_Float    in_fCrop
 

Sets the maximum vertical crop value

Parameters:
in_fCrop  Crop value

SI_Void CSLImage::SetCropMinX SI_Float    in_fCrop
 

Sets the minimum horizontal crop value

Parameters:
in_fCrop  Crop value

SI_Void CSLImage::SetCropMinY SI_Float    in_fCrop
 

Sets the minimum vertical crop value

Parameters:
in_fCrop  Crop value

SI_Void CSLImage::SetFirstFrame SI_Int    in_nFrame
 

Sets the first frame

Parameters:
in_nFrame  Frame number

SI_Void CSLImage::SetFrameRate SI_Float    in_nRate = 0.0
 

Sets the frame rate

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

SI_Void CSLImage::SetHeight SI_Int    in_nSize
 

Sets the vertical resolution of the image

Parameters:
in_nSize  Size

SI_Void CSLImage::SetLastFrame SI_Int    in_nFrame
 

Sets the last frame

Parameters:
in_nFrame  Frame number

SI_Void CSLImage::SetSourceFile SI_Char *    in_szFilename
 

Sets the filename of the image

ame in_szFilename Filename

SI_Void CSLImage::SetWidth SI_Int    in_nSize
 

Sets the horizontal resolution of the image

Parameters:
in_nSize  Size

SI_Error CSLImage::Synchronize   [virtual]
 

Commits Semantic Layer data

Returns:
SI_Error Whether or not commit was a success

Reimplemented from CSLTemplate.

ETemplateType CSLImage::Type   [inline, virtual]
 

Gets the type of this template

Returns:
ETemplateType The type of this template: XSI_IMAGE

Reimplemented from CSLTemplate.


The documentation for this class was generated from the following files: © Copyright 2001-2003 Avid Technology, Inc. All rights reserved.

© Copyright 2001-2003 Avid Technology, Inc. All rights reserved.