OdGiToneOperatorParameters Class Reference

#include <GiViewportTraits.h>

Inheritance diagram for OdGiToneOperatorParameters:

Public Types
enum	ExteriorDaylightMode { kDaylightOff = 0 , kDaylightOn = 1 , kDaylightAuto = 2 }

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdGiToneOperatorParameters)
	OdGiToneOperatorParameters ()
	OdGiToneOperatorParameters (const OdGiToneOperatorParameters &params)
virtual	~OdGiToneOperatorParameters ()
bool	operator== (const OdGiToneOperatorParameters &params) const
bool	operator!= (const OdGiToneOperatorParameters &params) const
OdGiToneOperatorParameters &	operator= (const OdGiToneOperatorParameters &params)
virtual void	setIsActive (bool bActive)
virtual bool	isActive () const
virtual void	setChromaticAdaptation (bool bEnable)
virtual bool	chromaticAdaptation () const
virtual void	setColorDifferentiation (bool bEnable)
virtual bool	colorDifferentiation () const
virtual void	setWhiteColor (const OdCmEntityColor &color)
virtual const OdCmEntityColor &	whiteColor () const
virtual void	setProcessBackground (bool bProcessBg)
virtual bool	processBackground () const
virtual bool	setBrightness (double fBrightness)
virtual double	brightness () const
virtual bool	setContrast (double fContrast)
virtual double	contrast () const
virtual bool	setMidTones (double fMidTones)
virtual double	midTones () const
virtual bool	setExteriorDaylight (ExteriorDaylightMode mode)
virtual ExteriorDaylightMode	exteriorDaylight () 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

Class that contains all tone parameters. Corresponding C++ library: TD_Gi <group OdGi_Classes>

Definition at line 40 of file GiViewportTraits.h.

Member Enumeration Documentation

ExteriorDaylightMode

enum OdGiToneOperatorParameters::ExteriorDaylightMode

Represents exterior daylight modes.

Enumerator
kDaylightOff	Daylight is off.
kDaylightOn	Daylight is on.
kDaylightAuto	Daylight depends on the sun status.

Definition at line 46 of file GiViewportTraits.h.

Constructor & Destructor Documentation

OdGiToneOperatorParameters() [1/2]

OdGiToneOperatorParameters::OdGiToneOperatorParameters

(

)

Default constructor for the OdGiToneOperatorParameters class. Initializes the following data members:

Value Description m_bIsActive true The tone operator state. When this flag is set to false, some methods may not apply the passed parameters for this tone operator (for example, contrast, daylight exterior mode, etc.). m_bChromaticAdaptation false Chromatic adaptation. m_bColorDifferentiation false Color differentiation. m_clrWhiteColor 0xC2FFFFFF Reference white color. m_bProcessBackground false Flag that indicates whether background should be processed by exposure control at render time. m_fBrightness 65.0 Brightness in range 0..200. m_fContrast 50.0 Contrast in range 0..100. m_fMidTones 1.0 Midtones in range 0.01..20.0. m_eExteriorDaylight kDaylightAuto Daylight exterior mode (on, off, or depends on the sun state).

OdGiToneOperatorParameters() [2/2]

OdGiToneOperatorParameters::OdGiToneOperatorParameters

(

const OdGiToneOperatorParameters &

params

)

Copy constructor for the OdGiToneOperatorParameters class. Copies the data members of the passed object.

Parameters

params

[in] Tone parameters to copy.

~OdGiToneOperatorParameters()

virtual OdGiToneOperatorParameters::~OdGiToneOperatorParameters ( )

inlinevirtual

Destructor for the OdGiToneOperatorParameters class.

Definition at line 84 of file GiViewportTraits.h.

Member Function Documentation

brightness()

virtual double OdGiToneOperatorParameters::brightness ( ) const

virtual

Retrieves the brightness for this tone.

chromaticAdaptation()

virtual bool OdGiToneOperatorParameters::chromaticAdaptation ( ) const

virtual

Checks whether chromatic adaptation is enabled for this tone.

Returns

true if chromatic adaptation is enabled, false otherwise.

colorDifferentiation()

virtual bool OdGiToneOperatorParameters::colorDifferentiation ( ) const

virtual

Checks whether color differentiation is enabled for this tone.

Returns

true if color differentiation is enabled, false otherwise.

contrast()

virtual double OdGiToneOperatorParameters::contrast ( ) const

virtual

Retrieves the contrast for this tone.

exteriorDaylight()

virtual ExteriorDaylightMode OdGiToneOperatorParameters::exteriorDaylight ( ) const

virtual

Retrieves the daylight exterior mode for this tone.

isActive()

virtual bool OdGiToneOperatorParameters::isActive ( ) const

virtual

Checks whether this tone is active.

Returns

true if this tone is active, false otherwise.

midTones()

virtual double OdGiToneOperatorParameters::midTones ( ) const

virtual

Retrieves the midtones for this tone.

ODRX_DECLARE_MEMBERS()

OdGiToneOperatorParameters::ODRX_DECLARE_MEMBERS

(

OdGiToneOperatorParameters

)

operator!=()

bool OdGiToneOperatorParameters::operator!=

(

const OdGiToneOperatorParameters &

params

)

const

Inequality operator for the OdGiToneOperatorParameters class. The parameters are considered not equal if one of the following condition fails: The active state flags are equal; Chromatic adaptation flags are equal; Color differentiation flags are equal; Reference white colors are equal; The process background flags are equal; Brightness values are equal. Midtone values are equal. Contrast values are equal. Daylight exterior modes are equal.

Parameters

params

[in] Tone operator parameters to compare.

Returns

true if parameters are not equal, false otherwise.

operator=()

OdGiToneOperatorParameters & OdGiToneOperatorParameters::operator=

(

const OdGiToneOperatorParameters &

params

)

Assignment operator for the OdGiToneOperatorParameters class. Returns a reference to this object with new assigned parameters.

Parameters

params

[in] Parameters to assign.

operator==()

bool OdGiToneOperatorParameters::operator==

(

const OdGiToneOperatorParameters &

params

)

const

Equality operator for the OdGiToneOperatorParameters class. The parameters are considered equal if: The active state flags are equal; Chromatic adaptation flags are equal; Color differentiation flags are equal; Reference white colors are equal; The process background flags are equal; Brightness values are equal. Midtone values are equal. Contrast values are equal. Daylight exterior modes are equal.

Parameters

params

[in] Tone operator parameters to compare.

Returns

true if parameters are equal, false otherwise.

processBackground()

virtual bool OdGiToneOperatorParameters::processBackground ( ) const

virtual

Checks whether background processing by exposure control at render time is enabled.

Returns

true if color background processing by exposure control at render time is enabled, false otherwise.

setBrightness()

virtual bool OdGiToneOperatorParameters::setBrightness ( double  fBrightness )

virtual

Sets the brightness for this tone. Value is applied only if the tone is active.

Parameters

fBrightness

[in] Brightness in range 0..200.

Returns

true if a value is successfully applied, false otherwise.

Reimplemented in OdGiPhotographicExposureParameters.

setChromaticAdaptation()

virtual void OdGiToneOperatorParameters::setChromaticAdaptation ( bool  bEnable )

virtual

Specifies whether to enable chromatic adaptation for this tone.

Parameters

bEnable

[in] Flag that specifies whether to enable chromatic adaptation.

setColorDifferentiation()

virtual void OdGiToneOperatorParameters::setColorDifferentiation ( bool  bEnable )

virtual

Specifies whether to enable color differentiation for this tone.

Parameters

bEnable

[in] Flag that specifies whether to enable color differentiation.

setContrast()

virtual bool OdGiToneOperatorParameters::setContrast ( double  fContrast )

virtual

Sets the contrast for this tone. Value is applied only if the tone is active.

Parameters

fContrast

[in] Contrast in range 0..200.

Returns

true if a value is successfully applied, false otherwise.

setExteriorDaylight()

virtual bool OdGiToneOperatorParameters::setExteriorDaylight ( ExteriorDaylightMode  mode )

virtual

Sets the exterior daylight mode for this tone. Value is applied only if the tone is active.

Parameters

mode	[in] Daylight exterior mode.

Returns

true if the mode is successfully applied, false otherwise.

setIsActive()

virtual void OdGiToneOperatorParameters::setIsActive ( bool  bActive )

virtual

Specifies whether this tone is active.

Parameters

bActive

[in] Flag that specifies whether tone is active.

setMidTones()

virtual bool OdGiToneOperatorParameters::setMidTones ( double  fMidTones )

virtual

Sets the midtones for this tone. Value is applied only if the tone is active.

Parameters

fMidTones

[in] Midtones in range 0.01..20.0.

Returns

true if a value is successfully applied, false otherwise.

setProcessBackground()

virtual void OdGiToneOperatorParameters::setProcessBackground ( bool  bProcessBg )

virtual

Specifies whether to enable background processing by exposure control at render time.

Parameters

bProcessBg

[in] Flag that specifies whether to enable background processing.

setWhiteColor()

virtual void OdGiToneOperatorParameters::setWhiteColor ( const OdCmEntityColor &  color )

virtual

Sets the reference white color.

Parameters

color

[in] Reference white color.

whiteColor()

virtual const OdCmEntityColor & OdGiToneOperatorParameters::whiteColor ( ) const

virtual

Retrieves the reference white color.

---

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

• GiViewportTraits.h