OpenGl_TextureSet Class Reference

Class holding array of textures to be mapped as a set. Textures should be defined in ascending order of texture units within the set. More...

#include <OpenGl_TextureSet.hxx>

Inheritance diagram for OpenGl_TextureSet:

Data Structures
class	Iterator
	Class for iterating texture set. More...
struct	TextureSlot
	Texture slot - combination of Texture and binding Unit. More...

Public Member Functions
	OpenGl_TextureSet ()
	Empty constructor.
	OpenGl_TextureSet (Standard_Integer theNbTextures)
	Constructor.
	OpenGl_TextureSet (const Handle< OpenGl_Texture > &theTexture)
	Constructor for a single texture.
Standard_Integer	TextureSetBits () const
	Return texture units declared within the program,.
Standard_Integer &	ChangeTextureSetBits ()
	Return texture units declared within the program,.
Standard_Boolean	IsEmpty () const
	Return TRUE if texture array is empty.
Standard_Integer	Size () const
	Return number of textures.
Standard_Integer	Lower () const
	Return the lower index in texture set.
Standard_Integer	Upper () const
	Return the upper index in texture set.
const Handle< OpenGl_Texture > &	First () const
	Return the first texture.
Handle< OpenGl_Texture > &	ChangeFirst ()
	Return the first texture.
Graphic3d_TextureUnit	FirstUnit () const
	Return the first texture unit.
const Handle< OpenGl_Texture > &	Last () const
	Return the last texture.
Handle< OpenGl_Texture > &	ChangeLast ()
	Return the last texture.
Graphic3d_TextureUnit	LastUnit () const
	Return the last texture unit.
Graphic3d_TextureUnit &	ChangeLastUnit ()
	Return the last texture unit.
const Handle< OpenGl_Texture > &	Value (Standard_Integer theIndex) const
	Return the texture at specified position within [0, Size()) range.
Handle< OpenGl_Texture > &	ChangeValue (Standard_Integer theIndex)
	Return the texture at specified position within [0, Size()) range.
bool	IsModulate () const
	Return TRUE if texture color modulation has been enabled for the first texture or if texture is not set at all.
bool	HasNonPointSprite () const
	Return TRUE if other than point sprite textures are defined within point set.
bool	HasPointSprite () const
	Return TRUE if last texture is a point sprite.
void	InitZero ()
	Nullify all handles.
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
NCollection_Array1< TextureSlot >	myTextures
Standard_Integer	myTextureSetBits

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 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.

Detailed Description

Class holding array of textures to be mapped as a set. Textures should be defined in ascending order of texture units within the set.

Constructor & Destructor Documentation

OpenGl_TextureSet() [1/3]

OpenGl_TextureSet::OpenGl_TextureSet ( )

inline

Empty constructor.

OpenGl_TextureSet() [2/3]

OpenGl_TextureSet::OpenGl_TextureSet ( Standard_Integer  theNbTextures )

inline

Constructor.

OpenGl_TextureSet() [3/3]

OpenGl_TextureSet::OpenGl_TextureSet

(

const Handle< OpenGl_Texture > &

theTexture

)

Constructor for a single texture.

Member Function Documentation

ChangeFirst()

Handle< OpenGl_Texture > & OpenGl_TextureSet::ChangeFirst ( )

inline

Return the first texture.

ChangeLast()

Handle< OpenGl_Texture > & OpenGl_TextureSet::ChangeLast ( )

inline

Return the last texture.

ChangeLastUnit()

Graphic3d_TextureUnit & OpenGl_TextureSet::ChangeLastUnit ( )

inline

Return the last texture unit.

ChangeTextureSetBits()

Standard_Integer & OpenGl_TextureSet::ChangeTextureSetBits ( )

inline

Return texture units declared within the program,.

See also

Graphic3d_TextureSetBits.

ChangeValue()

Handle< OpenGl_Texture > & OpenGl_TextureSet::ChangeValue ( Standard_Integer  theIndex )

inline

Return the texture at specified position within [0, Size()) range.

First()

const Handle< OpenGl_Texture > & OpenGl_TextureSet::First ( ) const

inline

Return the first texture.

FirstUnit()

Graphic3d_TextureUnit OpenGl_TextureSet::FirstUnit ( ) const

inline

Return the first texture unit.

HasNonPointSprite()

bool OpenGl_TextureSet::HasNonPointSprite

(

)

const

Return TRUE if other than point sprite textures are defined within point set.

HasPointSprite()

bool OpenGl_TextureSet::HasPointSprite

(

)

const

Return TRUE if last texture is a point sprite.

InitZero()

void OpenGl_TextureSet::InitZero ( )

inline

Nullify all handles.

IsEmpty()

Standard_Boolean OpenGl_TextureSet::IsEmpty ( ) const

inline

Return TRUE if texture array is empty.

IsModulate()

bool OpenGl_TextureSet::IsModulate

(

)

const

Return TRUE if texture color modulation has been enabled for the first texture or if texture is not set at all.

Last()

const Handle< OpenGl_Texture > & OpenGl_TextureSet::Last ( ) const

inline

Return the last texture.

LastUnit()

Graphic3d_TextureUnit OpenGl_TextureSet::LastUnit ( ) const

inline

Return the last texture unit.

Lower()

Standard_Integer OpenGl_TextureSet::Lower ( ) const

inline

Return the lower index in texture set.

Size()

Standard_Integer OpenGl_TextureSet::Size ( ) const

inline

Return number of textures.

TextureSetBits()

Standard_Integer OpenGl_TextureSet::TextureSetBits ( ) const

inline

Return texture units declared within the program,.

See also

Graphic3d_TextureSetBits.

Upper()

Standard_Integer OpenGl_TextureSet::Upper ( ) const

inline

Return the upper index in texture set.

Value()

const Handle< OpenGl_Texture > & OpenGl_TextureSet::Value ( Standard_Integer  theIndex ) const

inline

Return the texture at specified position within [0, Size()) range.

Field Documentation

myTextures

NCollection_Array1<TextureSlot> OpenGl_TextureSet::myTextures

protected

myTextureSetBits

Standard_Integer OpenGl_TextureSet::myTextureSetBits

protected

---

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

• OpenGl_TextureSet.hxx