CSLTexture2D Class Reference

This class represents an SI_Texture2D template. More...

#include <Texture2D.h>

Inheritance diagram for CSLTexture2D:

CSLTemplate CSIBCNode List of all members.

Public Types
enum   EMappingType {
  SI_XY_PROJECTION,
  SI_XZ_PROJECTION,
  SI_YZ_PROJECTION,
  SI_UV_MAP,
  SI_UV_MAP_WRAPPED,
  SI_CYLINDRICAL_PROJECTION,
  SI_SPHERICAL_PROJECTION,
  SI_REFLECTION_MAP
}
enum   EBlendingType {
  SI_ALPHA_MASK,
  SI_INTENSITY_MASK,
  SI_NO_MASK,
  SI_RGB_MODULATION
}

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

This class represents an SI_Texture2D template.

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.

Enumerator:
SI_XY_PROJECTION  XY Projection
SI_XZ_PROJECTION  XZ Projection
SI_YZ_PROJECTION  YZ Projection
SI_UV_MAP  UV Map
SI_UV_MAP_WRAPPED  UV Map Wrapped
SI_CYLINDRICAL_PROJECTION  Cylindrical Projection
SI_SPHERICAL_PROJECTION  Spherical Projection
SI_REFLECTION_MAP  Reflection Map

enum EBlendingType

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

Enumerator:
SI_ALPHA_MASK  Alpha Mask
SI_INTENSITY_MASK  Intensity Mask
SI_NO_MASK  No Mask
SI_RGB_MODULATION  RGB Modulation

Member Function Documentation

SI_Char* GetImageFileName (  )  [inline]

Returns the name of the texture's image file.

Returns:
Image file name.

SI_Void SetImageFileName ( SI_Char *  in_szValue  )  [inline]

Changes the name of the texture's image file.

Parameters:
[in]  in_szValue  New image file name.

EMappingType GetMappingType (  )  [inline]

Returns the mapping type of the texture.

Returns:
Mapping type.

SI_Void SetMappingType ( EMappingType  in_Type  )  [inline]

Changes the mapping type of the texture.

Parameters:
[in]  in_Type  New mapping type.

SI_Int GetImageWidth (  )  [inline]

Returns the width in pixel of the image.

Returns:
Image width.

SI_Void SetImageWidth ( SI_Int  in_nValue  )  [inline]

Changes the width of the image.

Parameters:
[in]  in_nValue  New image width.

SI_Int GetImageHeight (  )  [inline]

Returns the height in pixel of the image.

Returns:
Image height.

SI_Void SetImageHeight ( SI_Int  in_nValue  )  [inline]

Changes the height of the image.

Parameters:
[in]  in_nValue  New image height.

SI_Int GetCropUMin (  )  [inline]

Returns the start of the cropping region in V.

Returns:
Start of the cropping region in V.

SI_Void SetCropUMin ( SI_Int  in_nValue  )  [inline]

Changes the start of the cropping region in V.

Parameters:
[in]  in_nValue  New start of the cropping region in V.

SI_Int GetCropUMax (  )  [inline]

Returns the end of the cropping region in V.

Returns:
End of the cropping region in V.

SI_Void SetCropUMax ( SI_Int  in_nValue  )  [inline]

Changes the end of the cropping region in V.

Parameters:
[in]  in_nValue  New end of the cropping region in V.

SI_Int GetCropVMin (  )  [inline]

Returns the start of the cropping region in V.

Returns:
Start of the cropping region in V.

SI_Void SetCropVMin ( SI_Int  in_nValue  )  [inline]

Changes the start of the cropping region in V.

Parameters:
[in]  in_nValue  New start of the cropping region in V.

SI_Int GetCropVMax (  )  [inline]

Returns the end of the cropping region in V.

Returns:
End of the cropping region in V.

SI_Void SetCropVMax ( SI_Int  in_nValue  )  [inline]

Changes the end of the cropping region in V.

Parameters:
[in]  in_nValue  New end of the cropping region in V.

SI_Bool GetUVSwapFlag (  )  [inline]

Indicates if the U and V orientations are swapped.

Returns:
UV swap state.

SI_Void SetUVSwapFlag ( SI_Bool  in_bState  )  [inline]

Changes the U and V orientations swapping state.

Parameters:
[in]  in_bState  New UV swap state.

SI_Int GetURepeat (  )  [inline]

Returns the number of horizontal repetitions of the image.

Returns:
Number of horizontal repetitions.

SI_Void SetURepeat ( SI_Int  in_nValue  )  [inline]

Changes the number of horizontal repetitions of the image.

Parameters:
[in]  in_nValue  New number of horizontal repetitions.

SI_Int GetVRepeat (  )  [inline]

Returns the number of vertical repetitions of the image.

Returns:
Number of vertical repetitions.

SI_Void SetVRepeat ( SI_Int  in_nValue  )  [inline]

Changes the number of vertical repetitions of the image.

Parameters:
[in]  in_nValue  New number of vertical repetitions.

SI_Bool GetUAlternate (  )  [inline]

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

Returns:
U alternate state.

SI_Void SetUAlternate ( SI_Bool  in_bState  )  [inline]

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

Parameters:
[in]  in_bState  New U alternate state.

SI_Bool GetVAlternate (  )  [inline]

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

Returns:
V alternate state.

SI_Void SetVAlternate ( SI_Bool  in_bState  )  [inline]

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

Parameters:
[in]  in_bState  New V alternate state.

SI_Float GetUScale (  )  [inline]

Returns the scaling of image in U.

Returns:
Scaling of image in U.

SI_Void SetUScale ( SI_Float  in_fValue  )  [inline]

Changes the scaling of image in U.

Parameters:
[in]  in_fValue  New scaling of image in U.

SI_Float GetVScale (  )  [inline]

Returns the scaling of image in V.

Returns:
Scaling of image in V.

SI_Void SetVScale ( SI_Float  in_fValue  )  [inline]

Changes the scaling of image in V.

Parameters:
[in]  in_fValue  New scaling of image in V.

SI_Float GetUOffset (  )  [inline]

Returns the offset of image in U.

Returns:
Offset of image in U.

SI_Void SetUOffset ( SI_Float  in_fValue  )  [inline]

Changes the offset of image in U.

Parameters:
[in]  in_fValue  New offset of image in U.

SI_Float GetVOffset (  )  [inline]

Returns the offset of image in V.

Returns:
Offset of image in V.

SI_Void SetVOffset ( SI_Float  in_fValue  )  [inline]

Changes the offset of image in V.

Parameters:
[in]  in_fValue  New offset of image in V.

CSIBCMatrix4x4 GetProjectionMatrix (  )  [inline]

Returns the projection matrix of the texture.

Returns:
projection matrix.

SI_Void SetProjectionMatrix ( CSIBCMatrix4x4 &  in_Value  )  [inline]

Changes the projection matrix of the texture.

Parameters:
[in]  in_Value  New projection matrix.

EBlendingType GetBlendingType (  )  [inline]

Returns the type of blending between texture and material attributes.

Returns:
Blending type.

SI_Void SetBlendingType ( EBlendingType  in_Type  )  [inline]

Changes the type of blending between texture and material attributes.

Parameters:
[in]  in_Type  New blending type.

SI_Float GetBlending (  )  [inline]

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

Returns:
Contribution of texture attributes.

SI_Void SetBlending ( SI_Float  in_fValue  )  [inline]

Changes the normalized contribution of texture attributes.

Parameters:
[in]  in_fValue  New contribution of texture attributes.

SI_Float GetAmbient (  )  [inline]

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

Returns:
Contribution of texture.

SI_Void SetAmbient ( SI_Float  in_fValue  )  [inline]

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

Parameters:
[in]  in_fValue  New contribution of texture.

SI_Float GetDiffuse (  )  [inline]

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

Returns:
Contribution of texture.

SI_Void SetDiffuse ( SI_Float  in_fValue  )  [inline]

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

Parameters:
[in]  in_fValue  New contribution of texture.

SI_Float GetSpecular (  )  [inline]

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

Returns:
Contribution of texture.

SI_Void SetSpecular ( SI_Float  in_fValue  )  [inline]

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

Parameters:
[in]  in_fValue  New contribution of texture.

SI_Float GetTransparency (  )  [inline]

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

Returns:
Contribution of texture.

SI_Void SetTransparency ( SI_Float  in_fValue  )  [inline]

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

Parameters:
[in]  in_fValue  New contribution of texture.

SI_Float GetReflectivity (  )  [inline]

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

Returns:
Contribution of texture.

SI_Void SetReflectivity ( SI_Float  in_fValue  )  [inline]

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

Parameters:
[in]  in_fValue  New contribution of texture.

SI_Float GetRoughness (  )  [inline]

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

Returns:
Bump mapping intensity.

SI_Void SetRoughness ( SI_Float  in_fValue  )  [inline]

Changes the bump mapping intensity.

Parameters:
[in]  in_fValue  New bump mapping intensity.

virtual ETemplateType Type (  )  [inline, virtual]

Returns the type of this template

Return values:
CSLTemplate::SI_TEXTURE_2D  Template type

Implements CSLTemplate.

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