CSLImageFX2 Class Reference

This class represents an XSI_ImageFX2 template. More...

#include <XSIImageFX2.h>

Inheritance diagram for CSLImageFX2:

CSLTemplate CSIBCNode List of all members.

Public Types
enum   EImageDefinitionType {
  SI_LOAD_IN_MEMORY,
  SI_USE_FROM_DISK,
  SI_BROADCAST
}
  Defines the various scaling types. More...
enum   EOglFilter {
  SI_UNINTERPOLATED_PIXEL = 9728,
  SI_INTERPOLATED_PIXEL = 9729,
  SI_UNINTERPOLATED_PIXEL_NEAREST_MIPMAP = 9984,
  SI_INTERPOLATED_PIXEL_NEAREST_MIPMAP = 9985,
  SI_UNINTERPOLATED_PIXEL_INTERPOLATED_MIPMAP = 9986,
  SI_INTERPOLATED_PIXEL_INTERPOLATED_MIPMAP = 9987
}
enum   EFieldType
  Specifies the field order for video images clips.

Public Member Functions
  CSLImageFX2 (CSLScene *in_pScene, CSLModel *in_pModel, CdotXSITemplate *in_pTemplate)
virtual  ~CSLImageFX2 ()
  Destructor.
ETemplateType  Type ()
virtual CSLAnimatableType *  ParameterFromName (SI_Char *in_szName)
virtual CSLAnimatableType *  ParameterFromType (EFCurveType in_Type, SI_Char *in_szParameterName)
SI_Float  GetExposure ()
SI_Void  SetExposure (SI_Float in_fValue)
SI_Float  GetDisplayGamma ()
SI_Void  SetDisplayGamma (SI_Float in_fValue)
SI_Bool  GetDisplayGammaAffectsRendering ()
SI_Void  SetDisplayGammaAffectsRendering (SI_Bool in_bValue)
SI_Char *  GetRenderColorProfile ()
SI_Void  SetRenderColorProfile (SI_Char *in_pValue)
SI_Float  GetRenderGamma ()
SI_Void  SetRenderGamma (SI_Float in_fValue)
EImageDefinitionType  GetImageDefinitionType ()
SI_Void  SetImageDefinitionType (EImageDefinitionType in_Value)
SI_Bool  GetEnableMipMap ()
SI_Void  SetEnableMipMap (SI_Bool in_bValue)
SI_Float  GetMipMapScale ()
SI_Void  SetMipMapScale (SI_Float in_fValue)
SI_Int  GetOglMaxSize ()
SI_Void  SetOglMaxSize (SI_Int in_nValue)
SI_Bool  GetOglMipMap ()
SI_Void  SetOglMipMap (SI_Bool in_Value)
EOglFilter  GetOglMinFilter ()
SI_Void  SetOglMinFilter (EOglFilter in_Value)
EOglFilter  GetOglMagFilter ()
SI_Void  SetOglMagFilter (EOglFilter in_Value)
EFieldType  GetFieldType ()
SI_Void  SetFieldType (EFieldType in_Value)
SI_Int  GetSourceTrack ()
SI_Void  SetSourceTrack (SI_Int in_bValue)

Detailed Description

This class represents an XSI_ImageFX2 template.

Base class to define more image effects for dotXSI 5.0+ (see the XSI_ImageFX2 template reference).

Since:
dotXSI 6.0

Member Enumeration Documentation

enum EImageDefinitionType

Defines the various scaling types.

Enumerator:
SI_LOAD_IN_MEMORY  0-Load in memory
SI_USE_FROM_DISK  1-Use from disk
SI_BROADCAST  2-Broadcast

enum EOglFilter

Defines the kind of optimization that will be used to smooth textures that are far from or near to the camera (OGL MipMapping).

Enumerator:
SI_UNINTERPOLATED_PIXEL  Uninterpolated pixel (quickest but lowest-quality optimization)
SI_INTERPOLATED_PIXEL  Interpolated pixel (slowest but best-quality optimization for Texture Magnification Filter (Near)
SI_UNINTERPOLATED_PIXEL_NEAREST_MIPMAP  Uninterpolated pixel using Nearest MipMap resolution.
Note:
Only available for Texture Minification (Far)
SI_INTERPOLATED_PIXEL_NEAREST_MIPMAP  Interpolated pixel using Nearest MipMap resolution.
Note:
Only available for Texture Minification (Far)
SI_UNINTERPOLATED_PIXEL_INTERPOLATED_MIPMAP  Uninterpolated pixel using Interpolated MipMap resolution.
Note:
Only available for Texture Minification (Far)
SI_INTERPOLATED_PIXEL_INTERPOLATED_MIPMAP  Interpolated pixel using Interpolated MipMap resolution (slowest but best-quality optimization).
Note:
Only available for Texture Minification (Far)

Constructor & Destructor Documentation

CSLImageFX2 ( 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_FX2  The type of this template

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 GetExposure (  ) 

Returns the Exposure value

Returns:
Exposure

SI_Void SetExposure ( SI_Float  in_fValue  ) 

Sets the Exposure value

Parameters:
[in]  in_fValue  new Exposure value

SI_Float GetDisplayGamma (  ) 

Returns the DisplayGamma value

Returns:
DisplayGamma

SI_Void SetDisplayGamma ( SI_Float  in_fValue  ) 

Sets the DisplayGamma value

Parameters:
[in]  in_fValue  new DisplayGamma value

SI_Bool GetDisplayGammaAffectsRendering (  ) 

Returns the DisplayGammaAffectsRendering value

Returns:
DisplayGammaAffectsRendering

SI_Void SetDisplayGammaAffectsRendering ( SI_Bool  in_bValue  ) 

Sets the DisplayGammaAffectsRendering value

Parameters:
[in]  in_bValue  new DisplayGammaAffectsRendering value

SI_Char* GetRenderColorProfile (  ) 

Returns the RenderColorProfile value

Returns:
RenderColorProfile

SI_Void SetRenderColorProfile ( SI_Char *  in_pValue  ) 

Sets the RenderColorProfile value

Parameters:
[in]  in_pValue  new RenderColorProfile value

SI_Float GetRenderGamma (  ) 

Returns the RenderGamma value

Returns:
RenderGamma

SI_Void SetRenderGamma ( SI_Float  in_fValue  ) 

Sets the RenderGamma value

Parameters:
[in]  in_fValue  new RenderGamma value

EImageDefinitionType GetImageDefinitionType (  ) 

Returns the ImageDefinitionType value

Returns:
ImageDefinitionType

SI_Void SetImageDefinitionType ( EImageDefinitionType  in_Value  ) 

Sets the ImageDefinitionType value

Parameters:
[in]  in_Value  new ImageDefinitionType value

SI_Bool GetEnableMipMap (  ) 

Returns the EnableMipMap radius value

Returns:
EnableMipMap

SI_Void SetEnableMipMap ( SI_Bool  in_bValue  ) 

Sets the EnableMipMap radius value

Parameters:
[in]  in_bValue  new EnableMipMap value

SI_Float GetMipMapScale (  ) 

Returns the MipMapScale value

Returns:
MipMapScale

SI_Void SetMipMapScale ( SI_Float  in_fValue  ) 

Sets the MipMapScale value

Parameters:
[in]  in_fValue  new MipMapScale value

SI_Int GetOglMaxSize (  ) 

Returns the OglMaxSize value

Returns:
OglMaxSize

SI_Void SetOglMaxSize ( SI_Int  in_nValue  ) 

Sets the OglMaxSize value

Parameters:
[in]  in_nValue  new OglMaxSize value

SI_Bool GetOglMipMap (  ) 

Returns the OglMipMap

Returns:
OglMipMap

SI_Void SetOglMipMap ( SI_Bool  in_Value  ) 

Sets the OglMipMap value

Parameters:
[in]  in_Value  the new OglMipMap value

EOglFilter GetOglMinFilter (  ) 

Returns the OglMinFilter value

Returns:
OglMinFilter

SI_Void SetOglMinFilter ( EOglFilter  in_Value  ) 

Sets the OglMinFilter value

Parameters:
[in]  in_Value  OglMinFilter

EOglFilter GetOglMagFilter (  ) 

Returns the OglMagFilter value

Returns:
OglMagFilter value

SI_Void SetOglMagFilter ( EOglFilter  in_Value  ) 

Sets the OglMagFilter value

Parameters:
[in]  in_Value  OglMagFilter

EFieldType GetFieldType (  ) 

Returns the FieldType value

Returns:
FieldType value

SI_Void SetFieldType ( EFieldType  in_Value  ) 

Sets the FieldType value

Parameters:
[in]  in_Value  new FieldType value

SI_Int GetSourceTrack (  ) 

Returns the SourceTrack value

Returns:
SourceTrack value

SI_Void SetSourceTrack ( SI_Int  in_bValue  ) 

Sets the SourceTrack value

Parameters:
[in]  in_bValue  new SourceTrack value

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