Aspect_ColorMapEntry Class Reference

This class defines a colormap entry.
A colormap entry is an association between
a RGB object and a index in the colormap.

#include <Aspect_ColorMapEntry.hxx>

Public Member Functions
DEFINE_STANDARD_ALLOC	Aspect_ColorMapEntry ()
	Creates an unallocated colormap entry
	Aspect_ColorMapEntry (const Standard_Integer index, const Quantity_Color &rgb)
	Creates an allocated colormap entry
	Aspect_ColorMapEntry (const Aspect_ColorMapEntry &entry)
	Creates an allocated colormap entry. Warning: Raises error if the colormap entry <entry> is unallocated.
void	SetValue (const Standard_Integer index, const Quantity_Color &rgb)
	Sets colormap entry value and allocates it.
void	SetValue (const Aspect_ColorMapEntry &entry)
	Sets colormap entry value and allocates it.
void	operator= (const Aspect_ColorMapEntry &entry)
void	SetColor (const Quantity_Color &rgb)
	Sets color <rgb> of colormap entry.
const Quantity_Color &	Color () const
void	SetIndex (const Standard_Integer index)
	Sets index value of a colormap entry.
Standard_Integer	Index () const
void	Free ()
	Unallocates the colormap entry.
Standard_Boolean	IsAllocated () const
	Returns True if the colormap entry is allocated. Warning: A colormap entry is allocated when the color and the index is defined.
void	Dump () const
Standard_Boolean	_CSFDB_GetAspect_ColorMapEntryallocated () const
void	_CSFDB_SetAspect_ColorMapEntryallocated (const Standard_Boolean p)
const Quantity_Color &	_CSFDB_GetAspect_ColorMapEntrymycolor () const
Standard_Integer	_CSFDB_GetAspect_ColorMapEntrymyindex () const
void	_CSFDB_SetAspect_ColorMapEntrymyindex (const Standard_Integer p)
Standard_Boolean	_CSFDB_GetAspect_ColorMapEntrymyColorIsDef () const
void	_CSFDB_SetAspect_ColorMapEntrymyColorIsDef (const Standard_Boolean p)
Standard_Boolean	_CSFDB_GetAspect_ColorMapEntrymyIndexIsDef () const
void	_CSFDB_SetAspect_ColorMapEntrymyIndexIsDef (const Standard_Boolean p)

---

Constructor & Destructor Documentation

DEFINE_STANDARD_ALLOC Aspect_ColorMapEntry::Aspect_ColorMapEntry

(

)

Aspect_ColorMapEntry::Aspect_ColorMapEntry	(	const Standard_Integer	index,
		const Quantity_Color &	rgb
	)

Aspect_ColorMapEntry::Aspect_ColorMapEntry

(

const Aspect_ColorMapEntry &

entry

)

---

Member Function Documentation

Standard_Boolean Aspect_ColorMapEntry::_CSFDB_GetAspect_ColorMapEntryallocated

(

)

const [inline]

const Quantity_Color& Aspect_ColorMapEntry::_CSFDB_GetAspect_ColorMapEntrymycolor

(

)

const [inline]

Standard_Boolean Aspect_ColorMapEntry::_CSFDB_GetAspect_ColorMapEntrymyColorIsDef

(

)

const [inline]

Standard_Integer Aspect_ColorMapEntry::_CSFDB_GetAspect_ColorMapEntrymyindex

(

)

const [inline]

Standard_Boolean Aspect_ColorMapEntry::_CSFDB_GetAspect_ColorMapEntrymyIndexIsDef

(

)

const [inline]

void Aspect_ColorMapEntry::_CSFDB_SetAspect_ColorMapEntryallocated

(

const Standard_Boolean

p

)

[inline]

void Aspect_ColorMapEntry::_CSFDB_SetAspect_ColorMapEntrymyColorIsDef

(

const Standard_Boolean

p

)

[inline]

void Aspect_ColorMapEntry::_CSFDB_SetAspect_ColorMapEntrymyindex

(

const Standard_Integer

p

)

[inline]

void Aspect_ColorMapEntry::_CSFDB_SetAspect_ColorMapEntrymyIndexIsDef

(

const Standard_Boolean

p

)

[inline]

const Quantity_Color& Aspect_ColorMapEntry::Color

(

)

const

void Aspect_ColorMapEntry::Dump

(

)

const

void Aspect_ColorMapEntry::Free

(

)

Standard_Integer Aspect_ColorMapEntry::Index

(

)

const

Standard_Boolean Aspect_ColorMapEntry::IsAllocated

(

)

const

void Aspect_ColorMapEntry::operator=

(

const Aspect_ColorMapEntry &

entry

)

[inline]

void Aspect_ColorMapEntry::SetColor

(

const Quantity_Color &

rgb

)

void Aspect_ColorMapEntry::SetIndex

(

const Standard_Integer

index

)

void Aspect_ColorMapEntry::SetValue	(	const Standard_Integer	index,
		const Quantity_Color &	rgb
	)

void Aspect_ColorMapEntry::SetValue

(

const Aspect_ColorMapEntry &

entry

)

---

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

• Aspect_ColorMapEntry.hxx