OpenGl_TextureSet Class Reference

Class holding array of textures to be mapped as a set. More...

#include <OpenGl_TextureSet.hxx>

Inheritance diagram for OpenGl_TextureSet:

Data Structures
class	Iterator
	Class for iterating texture set. More...

Public Member Functions
	OpenGl_TextureSet ()
	Empty constructor. More...
	OpenGl_TextureSet (Standard_Integer theNbTextures)
	Constructor. More...
	OpenGl_TextureSet (const Handle< OpenGl_Texture > &theTexture)
	Constructor for a single texture. More...
Standard_Boolean	IsEmpty () const
	Return TRUE if texture array is empty. More...
Standard_Integer	Size () const
	Return number of textures. More...
Standard_Integer	Lower () const
	Return the lower index in texture set. More...
Standard_Integer	Upper () const
	Return the upper index in texture set. More...
const Handle< OpenGl_Texture > &	First () const
	Return the first texture. More...
Handle< OpenGl_Texture > &	ChangeFirst ()
	Return the first texture. More...
const Handle< OpenGl_Texture > &	Value (Standard_Integer theIndex) const
	Return the texture at specified position within [0, Size()) range. More...
Handle< OpenGl_Texture > &	ChangeValue (Standard_Integer theIndex)
	Return the texture at specified position within [0, Size()) range. More...
bool	IsModulate () const
	Return TRUE if texture color modulation has been enabled for the first texture or if texture is not set at all. More...
Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor. More...
	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing. More...
Standard_Transient &	operator= (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_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. 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
NCollection_Array1< Handle< OpenGl_Texture > >	myTextures

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

Detailed Description

Class holding array of textures to be mapped as a 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 )

inline

Constructor for a single texture.

Member Function Documentation

ChangeFirst()

Handle< OpenGl_Texture >& OpenGl_TextureSet::ChangeFirst ( )

inline

Return the first texture.

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.

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.

Lower()

Standard_Integer OpenGl_TextureSet::Lower ( void  ) const

inline

Return the lower index in texture set.

Size()

Standard_Integer OpenGl_TextureSet::Size ( void  ) const

inline

Return number of textures.

Upper()

Standard_Integer OpenGl_TextureSet::Upper ( void  ) 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<Handle< OpenGl_Texture > > OpenGl_TextureSet::myTextures

protected

---

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

• OpenGl_TextureSet.hxx