CSLTexture2D Class Reference

#include <Texture2D.h>

Inheritance diagram for CSLTexture2D:

CSLTemplate CSIBCNode List of all members.

Public Types
enum   EMappingType
enum   EBlendingType

Public Member Functions
SI_Char *  GetImageFileName ()
SI_Void  SetImageFileName (SI_Char *in_szValue)
EMappingType  GetMappingType ()
SI_Void  SetMappingType (EMappingType in_Type)
SI_Int  GetImageWidth ()
SI_Void  SetImageWidth (SI_Int in_nValue)
SI_Int  GetImageHeight ()
SI_Void  SetImageHeight (SI_Int in_nValue)
SI_Int  GetCropUMin ()
SI_Void  SetCropUMin (SI_Int in_nValue)
SI_Int  GetCropUMax ()
SI_Void  SetCropUMax (SI_Int in_nValue)
SI_Int  GetCropVMin ()
SI_Void  SetCropVMin (SI_Int in_nValue)
SI_Int  GetCropVMax ()
SI_Void  SetCropVMax (SI_Int in_nValue)
SI_Bool  GetUVSwapFlag ()
SI_Void  SetUVSwapFlag (SI_Bool in_bState)
SI_Int  GetURepeat ()
SI_Void  SetURepeat (SI_Int in_nValue)
SI_Int  GetVRepeat ()
SI_Void  SetVRepeat (SI_Int in_nValue)
SI_Bool  GetUAlternate ()
SI_Void  SetUAlternate (SI_Bool in_bState)
SI_Bool  GetVAlternate ()
SI_Void  SetVAlternate (SI_Bool in_bState)
SI_Float  GetUScale ()
SI_Void  SetUScale (SI_Float in_fValue)
SI_Float  GetVScale ()
SI_Void  SetVScale (SI_Float in_fValue)
SI_Float  GetUOffset ()
SI_Void  SetUOffset (SI_Float in_fValue)
SI_Float  GetVOffset ()
SI_Void  SetVOffset (SI_Float in_fValue)
CSIBCMatrix4x4  GetProjectionMatrix ()
SI_Void  SetProjectionMatrix (CSIBCMatrix4x4 &in_Value)
EBlendingType  GetBlendingType ()
SI_Void  SetBlendingType (EBlendingType in_Type)
SI_Float  GetBlending ()
SI_Void  SetBlending (SI_Float in_fValue)
SI_Float  GetAmbient ()
SI_Void  SetAmbient (SI_Float in_fValue)
SI_Float  GetDiffuse ()
SI_Void  SetDiffuse (SI_Float in_fValue)
SI_Float  GetSpecular ()
SI_Void  SetSpecular (SI_Float in_fValue)
SI_Float  GetTransparency ()
SI_Void  SetTransparency (SI_Float in_fValue)
SI_Float  GetReflectivity ()
SI_Void  SetReflectivity (SI_Float in_fValue)
SI_Float  GetRoughness ()
SI_Void  SetRoughness (SI_Float in_fValue)
virtual ETemplateType  Type ()

Detailed Description

Describes a 2D texture (see the SI_Texture2D template reference).

Member Enumeration Documentation

enum EMappingType

This enum lists all mapping type supported by the texture 2D.

enum EBlendingType

This enum lists all blending type supported by the texture 2D.

Member Function Documentation

SI_Char* GetImageFileName (  )  [inline]

Return the name of the texture's image file.

Returns:
SI_Char* Image file name.

SI_Void SetImageFileName ( SI_Char *  in_szValue  )  [inline]

Change the name of the texture's image file.

Parameters:
SI_Char*  New image file name.
Returns:
None

EMappingType GetMappingType (  )  [inline]

Return the mapping type of the texture.

Returns:
EMappingType Mapping type.

SI_Void SetMappingType ( EMappingType  in_Type  )  [inline]

Change the mapping type of the texture.

Parameters:
EMappingType  New mapping type.
Returns:
None

SI_Int GetImageWidth (  )  [inline]

Return the width in pixel of the image.

Returns:
SI_Int Image width.

SI_Void SetImageWidth ( SI_Int  in_nValue  )  [inline]

Change the width of the image.

Parameters:
SI_Int  New image width.
Returns:
None

SI_Int GetImageHeight (  )  [inline]

Return the height in pixel of the image.

Returns:
SI_Int Image height.

SI_Void SetImageHeight ( SI_Int  in_nValue  )  [inline]

Change the height of the image.

Parameters:
SI_Int  New image height.
Returns:
None

SI_Int GetCropUMin (  )  [inline]

Return the start of the cropping region in V.

Returns:
SI_Int Start of the cropping region in V.

SI_Void SetCropUMin ( SI_Int  in_nValue  )  [inline]

Change the start of the cropping region in V.

Parameters:
SI_Int  New start of the cropping region in V.
Returns:
None

SI_Int GetCropUMax (  )  [inline]

Return the end of the cropping region in V.

Returns:
SI_Int End of the cropping region in V.

SI_Void SetCropUMax ( SI_Int  in_nValue  )  [inline]

Change the end of the cropping region in V.

Parameters:
SI_Int  New end of the cropping region in V.
Returns:
None

SI_Int GetCropVMin (  )  [inline]

Return the start of the cropping region in V.

Returns:
SI_Int Start of the cropping region in V.

SI_Void SetCropVMin ( SI_Int  in_nValue  )  [inline]

Change the start of the cropping region in V.

Parameters:
SI_Int  New start of the cropping region in V.
Returns:
None

SI_Int GetCropVMax (  )  [inline]

Return the end of the cropping region in V.

Returns:
SI_Int End of the cropping region in V.

SI_Void SetCropVMax ( SI_Int  in_nValue  )  [inline]

Change the end of the cropping region in V.

Parameters:
SI_Int  New end of the cropping region in V.
Returns:
None

SI_Bool GetUVSwapFlag (  )  [inline]

Indicates if the U and V orientations are swapped.

Returns:
SI_Bool UV swap state.

SI_Void SetUVSwapFlag ( SI_Bool  in_bState  )  [inline]

Change the U and V orientations swapping state.

Parameters:
SI_Bool  New UV swap state.
Returns:
None

SI_Int GetURepeat (  )  [inline]

Return the number of horizontal repetitions of the image.

Returns:
SI_Int Number of horizontal repetitions.

SI_Void SetURepeat ( SI_Int  in_nValue  )  [inline]

Change the number of horizontal repetitions of the image.

Parameters:
SI_Int  New number of horizontal repetitions.
Returns:
None

SI_Int GetVRepeat (  )  [inline]

Return the number of vertical repetitions of the image.

Returns:
SI_Int Number of vertical repetitions.

SI_Void SetVRepeat ( SI_Int  in_nValue  )  [inline]

Change the number of vertical repetitions of the image.

Parameters:
SI_Int  New number of vertical repetitions.
Returns:
None

SI_Bool GetUAlternate (  )  [inline]

Return the flag that indicates if the texture is mirrored horizontally.

Returns:
SI_Bool U alternate state.

SI_Void SetUAlternate ( SI_Bool  in_bState  )  [inline]

Change the flag that indicates if the texture is mirrored horizontally.

Parameters:
SI_Bool  New U alternate state.
Returns:
None

SI_Bool GetVAlternate (  )  [inline]

Return the flag that indicates if the texture is mirrored horizontally.

Returns:
SI_Bool V alternate state.

SI_Void SetVAlternate ( SI_Bool  in_bState  )  [inline]

Change the flag that indicates if the texture is mirrored horizontally.

Parameters:
SI_Bool  New V alternate state.
Returns:
None

SI_Float GetUScale (  )  [inline]

Return the scaling of image in U.

Returns:
SI_Float Scaling of image in U.

SI_Void SetUScale ( SI_Float  in_fValue  )  [inline]

Change the scaling of image in U.

Parameters:
SI_Float  New scaling of image in U.
Returns:
None

SI_Float GetVScale (  )  [inline]

Return the scaling of image in V.

Returns:
SI_Float Scaling of image in V.

SI_Void SetVScale ( SI_Float  in_fValue  )  [inline]

Change the scaling of image in V.

Parameters:
SI_Float  New scaling of image in V.
Returns:
None

SI_Float GetUOffset (  )  [inline]

Return the offset of image in U.

Returns:
SI_Float Offset of image in U.

SI_Void SetUOffset ( SI_Float  in_fValue  )  [inline]

Change the offset of image in U.

Parameters:
SI_Float  New offset of image in U.
Returns:
None

SI_Float GetVOffset (  )  [inline]

Return the offset of image in V.

Returns:
SI_Float Offset of image in V.

SI_Void SetVOffset ( SI_Float  in_fValue  )  [inline]

Change the offset of image in V.

Parameters:
SI_Float  New offset of image in V.
Returns:
None

CSIBCMatrix4x4 GetProjectionMatrix (  )  [inline]

Return the projection matrix of the texture.

Returns:
CSIBCMatrix4x4 projection matrix.

SI_Void SetProjectionMatrix ( CSIBCMatrix4x4 &  in_Value  )  [inline]

Change the projection matrix of the texture.

Parameters:
CSIBCMatrix4x4&  New projection matrix.
Returns:
None

EBlendingType GetBlendingType (  )  [inline]

Return the type of blending between texture and material attributes.

Returns:
EBlendingType Blending type.

SI_Void SetBlendingType ( EBlendingType  in_Type  )  [inline]

Change the type of blending between texture and material attributes.

Parameters:
EBlendingType  New blending type.
Returns:
None

SI_Float GetBlending (  )  [inline]

Return the normalized contribution of texture attributes (ambient, diffuse, specular, transparency, reflectivity).

Returns:
SI_Float Contribution of texture attributes.

SI_Void SetBlending ( SI_Float  in_fValue  )  [inline]

Change the normalized contribution of texture attributes.

Parameters:
SI_Float  New contribution of texture attributes.
Returns:
None

SI_Float GetAmbient (  )  [inline]

Return the normalized contribution of texture pixel colors to the material ambient color.

Returns:
SI_Float Contribution of texture.

SI_Void SetAmbient ( SI_Float  in_fValue  )  [inline]

Change the normalized contribution of texture pixel colors to the material ambient color.

Parameters:
SI_Float  New contribution of texture.
Returns:
None

SI_Float GetDiffuse (  )  [inline]

Return the normalized contribution of texture pixel colors to the material diffuse color.

Returns:
SI_Float Contribution of texture.

SI_Void SetDiffuse ( SI_Float  in_fValue  )  [inline]

Change the normalized contribution of texture pixel colors to the material diffuse color.

Parameters:
SI_Float  New contribution of texture.
Returns:
None

SI_Float GetSpecular (  )  [inline]

Return the normalized contribution of texture pixel colors to the material specular color.

Returns:
SI_Float Contribution of texture.

SI_Void SetSpecular ( SI_Float  in_fValue  )  [inline]

Change the normalized contribution of texture pixel colors to the material specular color.

Parameters:
SI_Float  New contribution of texture.
Returns:
None

SI_Float GetTransparency (  )  [inline]

Return the normalized contribution of texture pixel colors to the material transparency level.

Returns:
SI_Float Contribution of texture.

SI_Void SetTransparency ( SI_Float  in_fValue  )  [inline]

Change the normalized contribution of texture pixel colors to the material transparency level.

Parameters:
SI_Float  New contribution of texture.
Returns:
None

SI_Float GetReflectivity (  )  [inline]

Return the normalized contribution of texture pixel colors to the material reflectivity level.

Returns:
SI_Float Contribution of texture.

SI_Void SetReflectivity ( SI_Float  in_fValue  )  [inline]

Change the normalized contribution of texture pixel colors to the material reflectivity level.

Parameters:
SI_Float  New contribution of texture.
Returns:
None

SI_Float GetRoughness (  )  [inline]

Return the bump mapping intensity and/or displacement of geometry along surface normals.

Returns:
SI_Float Bump mapping intensity.

SI_Void SetRoughness ( SI_Float  in_fValue  )  [inline]

Change the bump mapping intensity.

Parameters:
SI_Float  New bump mapping intensity.
Returns:
None

virtual ETemplateType Type (  )  [inline, virtual]

Indicate which dotXSI template this object describes.

Returns:
ETemplateType Type of template

Implements CSLTemplate.

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