Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   Compound Members  

CSLImageFX Class Reference

#include <XSIImageFX.h>

Inheritance diagram for CSLImageFX::

CSLTemplate CSIBCNode List of all members.

Public Types

Public Methods


Detailed Description

Class CSLImageFX

Defines image transformation effects

Note:
This template was introduced in dotXSI Version 3.6


Member Enumeration Documentation

enum CSLImageFX::EScalingType
 

Defines the various scaling types.

Enumeration values:
SI_NONE  0-none
SI_FULL  1-fullsize
SI_HALF  2-halfsize
SI_QUARTER  3-quartersize
SI_128  4-128 X 128
SI_256  5-256 X 256
SI_512  6-512 X 512
SI_CUSTOM  7- Custom (use scale X and scale Y)


Constructor & Destructor Documentation

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

SI_Bool CSLImageFX::GetBlurAlpha  
 

Get the Blur alpha value

Returns:
SI_Float Blur alpha

SI_Float CSLImageFX::GetBlurAmount  
 

Get the Blur amount value

Returns:
SI_Float Blur amount

SI_Float CSLImageFX::GetBlurRadius  
 

Get the Blur radius value

Returns:
SI_Float Blur radius

SI_Float CSLImageFX::GetBrightness  
 

Get the Brightness value

Returns:
SI_Float Brightness

SI_Bool CSLImageFX::GetConvertTo16Bits  
 

Get a value indicating wether the image is converted to 16bit

Returns:
SI_Bool converted to 16bit

SI_Bool CSLImageFX::GetFlipHorizontal  
 

Get a value indicating wether the image is horizontally flipped

Returns:
SI_Bool Horitonzal flip value

SI_Bool CSLImageFX::GetFlipVertical  
 

Get a value indicating wether the image is vertically flipped

Returns:
SI_Bool Vertical flip value

SI_Float CSLImageFX::GetGain  
 

Get the Gain value

Returns:
SI_Float Gain

SI_Float CSLImageFX::GetHorizontalScale  
 

Get the horizontal scale value

Returns:
SI_Float horizontal scale

SI_Float CSLImageFX::GetHue  
 

Get the Hue value

Returns:
SI_Float Hue

SI_Bool CSLImageFX::GetRGBA2Greyscale  
 

Get a value indicating wether the image is converted to grayscale

Returns:
SI_Bool converted to grayscale

SI_Float CSLImageFX::GetSaturation  
 

Get the Saturation value

Returns:
SI_Float Saturation

CSLImageFX::EScalingType CSLImageFX::GetScalingType  
 

Get the scaling type

Returns:
EScalingType scaling type

SI_Float CSLImageFX::GetVerticalScale  
 

Get the vertical scale value

Returns:
SI_Float vertical scale

CSLAnimatableType * CSLImageFX::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 CSLImageFX::SetBlurAlpha SI_Bool    in_bValue
 

Set the Blur Alpha value

Parameters:
SI_Float  new Blur Alpha value

SI_Void CSLImageFX::SetBlurAmount SI_Float    in_fValue
 

Set the Blur amount value

Parameters:
SI_Float  new Blur amount value

SI_Void CSLImageFX::SetBlurRadius SI_Float    in_fValue
 

Set the Blur radius value

Parameters:
SI_Float  new Blur radius value

SI_Void CSLImageFX::SetBrightness SI_Float    in_fValue
 

Set the Brightness value

Parameters:
SI_Float  new Brightness value

SI_Void CSLImageFX::SetConvertTo16Bits SI_Bool    in_bValue
 

Set a value indicating wether the image is converted to 16bit

Parameters:
SI_Bool  converted to 16bit

SI_Void CSLImageFX::SetFlipHorizontal SI_Bool    in_bValue
 

Set a value indicating wether the image is horizontally flipped

Parameters:
SI_Bool  Horitonzal flip value

SI_Void CSLImageFX::SetFlipVertical SI_Bool    in_bValue
 

Set a value indicating wether the image is vertically flipped

Parameters:
SI_Bool  Vertical flip value

SI_Void CSLImageFX::SetGain SI_Float    in_fValue
 

Set the Gain value

Parameters:
SI_Float  new Gain value

SI_Void CSLImageFX::SetHorizontalScale SI_Float    in_fValue
 

Set the horizontal scale value

Parameters:
SI_Float  horizontal scale

SI_Void CSLImageFX::SetHue SI_Float    in_fValue
 

Set the Hue value

Parameters:
SI_Float  new Hue value

SI_Void CSLImageFX::SetRGBA2Greyscale SI_Bool    in_bValue
 

Set a value indicating wether the image is converted to grayscale

Parameters:
SI_Bool  converted to grayscale

SI_Void CSLImageFX::SetSaturation SI_Float    in_fValue
 

Set the Saturation value

Parameters:
SI_Float  new Saturation value

SI_Void CSLImageFX::SetScalingType CSLImageFX::EScalingType    in_Type
 

Set the Scaling type value

Parameters:
EScalingType  the new scaling type

SI_Void CSLImageFX::SetVerticalScale SI_Float    in_fValue
 

Set the vertical scale value

Parameters:
SI_Float  vertical scale

ETemplateType CSLImageFX::Type   [inline, virtual]
 

Gets the type of this template

Returns:
ETemplateType The type of this template (XSI_IMAGE_FX)

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.