Aspect_ColorRampColorMap Class Reference

This class defines a ColorRampColorMap object.
More...

#include <Aspect_ColorRampColorMap.hxx>

Inheritance diagram for Aspect_ColorRampColorMap:

Public Member Functions
	Aspect_ColorRampColorMap (const Standard_Integer basepixel, const Standard_Integer dimension, const Quantity_Color &color)
	Create a Color Ramp Colormap starting from Black at basepixel to color at basepixel+dimension-1. More...
	Aspect_ColorRampColorMap (const Standard_Integer basepixel, const Standard_Integer dimension, const Quantity_NameOfColor colorName)
	Create a Color Ramp Colormap starting from Black at basepixel to color at basepixel+dimension-1. More...
void	ColorRampDefinition (Standard_Integer &basepixel, Standard_Integer &dimension, Quantity_Color &color) const
	Get Color Ramp Colormap definition . More...
Standard_Integer	FindColorMapIndex (const Standard_Integer ColorMapEntryIndex) 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...
Standard_Integer	AddEntry (const Quantity_Color &aColor)
	Search an identical color entry in the color map <me> <br> or returns the nearest ColorMapEntry Index. 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...

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

Detailed Description

This class defines a ColorRampColorMap object.

Constructor & Destructor Documentation

Aspect_ColorRampColorMap::Aspect_ColorRampColorMap	(	const Standard_Integer	basepixel,
		const Standard_Integer	dimension,
		const Quantity_Color &	color
	)

Create a Color Ramp Colormap starting from Black at
basepixel to color at basepixel+dimension-1.

Aspect_ColorRampColorMap::Aspect_ColorRampColorMap	(	const Standard_Integer	basepixel,
		const Standard_Integer	dimension,
		const Quantity_NameOfColor	colorName
	)

Create a Color Ramp Colormap starting from Black at
basepixel to color at basepixel+dimension-1.

Member Function Documentation

Standard_Integer Aspect_ColorRampColorMap::AddEntry ( const Quantity_Color &  aColor )

virtual

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

or returns the nearest ColorMapEntry Index.

Implements Aspect_ColorMap.

void Aspect_ColorRampColorMap::ColorRampDefinition	(	Standard_Integer &	basepixel,
		Standard_Integer &	dimension,
		Quantity_Color &	color
	)		const

Get Color Ramp Colormap definition .

Standard_Integer Aspect_ColorRampColorMap::FindColorMapIndex ( const Standard_Integer  ColorMapEntryIndex ) 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_ColorRampColorMap::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_ColorRampColorMap::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_ColorRampColorMap::NearestEntry ( const Quantity_Color &  aColor ) const

virtual

Returns the nearest ColorMapEntry that match aColor .

Implements Aspect_ColorMap.

---

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

• Aspect_ColorRampColorMap.hxx