This class defines a GenericColorMap object.
More...

#include <Aspect_GenericColorMap.hxx>

Inheritance diagram for Aspect_GenericColorMap:

Public Member Functions
	Aspect_GenericColorMap ()
	Creates a generic ColorMap . More...

void	AddEntry (const Aspect_ColorMapEntry &AnEntry)
	Adds an entry in the color map <me>. <br> Warning: Raises BadAccess if the ColorMapEntry index is alreadry defined. More...

Standard_Integer	AddEntry (const Quantity_Color &aColor)
	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...

void	RemoveEntry (const Standard_Integer AColorMapEntryIndex)
	Remove the ColorMapEntry at position index in the ColorMap <br> Warning: Raises BadAccess if the index is not defined in the ColorMap. More...

Standard_Integer	FindColorMapIndex (const Standard_Integer AColorMapEntryIndex) const
	Returns the index in the ColorMap of the <br> ColorMapEntry.Index() equal to <AnEntryIndex>. <br> Warning: Raises BadAccess if the index is not defined in the ColorMap. More...

const Aspect_ColorMapEntry &	FindEntry (const Standard_Integer AColorMapEntryIndex) const
	Returns the ColorMapEntry with ColorMapEntry.Index() <br> equal to <AnEntryIndex>. <br> Warning: Raises BadAccess if the index is not defined in the ColorMap. More...

Standard_Integer	NearestColorMapIndex (const Quantity_Color &aColor) const
	Returns the index in the ColorMap of the nearest matching ColorMapEntry More...

const Aspect_ColorMapEntry &	NearestEntry (const Quantity_Color &aColor) const
	Returns the nearest ColorMapEntry that match aColor . More...

Public Member Functions inherited from Aspect_ColorMap
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...

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 Attributes
TColStd_DataMapOfIntegerInteger	myDataMap

Protected Attributes inherited from Aspect_ColorMap
Aspect_SequenceOfColorMapEntry	mydata

Additional Inherited Members
Protected Member Functions inherited from Aspect_ColorMap
	Aspect_ColorMap (const Aspect_TypeOfColorMap type)

Detailed Description

This class defines a GenericColorMap object.

Constructor & Destructor Documentation

Aspect_GenericColorMap::Aspect_GenericColorMap ( )

Creates a generic ColorMap .

Member Function Documentation

void Aspect_GenericColorMap::AddEntry ( const Aspect_ColorMapEntry & AnEntry )

Adds an entry in the color map <me>. <br>

Warning: Raises BadAccess if the ColorMapEntry index is alreadry
defined.

Standard_Integer Aspect_GenericColorMap::AddEntry ( const Quantity_Color & aColor )

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.

Implements Aspect_ColorMap.

Standard_Integer Aspect_GenericColorMap::FindColorMapIndex ( const Standard_Integer AColorMapEntryIndex ) const

virtual

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

Warning: Raises BadAccess if the index is not defined in the
ColorMap.

Implements Aspect_ColorMap.

const Aspect_ColorMapEntry& Aspect_GenericColorMap::FindEntry ( const Standard_Integer AColorMapEntryIndex ) const

virtual

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

Warning: Raises BadAccess if the index is not defined in the
ColorMap.

Implements Aspect_ColorMap.

Standard_Integer Aspect_GenericColorMap::NearestColorMapIndex ( const Quantity_Color & aColor ) const

virtual

Returns the index in the ColorMap of the
nearest matching ColorMapEntry

Implements Aspect_ColorMap.

const Aspect_ColorMapEntry& Aspect_GenericColorMap::NearestEntry ( const Quantity_Color & aColor ) const

virtual

Returns the nearest ColorMapEntry that match aColor .

Implements Aspect_ColorMap.

void Aspect_GenericColorMap::RemoveEntry ( const Standard_Integer AColorMapEntryIndex )

Remove the ColorMapEntry at position index in the ColorMap <br>

Warning: Raises BadAccess if the index is not defined in the
ColorMap.

Field Documentation

TColStd_DataMapOfIntegerInteger Aspect_GenericColorMap::myDataMap

protected

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

Aspect_GenericColorMap.hxx

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation