Open CASCADE Technology  7.4.0
Public Member Functions | Static Public Member Functions

Graphic3d_TextureEnv Class Reference

This class provides environment texture. More...

#include <Graphic3d_TextureEnv.hxx>

Inheritance diagram for Graphic3d_TextureEnv:
Inheritance graph
[legend]

Public Member Functions

 Graphic3d_TextureEnv (const TCollection_AsciiString &theFileName)
 Creates an environment texture from a file. More...
 
 Graphic3d_TextureEnv (const Graphic3d_NameOfTextureEnv theName)
 Creates an environment texture from a predefined texture name set. More...
 
 Graphic3d_TextureEnv (const Handle< Image_PixMap > &thePixMap)
 Creates an environment texture from the pixmap. More...
 
Graphic3d_NameOfTextureEnv Name () const
 Returns the name of the predefined textures or NOT_ENV_UNKNOWN when the name is given as a filename. More...
 
- 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...
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 
- 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 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...
 

Detailed Description

This class provides environment texture.

Constructor & Destructor Documentation

◆ Graphic3d_TextureEnv() [1/3]

Graphic3d_TextureEnv::Graphic3d_TextureEnv ( const TCollection_AsciiString theFileName)

Creates an environment texture from a file.

◆ Graphic3d_TextureEnv() [2/3]

Graphic3d_TextureEnv::Graphic3d_TextureEnv ( const Graphic3d_NameOfTextureEnv  theName)

Creates an environment texture from a predefined texture name set.

◆ Graphic3d_TextureEnv() [3/3]

Graphic3d_TextureEnv::Graphic3d_TextureEnv ( const Handle< Image_PixMap > &  thePixMap)

Creates an environment texture from the pixmap.

Member Function Documentation

◆ Name()

Graphic3d_NameOfTextureEnv Graphic3d_TextureEnv::Name ( ) const

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

◆ NumberOfTextures()

static Standard_Integer Graphic3d_TextureEnv::NumberOfTextures ( )
static

Returns the number of predefined textures.

◆ TextureName()

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

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


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