Open CASCADE Technology  7.4.1.dev
Public Member Functions
Graphic3d_TextureParams Class Reference

This class describes texture parameters. More...

#include <Graphic3d_TextureParams.hxx>

Inheritance diagram for Graphic3d_TextureParams:
Inheritance graph
[legend]

Public Member Functions

 Graphic3d_TextureParams ()
 Default constructor. More...
 
virtual ~Graphic3d_TextureParams ()
 Destructor. More...
 
Graphic3d_TextureUnit TextureUnit () const
 Default texture unit to be used, default is Graphic3d_TextureUnit_BaseColor. More...
 
void SetTextureUnit (Graphic3d_TextureUnit theUnit)
 Setup default texture unit. More...
 
Standard_Boolean IsModulate () const
 
void SetModulate (const Standard_Boolean theToModulate)
 
Standard_Boolean IsRepeat () const
 
void SetRepeat (const Standard_Boolean theToRepeat)
 
Graphic3d_TypeOfTextureFilter Filter () const
 
void SetFilter (const Graphic3d_TypeOfTextureFilter theFilter)
 
Graphic3d_LevelOfTextureAnisotropy AnisoFilter () const
 
void SetAnisoFilter (const Graphic3d_LevelOfTextureAnisotropy theLevel)
 
Standard_ShortReal Rotation () const
 Return rotation angle in degrees; 0 by default. Complete transformation matrix: Rotation -> Translation -> Scale. More...
 
void SetRotation (const Standard_ShortReal theAngleDegrees)
 
const Graphic3d_Vec2Scale () const
 Return scale factor; (1.0; 1.0) by default, which means no scaling. Complete transformation matrix: Rotation -> Translation -> Scale. More...
 
void SetScale (const Graphic3d_Vec2 theScale)
 
const Graphic3d_Vec2Translation () const
 Return translation vector; (0.0; 0.0), which means no translation. Complete transformation matrix: Rotation -> Translation -> Scale. More...
 
void SetTranslation (const Graphic3d_Vec2 theVec)
 
Graphic3d_TypeOfTextureMode GenMode () const
 
const Graphic3d_Vec4GenPlaneS () const
 
const Graphic3d_Vec4GenPlaneT () const
 
void SetGenMode (const Graphic3d_TypeOfTextureMode theMode, const Graphic3d_Vec4 thePlaneS, const Graphic3d_Vec4 thePlaneT)
 Setup texture coordinates generation mode. More...
 
Standard_Integer BaseLevel () const
 
Standard_Integer MaxLevel () const
 Return maximum texture mipmap array level; 1000 by default. Real rendering limit will take into account mipmap generation flags and presence of mipmaps in loaded image. More...
 
void SetLevelsRange (Standard_Integer theFirstLevel, Standard_Integer theSecondLevel=0)
 Setups texture mipmap array levels range. The lowest value will be the base level. The remaining one will be the maximum level. More...
 
unsigned int SamplerRevision () const
 Return modification counter of parameters related to sampler state. More...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual void Delete () const
 Memory deallocator for transient classes. More...
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object. More...
 
Standard_Boolean IsInstance (const opencascade::handle< Standard_Type > &theType) const
 Returns a true value if this is an instance of Type. More...
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName. More...
 
Standard_Boolean IsKind (const opencascade::handle< Standard_Type > &theType) const
 Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...
 
Standard_Boolean IsKind (const Standard_CString theTypeName) const
 Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...
 
Standard_TransientThis () const
 Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 
void IncrementRefCounter () const
 Increments the reference counter of this object. More...
 
Standard_Integer DecrementRefCounter () const
 Decrements the reference counter of this object; returns the decremented value. More...
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 
- Static Public Member Functions inherited from Standard_Transient
static const char * get_type_name ()
 Returns a type descriptor about this object. More...
 
static const opencascade::handle< Standard_Type > & get_type_descriptor ()
 Returns type descriptor of Standard_Transient class. More...
 

Detailed Description

This class describes texture parameters.

Constructor & Destructor Documentation

◆ Graphic3d_TextureParams()

Graphic3d_TextureParams::Graphic3d_TextureParams ( )

Default constructor.

◆ ~Graphic3d_TextureParams()

virtual Graphic3d_TextureParams::~Graphic3d_TextureParams ( )
virtual

Destructor.

Member Function Documentation

◆ AnisoFilter()

Graphic3d_LevelOfTextureAnisotropy Graphic3d_TextureParams::AnisoFilter ( ) const
inline
Returns
level of anisontropy texture filter. Default value is Graphic3d_LOTA_OFF.

◆ BaseLevel()

Standard_Integer Graphic3d_TextureParams::BaseLevel ( ) const
inline
Returns
base texture mipmap level; 0 by default.

◆ Filter()

Graphic3d_TypeOfTextureFilter Graphic3d_TextureParams::Filter ( ) const
inline
Returns
texture interpolation filter. Default value is Graphic3d_TOTF_NEAREST.

◆ GenMode()

Graphic3d_TypeOfTextureMode Graphic3d_TextureParams::GenMode ( ) const
inline
Returns
texture coordinates generation mode. Default value is Graphic3d_TOTM_MANUAL.

◆ GenPlaneS()

const Graphic3d_Vec4& Graphic3d_TextureParams::GenPlaneS ( ) const
inline
Returns
texture coordinates generation plane S.

◆ GenPlaneT()

const Graphic3d_Vec4& Graphic3d_TextureParams::GenPlaneT ( ) const
inline
Returns
texture coordinates generation plane T.

◆ IsModulate()

Standard_Boolean Graphic3d_TextureParams::IsModulate ( ) const
inline
Returns
TRUE if the texture is modulate. Default value is FALSE.

◆ IsRepeat()

Standard_Boolean Graphic3d_TextureParams::IsRepeat ( ) const
inline
Returns
TRUE if the texture repeat is enabled. Default value is FALSE.

◆ MaxLevel()

Standard_Integer Graphic3d_TextureParams::MaxLevel ( ) const
inline

Return maximum texture mipmap array level; 1000 by default. Real rendering limit will take into account mipmap generation flags and presence of mipmaps in loaded image.

◆ Rotation()

Standard_ShortReal Graphic3d_TextureParams::Rotation ( ) const
inline

Return rotation angle in degrees; 0 by default. Complete transformation matrix: Rotation -> Translation -> Scale.

◆ SamplerRevision()

unsigned int Graphic3d_TextureParams::SamplerRevision ( ) const
inline

Return modification counter of parameters related to sampler state.

◆ Scale()

const Graphic3d_Vec2& Graphic3d_TextureParams::Scale ( ) const
inline

Return scale factor; (1.0; 1.0) by default, which means no scaling. Complete transformation matrix: Rotation -> Translation -> Scale.

◆ SetAnisoFilter()

void Graphic3d_TextureParams::SetAnisoFilter ( const Graphic3d_LevelOfTextureAnisotropy  theLevel)
Parameters
theLevellevel of anisontropy texture filter.

◆ SetFilter()

void Graphic3d_TextureParams::SetFilter ( const Graphic3d_TypeOfTextureFilter  theFilter)
Parameters
theFiltertexture interpolation filter.

◆ SetGenMode()

void Graphic3d_TextureParams::SetGenMode ( const Graphic3d_TypeOfTextureMode  theMode,
const Graphic3d_Vec4  thePlaneS,
const Graphic3d_Vec4  thePlaneT 
)

Setup texture coordinates generation mode.

◆ SetLevelsRange()

void Graphic3d_TextureParams::SetLevelsRange ( Standard_Integer  theFirstLevel,
Standard_Integer  theSecondLevel = 0 
)
inline

Setups texture mipmap array levels range. The lowest value will be the base level. The remaining one will be the maximum level.

◆ SetModulate()

void Graphic3d_TextureParams::SetModulate ( const Standard_Boolean  theToModulate)
Parameters
theToModulateturn modulation on/off.

◆ SetRepeat()

void Graphic3d_TextureParams::SetRepeat ( const Standard_Boolean  theToRepeat)
Parameters
theToRepeatturn texture repeat mode ON or OFF (clamping).

◆ SetRotation()

void Graphic3d_TextureParams::SetRotation ( const Standard_ShortReal  theAngleDegrees)
Parameters
theAngleDegreesrotation angle.

◆ SetScale()

void Graphic3d_TextureParams::SetScale ( const Graphic3d_Vec2  theScale)
Parameters
theScalescale factor.

◆ SetTextureUnit()

void Graphic3d_TextureParams::SetTextureUnit ( Graphic3d_TextureUnit  theUnit)
inline

Setup default texture unit.

◆ SetTranslation()

void Graphic3d_TextureParams::SetTranslation ( const Graphic3d_Vec2  theVec)
Parameters
theVectranslation vector.

◆ TextureUnit()

Graphic3d_TextureUnit Graphic3d_TextureParams::TextureUnit ( ) const
inline

Default texture unit to be used, default is Graphic3d_TextureUnit_BaseColor.

◆ Translation()

const Graphic3d_Vec2& Graphic3d_TextureParams::Translation ( ) const
inline

Return translation vector; (0.0; 0.0), which means no translation. Complete transformation matrix: Rotation -> Translation -> Scale.


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