Aspect_ColorMap Class Reference

This class defines a ColorMap object.
More...

#include <Aspect_ColorMap.hxx>

Inheritance diagram for Aspect_ColorMap:

Public Member Functions
Aspect_TypeOfColorMap	Type () const
Standard_Integer	Size () const
	Returns the Allocated colormap Size More...
Standard_Integer	Index (const Standard_Integer aColormapIndex) const
	Returns the ColorMapEntry.Index of the ColorMap at rank <aColormapIndex> . More...
void	Dump () const
const Aspect_ColorMapEntry &	Entry (const Standard_Integer AColorMapIndex) const
	Return the value of the <Index>th element of the ColorMap More...
virtual Standard_Integer	FindColorMapIndex (const Standard_Integer AColorMapEntryIndex) const =0
	Returns the index in the ColorMap of the ColorMapEntry.Index() equal to <AnEntryIndex>. More...
virtual const Aspect_ColorMapEntry &	FindEntry (const Standard_Integer AColorMapEntryIndex) const =0
	Returns the ColorMapEntry with ColorMapEntry.Index() equal to <AnEntryIndex>. More...
virtual Standard_Integer	NearestColorMapIndex (const Quantity_Color &aColor) const =0
	Returns the index in the ColorMap of the nearest matching ColorMapEntry More...
virtual const Aspect_ColorMapEntry &	NearestEntry (const Quantity_Color &aColor) const =0
	Returns the nearest ColorMapEntry that match aColor . More...
virtual Standard_Integer	AddEntry (const Quantity_Color &aColor)=0
	Search an identical color entry in the color map <me> <br> and returns the ColorMapEntry Index if exist. Or add a new entry and returns the computed ColorMapEntry index used. More...
Public Member Functions inherited from MMgt_TShared
virtual void	Delete () const
	Memory deallocator for transient classes. 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	ShallowDump (Standard_OStream &) const
virtual const Handle_Standard_Type &	DynamicType () const
	Returns a type information object about this object. More...
Standard_Boolean	IsInstance (const 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 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...
virtual Handle_Standard_Transient	This () const
	Returns a Handle which references this object. Must never be called to objects created in stack. More...
Standard_Integer	GetRefCount () const
	Get the reference counter of this object. More...

Protected Member Functions
	Aspect_ColorMap (const Aspect_TypeOfColorMap type)

Protected Attributes
Aspect_SequenceOfColorMapEntry	mydata

Detailed Description

This class defines a ColorMap object.

Constructor & Destructor Documentation

Aspect_ColorMap::Aspect_ColorMap ( const Aspect_TypeOfColorMap  type )

protected

Member Function Documentation

virtual Standard_Integer Aspect_ColorMap::AddEntry ( const Quantity_Color &  aColor )

pure virtual

 Search an identical color entry in the color map <me> <br>

and returns the ColorMapEntry Index if exist.
Or add a new entry and returns the computed ColorMapEntry index used.

Implemented in Aspect_ColorRampColorMap, Aspect_ColorCubeColorMap, and Aspect_GenericColorMap.

void Aspect_ColorMap::Dump

(

)

const

const Aspect_ColorMapEntry& Aspect_ColorMap::Entry

(

const Standard_Integer

AColorMapIndex

)

const

Return the value of the <Index>th element of
the ColorMap

virtual Standard_Integer Aspect_ColorMap::FindColorMapIndex ( const Standard_Integer  AColorMapEntryIndex ) const

pure virtual

Returns the index in the ColorMap of the
ColorMapEntry.Index() equal to <AnEntryIndex>.

Implemented in Aspect_GenericColorMap, Aspect_ColorRampColorMap, and Aspect_ColorCubeColorMap.

virtual const Aspect_ColorMapEntry& Aspect_ColorMap::FindEntry ( const Standard_Integer  AColorMapEntryIndex ) const

pure virtual

Returns the ColorMapEntry with ColorMapEntry.Index()
equal to <AnEntryIndex>.

Implemented in Aspect_GenericColorMap, Aspect_ColorRampColorMap, and Aspect_ColorCubeColorMap.

Standard_Integer Aspect_ColorMap::Index

(

const Standard_Integer

aColormapIndex

)

const

Returns the ColorMapEntry.Index of the ColorMap
at rank <aColormapIndex> .

virtual Standard_Integer Aspect_ColorMap::NearestColorMapIndex ( const Quantity_Color &  aColor ) const

pure virtual

Returns the index in the ColorMap of the
nearest matching ColorMapEntry

Implemented in Aspect_GenericColorMap, Aspect_ColorRampColorMap, and Aspect_ColorCubeColorMap.

virtual const Aspect_ColorMapEntry& Aspect_ColorMap::NearestEntry ( const Quantity_Color &  aColor ) const

pure virtual

Returns the nearest ColorMapEntry that match aColor .

Implemented in Aspect_GenericColorMap, Aspect_ColorRampColorMap, and Aspect_ColorCubeColorMap.

Standard_Integer Aspect_ColorMap::Size

(

)

const

Returns the Allocated colormap Size

Aspect_TypeOfColorMap Aspect_ColorMap::Type

(

)

const

Field Documentation

Aspect_SequenceOfColorMapEntry Aspect_ColorMap::mydata

protected

---

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

• Aspect_ColorMap.hxx