Texture holder. More...
#include <XCAFPrs_Texture.hxx>
Inheritance diagram for XCAFPrs_Texture:
Public Member Functions | |
| XCAFPrs_Texture (const Handle< Image_Texture > &theImageSource, const Graphic3d_TextureUnit theUnit) | |
| Constructor. | |
| virtual Handle< Image_CompressedPixMap > | GetCompressedImage (const Handle< Image_SupportedFormats > &theSupported) override |
| Image reader. | |
| virtual Handle< Image_PixMap > | GetImage (const Handle< Image_SupportedFormats > &theSupported) override |
| Image reader. | |
| const Handle< Image_Texture > & | GetImageSource () const |
| Return image source. | |
 Public Member Functions inherited from Graphic3d_Texture2D | |
| Graphic3d_Texture2D (const TCollection_AsciiString &theFileName) | |
| Creates a texture from a file. MipMaps levels will be automatically generated if needed. | |
| Graphic3d_Texture2D (const Graphic3d_NameOfTexture2D theNOT) | |
| Creates a texture from a predefined texture name set. MipMaps levels will be automatically generated if needed. | |
| Graphic3d_Texture2D (const Handle< Image_PixMap > &thePixMap) | |
| Creates a texture from the pixmap. MipMaps levels will be automatically generated if needed. | |
| Graphic3d_NameOfTexture2D | Name () const |
| Returns the name of the predefined textures or NOT_2D_UNKNOWN when the name is given as a filename. | |
| 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. | |
| Public Member Functions inherited from Graphic3d_TextureMap | |
| void | EnableSmooth () |
| enable texture smoothing | |
| Standard_Boolean | IsSmoothed () const |
| Returns TRUE if the texture is smoothed. | |
| void | DisableSmooth () |
| disable texture smoothing | |
| void | EnableModulate () |
| enable texture modulate mode. the image is modulate with the shading of the surface. | |
| void | DisableModulate () |
| disable texture modulate mode. the image is directly decal on the surface. | |
| Standard_Boolean | IsModulate () const |
| Returns TRUE if the texture is modulate. | |
| void | EnableRepeat () |
| use this methods if you want to enable texture repetition on your objects. | |
| void | DisableRepeat () |
| use this methods if you want to disable texture repetition on your objects. | |
| Standard_Boolean | IsRepeat () const |
| Returns TRUE if the texture repeat is enable. | |
| Graphic3d_LevelOfTextureAnisotropy | AnisoFilter () const |
| void | SetAnisoFilter (const Graphic3d_LevelOfTextureAnisotropy theLevel) |
| Public Member Functions inherited from Graphic3d_TextureRoot | |
| ~Graphic3d_TextureRoot () | |
| Destructor. | |
| virtual Standard_Boolean | IsDone () const |
| Checks if a texture class is valid or not. | |
| const OSD_Path & | Path () const |
| Returns the full path of the defined texture. It could be empty path if GetImage() is overridden to load image not from file. | |
| Graphic3d_TypeOfTexture | Type () const |
| const TCollection_AsciiString & | GetId () const |
| This ID will be used to manage resource in graphic driver. | |
| Standard_Size | Revision () const |
| Return image revision. | |
| 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). | |
| const Handle< Graphic3d_TextureParams > & | GetParams () const |
| Standard_Boolean | IsColorMap () const |
| Return flag indicating color nature of values within the texture; TRUE by default. | |
| void | SetColorMap (Standard_Boolean theIsColor) |
| Set flag indicating color nature of values within the texture. | |
| Standard_Boolean | HasMipmaps () const |
| Returns whether mipmaps should be generated or not. | |
| void | SetMipmapsGeneration (Standard_Boolean theToGenerateMipmaps) |
| Sets whether to generate mipmaps or not. | |
| Standard_Boolean | IsTopDown () const |
| Returns whether row's memory layout is top-down. | |
| Public Member Functions inherited from Standard_Transient | |
| Standard_Transient () | |
| Empty constructor. | |
| Standard_Transient (const Standard_Transient &) | |
| Copy constructor – does nothing. | |
| Standard_Transient & | operator= (const Standard_Transient &) |
| Assignment operator, needed to avoid copying reference counter. | |
| virtual | ~Standard_Transient () |
| Destructor must be virtual. | |
| virtual const opencascade::handle< Standard_Type > & | DynamicType () const |
| Returns a type descriptor about this object. | |
| Standard_Boolean | IsInstance (const opencascade::handle< Standard_Type > &theType) const |
| Returns a true value if this is an instance of Type. | |
| Standard_Boolean | IsInstance (const Standard_CString theTypeName) const |
| Returns a true value if this is an instance of TypeName. | |
| 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. | |
| 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. | |
| Standard_Transient * | This () 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. | |
| Standard_Integer | GetRefCount () const noexcept |
| Get the reference counter of this object. | |
| void | IncrementRefCounter () noexcept |
| Increments the reference counter of this object. | |
| Standard_Integer | DecrementRefCounter () noexcept |
| Decrements the reference counter of this object; returns the decremented value. | |
| virtual void | Delete () const |
| Memory deallocator for transient classes. | |
Protected Attributes | |
| Handle< Image_Texture > | myImageSource |
| Protected Attributes inherited from Graphic3d_Texture2D | |
| Graphic3d_NameOfTexture2D | myName |
| Protected Attributes inherited from Graphic3d_TextureRoot | |
| Handle< Graphic3d_TextureParams > | myParams |
| associated texture parameters | |
| TCollection_AsciiString | myTexId |
| unique identifier of this resource (for sharing graphic resource); should never be modified outside constructor | |
| Handle< Image_PixMap > | myPixMap |
| image pixmap - as one of the ways for defining the texture source | |
| OSD_Path | myPath |
| image file path - as one of the ways for defining the texture source | |
| Standard_Size | myRevision |
| image revision - for signaling changes in the texture source (e.g. file update, pixmap update) | |
| Graphic3d_TypeOfTexture | myType |
| texture type | |
| Standard_Boolean | myIsColorMap |
| flag indicating color nature of values within the texture | |
| Standard_Boolean | myIsTopDown |
| Stores rows's memory layout. | |
| Standard_Boolean | myHasMipmaps |
| Indicates whether mipmaps should be generated or not. | |
Additional Inherited Members | |
| Public Types inherited from Standard_Transient | |
| typedef void | base_type |
| Returns a type descriptor about this object. | |
| Static Public Member Functions inherited from Graphic3d_Texture2D | |
| static Standard_Integer | NumberOfTextures () |
| Returns the number of predefined textures. | |
| static TCollection_AsciiString | TextureName (const Standard_Integer theRank) |
| Returns the name of the predefined texture of rank <aRank> | |
| Static Public Member Functions inherited from Graphic3d_TextureRoot | |
| static TCollection_AsciiString | TexturesFolder () |
| The path to textures determined from CSF_MDTVTexturesDirectory or CASROOT environment variables. | |
| Static Public Member Functions inherited from Standard_Transient | |
| static constexpr const char * | get_type_name () |
| Returns a type descriptor about this object. | |
| static const opencascade::handle< Standard_Type > & | get_type_descriptor () |
| Returns type descriptor of Standard_Transient class. | |
| Protected Member Functions inherited from Graphic3d_Texture2D | |
| 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. | |
| 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()). | |
| void | generateId () |
| Unconditionally generate new texture id. Should be called only within constructor. | |
| virtual Handle< Image_PixMap > | GetImage () const |
| Method for supporting old API; another GetImage() method should be implemented instead. | |
| Static Protected Member Functions inherited from Graphic3d_TextureRoot | |
| static void | convertToCompatible (const Handle< Image_SupportedFormats > &theSupported, const Handle< Image_PixMap > &theImage) |
| Try converting image to compatible format. | |
Detailed Description
Texture holder.
Constructor & Destructor Documentation
◆ XCAFPrs_Texture()
| XCAFPrs_Texture::XCAFPrs_Texture | ( | const Handle< Image_Texture > & | theImageSource, |
| const Graphic3d_TextureUnit | theUnit | ||
| ) |
Constructor.
Member Function Documentation
◆ GetCompressedImage()
|
overridevirtual |
Image reader.
Reimplemented from Graphic3d_TextureRoot.
◆ GetImage()
|
overridevirtual |
Image reader.
Reimplemented from Graphic3d_TextureRoot.
◆ GetImageSource()
|
inline |
Return image source.
Field Documentation
◆ myImageSource
|
protected |
The documentation for this class was generated from the following file:
