Open CASCADE Technology  7.7.0
Public Member Functions | Protected Attributes
Graphic3d_CubeMapSeparate Class Reference

Class to manage cubemap located in six different images. More...

#include <Graphic3d_CubeMapSeparate.hxx>

Inheritance diagram for Graphic3d_CubeMapSeparate:
Inheritance graph
[legend]

Public Member Functions

 Graphic3d_CubeMapSeparate (const NCollection_Array1< TCollection_AsciiString > &thePaths)
 Initializes cubemap to be loaded from file. - array of paths to separate image files (has to have size equal 6). More...
 
 Graphic3d_CubeMapSeparate (const NCollection_Array1< Handle< Image_PixMap >> &theImages)
 Initializes cubemap to be set directly from PixMaps. - array if PixMaps (has to have size equal 6). More...
 
virtual Handle< Image_CompressedPixMapCompressedValue (const Handle< Image_SupportedFormats > &theSupported) override
 Returns current cubemap side as compressed PixMap. More...
 
virtual Handle< Image_PixMapValue (const Handle< Image_SupportedFormats > &theSupported) override
 Returns current side of cubemap as PixMap. Returns null handle if current side or whole cubemap is invalid. All origin images have to have the same sizes, format and quad shapes to form valid cubemap. More...
 
virtual Handle< Image_PixMapGetImage (const Handle< Image_SupportedFormats > &) override
 Returns NULL. More...
 
Standard_Boolean IsDone () const override
 Checks if a texture class is valid or not. Returns true if the construction of the class is correct. More...
 
 ~Graphic3d_CubeMapSeparate ()
 Empty destructor. More...
 
- Public Member Functions inherited from Graphic3d_CubeMap
 Graphic3d_CubeMap (const TCollection_AsciiString &theFileName, Standard_Boolean theToGenerateMipmaps=Standard_False)
 Constructor defining loading cubemap from file. More...
 
 Graphic3d_CubeMap (const Handle< Image_PixMap > &thePixmap=Handle< Image_PixMap >(), Standard_Boolean theToGenerateMipmaps=Standard_False)
 Constructor defining direct cubemap initialization from PixMap. More...
 
Standard_Boolean More () const
 Returns whether the iterator has reached the end (true if it hasn't). More...
 
Graphic3d_CubeMapSide CurrentSide () const
 Returns current cubemap side (iterator state). More...
 
void Next ()
 Moves iterator to the next cubemap side. Uses OpenGL cubemap sides order +X -> -X -> +Y -> -Y -> +Z -> -Z. More...
 
void SetZInversion (Standard_Boolean theZIsInverted)
 Sets Z axis inversion (vertical flipping). More...
 
Standard_Boolean ZIsInverted () const
 Returns whether Z axis is inverted. More...
 
Standard_Boolean HasMipmaps () const
 Returns whether mipmaps of cubemap will be generated or not. More...
 
void SetMipmapsGeneration (Standard_Boolean theToGenerateMipmaps)
 Sets whether to generate mipmaps of cubemap or not. More...
 
Graphic3d_CubeMapReset ()
 Sets iterator state to +X cubemap side. More...
 
virtual ~Graphic3d_CubeMap ()
 Empty destructor. 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...
 
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_CompressedPixMapGetCompressedImage (const Handle< Image_SupportedFormats > &theSupported)
 This method will be called by graphic driver each time when texture resource should be created. It is called in front of GetImage() for uploading compressed image formats natively supported by GPU. More...
 
const Handle< Graphic3d_TextureParams > & GetParams () const
 
Standard_Boolean IsColorMap () const
 Return flag indicating color nature of values within the texture; TRUE by default. More...
 
void SetColorMap (Standard_Boolean theIsColor)
 Set flag indicating color nature of values within the texture. More...
 
Standard_Boolean HasMipmaps () const
 Returns whether mipmaps should be generated or not. More...
 
void SetMipmapsGeneration (Standard_Boolean theToGenerateMipmaps)
 Sets whether to generate mipmaps or not. More...
 
Standard_Boolean IsTopDown () const
 Returns whether row's memory layout is top-down. 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...
 

Protected Attributes

OSD_Path myPaths [6]
 array of paths to cubemap images More...
 
Handle< Image_PixMapmyImages [6]
 array of cubemap images More...
 
Standard_Size mySize
 size of each side of cubemap More...
 
Image_Format myFormat
 format each side of cubemap More...
 
- Protected Attributes inherited from Graphic3d_CubeMap
Graphic3d_CubeMapSide myCurrentSide
 Iterator state. More...
 
Standard_Boolean myEndIsReached
 Indicates whether end of iteration has been reached or hasn't. More...
 
Standard_Boolean myZIsInverted
 Indicates whether Z axis is inverted that allows to synchronize vertical flip of cubemap. 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...
 
Standard_Boolean myIsColorMap
 flag indicating color nature of values within the texture More...
 
Standard_Boolean myIsTopDown
 Stores rows's memory layout. More...
 
Standard_Boolean myHasMipmaps
 Indicates whether mipmaps should be generated or not. 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 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 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...
 
virtual Handle< Image_PixMapGetImage () const
 Method for supporting old API; another GetImage() method should be implemented instead. More...
 
- 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. More...
 

Detailed Description

Class to manage cubemap located in six different images.

Constructor & Destructor Documentation

◆ Graphic3d_CubeMapSeparate() [1/2]

Graphic3d_CubeMapSeparate::Graphic3d_CubeMapSeparate ( const NCollection_Array1< TCollection_AsciiString > &  thePaths)

Initializes cubemap to be loaded from file. - array of paths to separate image files (has to have size equal 6).

◆ Graphic3d_CubeMapSeparate() [2/2]

Graphic3d_CubeMapSeparate::Graphic3d_CubeMapSeparate ( const NCollection_Array1< Handle< Image_PixMap >> &  theImages)

Initializes cubemap to be set directly from PixMaps. - array if PixMaps (has to have size equal 6).

◆ ~Graphic3d_CubeMapSeparate()

Graphic3d_CubeMapSeparate::~Graphic3d_CubeMapSeparate ( )
inline

Empty destructor.

Member Function Documentation

◆ CompressedValue()

virtual Handle< Image_CompressedPixMap > Graphic3d_CubeMapSeparate::CompressedValue ( const Handle< Image_SupportedFormats > &  theSupported)
overridevirtual

Returns current cubemap side as compressed PixMap.

Implements Graphic3d_CubeMap.

◆ GetImage()

virtual Handle< Image_PixMap > Graphic3d_CubeMapSeparate::GetImage ( const Handle< Image_SupportedFormats > &  )
inlineoverridevirtual

Returns NULL.

Reimplemented from Graphic3d_TextureRoot.

◆ IsDone()

Standard_Boolean Graphic3d_CubeMapSeparate::IsDone ( ) const
overridevirtual

Checks if a texture class is valid or not. Returns true if the construction of the class is correct.

Reimplemented from Graphic3d_TextureRoot.

◆ Value()

virtual Handle< Image_PixMap > Graphic3d_CubeMapSeparate::Value ( const Handle< Image_SupportedFormats > &  theSupported)
overridevirtual

Returns current side of cubemap as PixMap. Returns null handle if current side or whole cubemap is invalid. All origin images have to have the same sizes, format and quad shapes to form valid cubemap.

Implements Graphic3d_CubeMap.

Field Documentation

◆ myFormat

Image_Format Graphic3d_CubeMapSeparate::myFormat
protected

format each side of cubemap

◆ myImages

Handle< Image_PixMap > Graphic3d_CubeMapSeparate::myImages[6]
protected

array of cubemap images

◆ myPaths

OSD_Path Graphic3d_CubeMapSeparate::myPaths[6]
protected

array of paths to cubemap images

◆ mySize

Standard_Size Graphic3d_CubeMapSeparate::mySize
protected

size of each side of cubemap


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