OdGsPalette Class Reference

#include <GsBitMap.h>

Inheritance diagram for OdGsPalette:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdGsPalette)
	OdGsPalette ()
virtual OdUInt32	numColors () const =0
virtual void	setNumColors (OdUInt32 nColors)=0
virtual void	setColorAt (OdUInt32 nIndex, OdUInt8 blue, OdUInt8 green, OdUInt8 red, OdUInt8 alpha=0)=0
virtual void	colorAt (OdUInt32 nIndex, OdUInt8 &blue, OdUInt8 &green, OdUInt8 &red, OdUInt8 *pAlpha=0) const =0
virtual void	setColors (OdUInt32 nColors, const ODCOLORREF *pColors)
virtual void	getColors (OdUInt32 nColors, ODCOLORREF *pColors) const
Public Member Functions inherited from OdRxObject
	ODRX_HEAP_OPERATORS ()
	OdRxObject ()
virtual	~OdRxObject ()
virtual OdRxObject *	queryX (const OdRxClass *pClass) const
virtual OdRxObject *	x (const OdRxClass *pClass) const
virtual OdRxClass *	isA () const
virtual void	addRef ()=0
virtual void	release ()=0
virtual long	numRefs () const
bool	isKindOf (const OdRxClass *pClass) const
virtual OdRxObjectPtr	clone () const
virtual void	copyFrom (const OdRxObject *pSource)
virtual OdRx::Ordering	comparedTo (const OdRxObject *pOther) const
virtual bool	isEqualTo (const OdRxObject *pOther) const

Additional Inherited Members
Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)
static OdRxClass *	desc ()

Detailed Description

<group OdGs_Classes>

Definition at line 40 of file GsBitMap.h.

Constructor & Destructor Documentation

OdGsPalette()

OdGsPalette::OdGsPalette ( )

inline

Default constructor for the OdGsPalette class.

Definition at line 47 of file GsBitMap.h.

Member Function Documentation

colorAt()

virtual void OdGsPalette::colorAt ( OdUInt32  nIndex, OdUInt8 &  blue, OdUInt8 &  green, OdUInt8 &  red, OdUInt8 *  pAlpha = 0  ) const

pure virtual

Retrieves a color data at the specified index.

Parameters

nIndex	[in] Index of a color in the palette.
blue	[out] Receives blue component of a color in range [0..255].
green	[out] Receives green component of a color in range [0..255].
red	[out] Red component of a color in range [0..255].
alpha	[out] Alpha component of a color in range [0..255].

getColors()

virtual void OdGsPalette::getColors ( OdUInt32  nColors, ODCOLORREF *  pColors  ) const

virtual

Retrieves colors of this palette.

Parameters

nColors	[out] Receives number of colors in this palette.
pColors	[out] Pointer to an array of colors for this palette.

numColors()

virtual OdUInt32 OdGsPalette::numColors ( ) const

pure virtual

Retrieves a number of colors in the palette.

ODRX_DECLARE_MEMBERS()

OdGsPalette::ODRX_DECLARE_MEMBERS

(

OdGsPalette

)

setColorAt()

virtual void OdGsPalette::setColorAt ( OdUInt32  nIndex, OdUInt8  blue, OdUInt8  green, OdUInt8  red, OdUInt8  alpha = 0  )

pure virtual

Sets a color at the specified index.

Parameters

nIndex	[in] Index of a color in the palette.
blue	[in] Blue component of a color in range [0..255].
green	[in] Green component of a color in range [0..255].
red	[in] Red component of a color in range [0..255].
alpha	[in] Alpha component of a color in range [0..255].

setColors()

virtual void OdGsPalette::setColors ( OdUInt32  nColors, const ODCOLORREF *  pColors  )

virtual

Sets colors for this palette.

Parameters

nColors	[in] Number of colors in this palette.
pColors	[in] Pointer to an array of colors for this palette.

setNumColors()

virtual void OdGsPalette::setNumColors ( OdUInt32  nColors )

pure virtual

Sets a new size of this palette.

Parameters

nColors

[in] New number of colors in this palette.

---

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

• GsBitMap.h