CSLImageFX Class Reference

#include <XSIImageFX.h>

Inheritance diagram for CSLImageFX:

CSLTemplate CSIBCNode List of all members.

Public Types
enum   EScalingType {
  SI_NONE,
  SI_FULL,
  SI_HALF,
  SI_QUARTER,
  SI_128,
  SI_256,
  SI_512,
  SI_CUSTOM
}
  Defines the various scaling types. More...

Public Member Functions
  CSLImageFX (CSLScene *in_pScene, CSLModel *in_pModel, CdotXSITemplate *in_pTemplate)
virtual  ~CSLImageFX ()
  Destructor.
ETemplateType  Type ()
virtual CSLAnimatableType *  ParameterFromName (SI_Char *in_szName)
virtual CSLAnimatableType *  ParameterFromType (EFCurveType in_Type, SI_Char *in_szParameterName)
SI_Float  GetHue ()
SI_Void  SetHue (SI_Float in_fValue)
SI_Float  GetGain ()
SI_Void  SetGain (SI_Float in_fValue)
SI_Float  GetSaturation ()
SI_Void  SetSaturation (SI_Float in_fValue)
SI_Float  GetBrightness ()
SI_Void  SetBrightness (SI_Float in_fValue)
SI_Float  GetBlurRadius ()
SI_Void  SetBlurRadius (SI_Float in_fValue)
SI_Float  GetBlurAmount ()
SI_Void  SetBlurAmount (SI_Float in_fValue)
SI_Bool  GetBlurAlpha ()
SI_Void  SetBlurAlpha (SI_Bool in_bValue)
EScalingType  GetScalingType ()
SI_Void  SetScalingType (EScalingType in_Type)
SI_Float  GetHorizontalScale ()
SI_Void  SetHorizontalScale (SI_Float in_fValue)
SI_Float  GetVerticalScale ()
SI_Void  SetVerticalScale (SI_Float in_fValue)
SI_Bool  GetFlipHorizontal ()
SI_Void  SetFlipHorizontal (SI_Bool in_bValue)
SI_Bool  GetFlipVertical ()
SI_Void  SetFlipVertical (SI_Bool in_bValue)
SI_Bool  GetRGBA2Greyscale ()
SI_Void  SetRGBA2Greyscale (SI_Bool in_bValue)
SI_Bool  GetConvertTo16Bits ()
SI_Void  SetConvertTo16Bits (SI_Bool in_bValue)

Detailed Description

Base class to define image transformation effects for dotXSI 5.0+ (see the XSI_ImageFX template reference).
Note:
This template was introduced in dotXSI Version 3.6

Member Enumeration Documentation

enum EScalingType

Defines the various scaling types.

Enumerator:
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 ( 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

ETemplateType Type (  )  [inline, virtual]

Gets the type of this template

Returns:
ETemplateType The type of this template (XSI_IMAGE_FX)

Implements CSLTemplate.

virtual CSLAnimatableType* 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.

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

Return a proxy to the specified parameter.

Parameters:
in_Type  Type of parameter
in_szParameterName  Name of the parameter if the type is SI_PARAMETER
Returns:
CSLAnimatableType* Pointer to a parameter proxy.

Reimplemented from CSLTemplate.

SI_Float GetHue (  ) 

Get the Hue value

Returns:
SI_Float Hue

SI_Void SetHue ( SI_Float  in_fValue  ) 

Set the Hue value

Parameters:
SI_Float  new Hue value

SI_Float GetGain (  ) 

Get the Gain value

Returns:
SI_Float Gain

SI_Void SetGain ( SI_Float  in_fValue  ) 

Set the Gain value

Parameters:
SI_Float  new Gain value

SI_Float GetSaturation (  ) 

Get the Saturation value

Returns:
SI_Float Saturation

SI_Void SetSaturation ( SI_Float  in_fValue  ) 

Set the Saturation value

Parameters:
SI_Float  new Saturation value

SI_Float GetBrightness (  ) 

Get the Brightness value

Returns:
SI_Float Brightness

SI_Void SetBrightness ( SI_Float  in_fValue  ) 

Set the Brightness value

Parameters:
SI_Float  new Brightness value

SI_Float GetBlurRadius (  ) 

Get the Blur radius value

Returns:
SI_Float Blur radius

SI_Void SetBlurRadius ( SI_Float  in_fValue  ) 

Set the Blur radius value

Parameters:
SI_Float  new Blur radius value

SI_Float GetBlurAmount (  ) 

Get the Blur amount value

Returns:
SI_Float Blur amount

SI_Void SetBlurAmount ( SI_Float  in_fValue  ) 

Set the Blur amount value

Parameters:
SI_Float  new Blur amount value

SI_Bool GetBlurAlpha (  ) 

Get the Blur alpha value

Returns:
SI_Float Blur alpha

SI_Void SetBlurAlpha ( SI_Bool  in_bValue  ) 

Set the Blur Alpha value

Parameters:
SI_Float  new Blur Alpha value

EScalingType GetScalingType (  ) 

Get the scaling type

Returns:
EScalingType scaling type

SI_Void SetScalingType ( EScalingType  in_Type  ) 

Set the Scaling type value

Parameters:
EScalingType  the new scaling type

SI_Float GetHorizontalScale (  ) 

Get the horizontal scale value

Returns:
SI_Float horizontal scale

SI_Void SetHorizontalScale ( SI_Float  in_fValue  ) 

Set the horizontal scale value

Parameters:
SI_Float  horizontal scale

SI_Float GetVerticalScale (  ) 

Get the vertical scale value

Returns:
SI_Float vertical scale

SI_Void SetVerticalScale ( SI_Float  in_fValue  ) 

Set the vertical scale value

Parameters:
SI_Float  vertical scale

SI_Bool GetFlipHorizontal (  ) 

Get a value indicating wether the image is horizontally flipped

Returns:
SI_Bool Horitonzal flip value

SI_Void SetFlipHorizontal ( SI_Bool  in_bValue  ) 

Set a value indicating wether the image is horizontally flipped

Parameters:
SI_Bool  Horitonzal flip value

SI_Bool GetFlipVertical (  ) 

Get a value indicating wether the image is vertically flipped

Returns:
SI_Bool Vertical flip value

SI_Void SetFlipVertical ( SI_Bool  in_bValue  ) 

Set a value indicating wether the image is vertically flipped

Parameters:
SI_Bool  Vertical flip value

SI_Bool GetRGBA2Greyscale (  ) 

Get a value indicating wether the image is converted to grayscale

Returns:
SI_Bool converted to grayscale

SI_Void SetRGBA2Greyscale ( SI_Bool  in_bValue  ) 

Set a value indicating wether the image is converted to grayscale

Parameters:
SI_Bool  converted to grayscale

SI_Bool GetConvertTo16Bits (  ) 

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

Returns:
SI_Bool converted to 16bit

SI_Void SetConvertTo16Bits ( SI_Bool  in_bValue  ) 

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

Parameters:
SI_Bool  converted to 16bit

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