Open CASCADE Technology  7.3.1.dev
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
Graphic3d_Texture2D Class Reference

This abstract class for managing 2D textures. More...

#include <Graphic3d_Texture2D.hxx>

Inheritance diagram for Graphic3d_Texture2D:
Inheritance graph
[legend]

Public Member Functions

Graphic3d_NameOfTexture2D Name () const
 Returns the name of the predefined textures or NOT_2D_UNKNOWN when the name is given as a filename. More...
 
void SetImage (const Handle< Image_PixMap > &thePixMap)
 Assign new image to the texture. Note that this method does not invalidate already uploaded resources - consider calling ::UpdateRevision() if needed. More...
 
Standard_Boolean HasMipMaps () const
 Return true if mip-maps should be used. More...
 
void SetMipMaps (const Standard_Boolean theToUse)
 Set if mip-maps should be used (generated if needed). Note that this method should be called before loading / using the texture. More...
 
- Public Member Functions inherited from Graphic3d_TextureMap
void EnableSmooth ()
 enable texture smoothing More...
 
Standard_Boolean IsSmoothed () const
 Returns TRUE if the texture is smoothed. More...
 
void DisableSmooth ()
 disable texture smoothing More...
 
void EnableModulate ()
 enable texture modulate mode. the image is modulate with the shading of the surface. More...
 
void DisableModulate ()
 disable texture modulate mode. the image is directly decal on the surface. More...
 
Standard_Boolean IsModulate () const
 Returns TRUE if the texture is modulate. More...
 
void EnableRepeat ()
 use this methods if you want to enable texture repetition on your objects. More...
 
void DisableRepeat ()
 use this methods if you want to disable texture repetition on your objects. More...
 
Standard_Boolean IsRepeat () const
 Returns TRUE if the texture repeat is enable. More...
 
Graphic3d_LevelOfTextureAnisotropy AnisoFilter () const
 
void SetAnisoFilter (const Graphic3d_LevelOfTextureAnisotropy theLevel)
 
- Public Member Functions inherited from Graphic3d_TextureRoot
 ~Graphic3d_TextureRoot ()
 Destructor. More...
 
virtual Standard_Boolean IsDone () const
 Checks if a texture class is valid or not. More...
 
const OSD_PathPath () const
 Returns the full path of the defined texture. It could be empty path if GetImage() is overridden to load image not from file. More...
 
Graphic3d_TypeOfTexture Type () const
 
const TCollection_AsciiStringGetId () const
 This ID will be used to manage resource in graphic driver. More...
 
Standard_Size Revision () const
 Return image revision. More...
 
void UpdateRevision ()
 Update image revision. Can be used for signaling changes in the texture source (e.g. file update, pixmap update) without re-creating texture source itself (since unique id should be never modified). More...
 
virtual Handle< Image_PixMapGetImage () const
 This method will be called by graphic driver each time when texture resource should be created. Default constructors allow defining the texture source as path to texture image or directly as pixmap. If the source is defined as path, then the image will be dynamically loaded when this method is called (and no copy will be preserved in this class instance). Inheritors may dynamically generate the image. Notice, image data should be in Bottom-Up order (see Image_PixMap::IsTopDown())! More...
 
const Handle< Graphic3d_TextureParams > & GetParams () const
 
- 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...
 

Static Public Member Functions

static Standard_Integer NumberOfTextures ()
 Returns the number of predefined textures. More...
 
static TCollection_AsciiString TextureName (const Standard_Integer theRank)
 Returns the name of the predefined texture of rank <aRank> More...
 
- Static Public Member Functions inherited from Graphic3d_TextureRoot
static TCollection_AsciiString TexturesFolder ()
 The path to textures determined from CSF_MDTVTexturesDirectory or CASROOT environment variables. 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...
 

Protected Member Functions

 Graphic3d_Texture2D (const TCollection_AsciiString &theFileName, const Graphic3d_TypeOfTexture theType)
 
 Graphic3d_Texture2D (const Graphic3d_NameOfTexture2D theName, const Graphic3d_TypeOfTexture theType)
 
 Graphic3d_Texture2D (const Handle< Image_PixMap > &thePixMap, const Graphic3d_TypeOfTexture theType)
 
- Protected Member Functions inherited from Graphic3d_TextureMap
 Graphic3d_TextureMap (const TCollection_AsciiString &theFileName, const Graphic3d_TypeOfTexture theType)
 
 Graphic3d_TextureMap (const Handle< Image_PixMap > &thePixMap, const Graphic3d_TypeOfTexture theType)
 
- Protected Member Functions inherited from Graphic3d_TextureRoot
 Graphic3d_TextureRoot (const TCollection_AsciiString &theFileName, const Graphic3d_TypeOfTexture theType)
 Creates a texture from a file Warning: Note that if <FileName> is NULL the texture must be realized using LoadTexture(image) method. More...
 
 Graphic3d_TextureRoot (const Handle< Image_PixMap > &thePixmap, const Graphic3d_TypeOfTexture theType)
 Creates a texture from pixmap. Please note that the implementation expects the image data to be in Bottom-Up order (see Image_PixMap::IsTopDown()). More...
 
void generateId ()
 Unconditionally generate new texture id. Should be called only within constructor. More...
 

Protected Attributes

Graphic3d_NameOfTexture2D myName
 
- Protected Attributes inherited from Graphic3d_TextureRoot
Handle< Graphic3d_TextureParamsmyParams
 associated texture parameters More...
 
TCollection_AsciiString myTexId
 unique identifier of this resource (for sharing graphic resource); should never be modified outside constructor More...
 
Handle< Image_PixMapmyPixMap
 image pixmap - as one of the ways for defining the texture source More...
 
OSD_Path myPath
 image file path - as one of the ways for defining the texture source More...
 
Standard_Size myRevision
 image revision - for signaling changes in the texture source (e.g. file update, pixmap update) More...
 
Graphic3d_TypeOfTexture myType
 texture type More...
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 

Detailed Description

This abstract class for managing 2D textures.

Constructor & Destructor Documentation

◆ Graphic3d_Texture2D() [1/3]

Graphic3d_Texture2D::Graphic3d_Texture2D ( const TCollection_AsciiString theFileName,
const Graphic3d_TypeOfTexture  theType 
)
protected

◆ Graphic3d_Texture2D() [2/3]

Graphic3d_Texture2D::Graphic3d_Texture2D ( const Graphic3d_NameOfTexture2D  theName,
const Graphic3d_TypeOfTexture  theType 
)
protected

◆ Graphic3d_Texture2D() [3/3]

Graphic3d_Texture2D::Graphic3d_Texture2D ( const Handle< Image_PixMap > &  thePixMap,
const Graphic3d_TypeOfTexture  theType 
)
protected

Member Function Documentation

◆ HasMipMaps()

Standard_Boolean Graphic3d_Texture2D::HasMipMaps ( ) const
inline

Return true if mip-maps should be used.

◆ Name()

Graphic3d_NameOfTexture2D Graphic3d_Texture2D::Name ( ) const

Returns the name of the predefined textures or NOT_2D_UNKNOWN when the name is given as a filename.

◆ NumberOfTextures()

static Standard_Integer Graphic3d_Texture2D::NumberOfTextures ( )
static

Returns the number of predefined textures.

◆ SetImage()

void Graphic3d_Texture2D::SetImage ( const Handle< Image_PixMap > &  thePixMap)

Assign new image to the texture. Note that this method does not invalidate already uploaded resources - consider calling ::UpdateRevision() if needed.

◆ SetMipMaps()

void Graphic3d_Texture2D::SetMipMaps ( const Standard_Boolean  theToUse)
inline

Set if mip-maps should be used (generated if needed). Note that this method should be called before loading / using the texture.

◆ TextureName()

static TCollection_AsciiString Graphic3d_Texture2D::TextureName ( const Standard_Integer  theRank)
static

Returns the name of the predefined texture of rank <aRank>

Field Documentation

◆ myName

Graphic3d_NameOfTexture2D Graphic3d_Texture2D::myName
protected

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