OdGiGrayRamp Class Reference

#include <GiPalette.h>

Inheritance diagram for OdGiGrayRamp:

Public Member Functions
	OdGiGrayRamp (OdInt32 nGridDivs=2, float fIntensity=1.0f, OdInt32 nBaseOffset=0)
virtual OdRxObjectPtr	clone () const
OdSmartPtr< OdGiGrayRamp >	cloneIfNeed () const
OdInt32	baseOffset () const
OdInt32	gridDivisions () const
float	intensity () const
OdInt32	dimension () const
ODCOLORREF	color (OdInt32 nColor) const
OdInt32	closestMatch (ODCOLORREF cref) const
Public Member Functions inherited from OdStaticRxObject< OdRxObject >
void	addRef ()
void	release ()
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

Static Public Member Functions
static OdSmartPtr< OdGiGrayRamp >	createDynamic (OdInt32 nGridDivs=2, float fIntensity=1.0f, OdInt32 nBaseOffset=0)
Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)
static OdRxClass *	desc ()

Protected Member Functions
virtual bool	isDynamic () const
void	validate ()

Protected Attributes
OdInt32	m_nBaseOffset
OdInt32	m_nGridDivs
float	m_fIntensity
OdInt32	m_nDim

Detailed Description

This class represents shades of gray ramp. Corresponding C++ library: TD_Gi <group OdGi_Classes>

Definition at line 198 of file GiPalette.h.

Constructor & Destructor Documentation

OdGiGrayRamp()

OdGiGrayRamp::OdGiGrayRamp ( OdInt32  nGridDivs = 2, float  fIntensity = 1.0f, OdInt32  nBaseOffset = 0  )

inline

Definition at line 208 of file GiPalette.h.

Member Function Documentation

baseOffset()

OdInt32 OdGiGrayRamp::baseOffset ( ) const

inline

Returns base offset for color entries.

Definition at line 223 of file GiPalette.h.

clone()

virtual OdRxObjectPtr OdGiGrayRamp::clone ( ) const

virtual

Creates a clone of this object, and returns a pointer to the clone.

Reimplemented from OdRxObject.

cloneIfNeed()

OdSmartPtr< OdGiGrayRamp > OdGiGrayRamp::cloneIfNeed ( ) const

inline

Definition at line 218 of file GiPalette.h.

closestMatch()

OdInt32 OdGiGrayRamp::closestMatch

(

ODCOLORREF

cref

)

const

Compute closest gray ramp subdivision index.

Parameters

cref	[in] Input color.

color()

ODCOLORREF OdGiGrayRamp::color

(

OdInt32

nColor

)

const

Returns color for specified gray ramp subdivision.

Parameters

nColor

[in] Index of gray ramp subdivision.

createDynamic()

static OdSmartPtr< OdGiGrayRamp > OdGiGrayRamp::createDynamic ( OdInt32  nGridDivs = 2, float  fIntensity = 1.0f, OdInt32  nBaseOffset = 0  )

static

dimension()

OdInt32 OdGiGrayRamp::dimension ( ) const

inline

Returns total number of gray ramp subdivisions.

Definition at line 235 of file GiPalette.h.

gridDivisions()

OdInt32 OdGiGrayRamp::gridDivisions ( ) const

inline

Returns gray ramp divisions count.

Definition at line 227 of file GiPalette.h.

intensity()

float OdGiGrayRamp::intensity ( ) const

inline

Returns gray ramp intensity.

Definition at line 231 of file GiPalette.h.

isDynamic()

virtual bool OdGiGrayRamp::isDynamic ( ) const

inlineprotectedvirtual

Definition at line 206 of file GiPalette.h.

validate()

void OdGiGrayRamp::validate ( )

protected

Member Data Documentation

m_fIntensity

float OdGiGrayRamp::m_fIntensity

protected

Definition at line 203 of file GiPalette.h.

m_nBaseOffset

OdInt32 OdGiGrayRamp::m_nBaseOffset

protected

Definition at line 201 of file GiPalette.h.

m_nDim

OdInt32 OdGiGrayRamp::m_nDim

protected

Definition at line 204 of file GiPalette.h.

m_nGridDivs

OdInt32 OdGiGrayRamp::m_nGridDivs

protected

Definition at line 202 of file GiPalette.h.

---

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

• GiPalette.h