CSLImageFX Class Reference

This class represents an XSI_ImageFX template. More...

#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

This class represents an XSI_ImageFX template.

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]  in_pScene  Parent scene
[in]  in_pModel  Parent model
[in]  in_pTemplate  Refered template

Member Function Documentation

ETemplateType Type (  )  [inline, virtual]

Returns the type of this template

Return values:
CSLTemplate::XSI_IMAGE_FX  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_Float GetHue (  ) 

Returns the Hue value

Returns:
Hue

SI_Void SetHue ( SI_Float  in_fValue  ) 

Sets the Hue value

Parameters:
[in]  in_fValue  new Hue value

SI_Float GetGain (  ) 

Returns the Gain value

Returns:
Gain

SI_Void SetGain ( SI_Float  in_fValue  ) 

Sets the Gain value

Parameters:
[in]  in_fValue  new Gain value

SI_Float GetSaturation (  ) 

Returns the Saturation value

Returns:
Saturation

SI_Void SetSaturation ( SI_Float  in_fValue  ) 

Sets the Saturation value

Parameters:
[in]  in_fValue  new Saturation value

SI_Float GetBrightness (  ) 

Returns the Brightness value

Returns:
Brightness

SI_Void SetBrightness ( SI_Float  in_fValue  ) 

Sets the Brightness value

Parameters:
[in]  in_fValue  new Brightness value

SI_Float GetBlurRadius (  ) 

Returns the Blur radius value

Returns:
Blur radius

SI_Void SetBlurRadius ( SI_Float  in_fValue  ) 

Sets the Blur radius value

Parameters:
[in]  in_fValue  new Blur radius value

SI_Float GetBlurAmount (  ) 

Returns the Blur amount value

Returns:
Blur amount

SI_Void SetBlurAmount ( SI_Float  in_fValue  ) 

Sets the Blur amount value

Parameters:
[in]  in_fValue  new Blur amount value

SI_Bool GetBlurAlpha (  ) 

Returns the Blur alpha value

Returns:
Blur alpha

SI_Void SetBlurAlpha ( SI_Bool  in_bValue  ) 

Sets the Blur Alpha value

Parameters:
[in]  in_bValue  new Blur Alpha value

EScalingType GetScalingType (  ) 

Returns the scaling type

Returns:
scaling type

SI_Void SetScalingType ( EScalingType  in_Type  ) 

Sets the Scaling type value

Parameters:
[in]  in_Type  the new scaling type

SI_Float GetHorizontalScale (  ) 

Returns the horizontal scale value

Returns:
horizontal scale

SI_Void SetHorizontalScale ( SI_Float  in_fValue  ) 

Sets the horizontal scale value

Parameters:
[in]  in_fValue  horizontal scale

SI_Float GetVerticalScale (  ) 

Returns the vertical scale value

Returns:
vertical scale

SI_Void SetVerticalScale ( SI_Float  in_fValue  ) 

Sets the vertical scale value

Parameters:
[in]  in_fValue  vertical scale

SI_Bool GetFlipHorizontal (  ) 

Returns a value indicating wether the image is horizontally flipped

Returns:
Horizontal flip value

SI_Void SetFlipHorizontal ( SI_Bool  in_bValue  ) 

Sets a value indicating wether the image is horizontally flipped

Parameters:
[in]  in_bValue  Horizontal flip value

SI_Bool GetFlipVertical (  ) 

Returns a value indicating wether the image is vertically flipped

Returns:
Vertical flip value

SI_Void SetFlipVertical ( SI_Bool  in_bValue  ) 

Sets a value indicating wether the image is vertically flipped

Parameters:
[in]  in_bValue  Vertical flip value

SI_Bool GetRGBA2Greyscale (  ) 

Returns a value indicating wether the image is converted to grayscale

Returns:
converted to grayscale

SI_Void SetRGBA2Greyscale ( SI_Bool  in_bValue  ) 

Sets a value indicating wether the image is converted to grayscale

Parameters:
[in]  in_bValue  converted to grayscale

SI_Bool GetConvertTo16Bits (  ) 

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

Returns:
converted to 16bit

SI_Void SetConvertTo16Bits ( SI_Bool  in_bValue  ) 

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

Parameters:
[in]  in_bValue  converted to 16bit

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