OdGiGrayRamp Class Reference

#include <GiPalette.h>

Public Member Functions
	OdGiGrayRamp (OdInt32 nGridDivs=2, float fIntensity=1.0f, OdInt32 nBaseOffset=0)
OdInt32	baseOffset () const
OdInt32	gridDivisions () const
float	intensity () const
OdInt32	dimension () const
ODCOLORREF	color (OdInt32 nColor) const
OdInt32	closestMatch (ODCOLORREF cref) const

Protected Member Functions
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 187 of file GiPalette.h.

Constructor & Destructor Documentation

OdGiGrayRamp()

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

inline

Definition at line 195 of file GiPalette.h.

Member Function Documentation

baseOffset()

OdInt32 OdGiGrayRamp::baseOffset ( ) const

inline

Returns base offset for color entries.

Definition at line 206 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.

dimension()

OdInt32 OdGiGrayRamp::dimension ( ) const

inline

Returns total number of gray ramp subdivisions.

Definition at line 218 of file GiPalette.h.

gridDivisions()

OdInt32 OdGiGrayRamp::gridDivisions ( ) const

inline

Returns gray ramp divisions count.

Definition at line 210 of file GiPalette.h.

intensity()

float OdGiGrayRamp::intensity ( ) const

inline

Returns gray ramp intensity.

Definition at line 214 of file GiPalette.h.

validate()

void OdGiGrayRamp::validate ( )

protected

Member Data Documentation

m_fIntensity

float OdGiGrayRamp::m_fIntensity

protected

Definition at line 192 of file GiPalette.h.

m_nBaseOffset

OdInt32 OdGiGrayRamp::m_nBaseOffset

protected

Definition at line 190 of file GiPalette.h.

m_nDim

OdInt32 OdGiGrayRamp::m_nDim

protected

Definition at line 193 of file GiPalette.h.

m_nGridDivs

OdInt32 OdGiGrayRamp::m_nGridDivs

protected

Definition at line 191 of file GiPalette.h.

---

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

• GiPalette.h