OdGiPhotographicExposureParameters Class Reference

#include <GiViewportTraits.h>

Inheritance diagram for OdGiPhotographicExposureParameters:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdGiPhotographicExposureParameters)
	OdGiPhotographicExposureParameters ()
	OdGiPhotographicExposureParameters (const OdGiPhotographicExposureParameters &params)
virtual	~OdGiPhotographicExposureParameters ()
bool	operator== (const OdGiPhotographicExposureParameters &params) const
bool	operator!= (const OdGiPhotographicExposureParameters &params) const
OdGiPhotographicExposureParameters &	operator= (const OdGiPhotographicExposureParameters &params)
virtual bool	setExposure (double fExposure)
virtual double	exposure () const
virtual bool	setWhitePoint (double fWhitePoint)
virtual double	whitePoint () const
virtual bool	setBrightness (double fBrightness)
OdCmEntityColor	whitePointToColor () const
Public Member Functions inherited from OdGiToneOperatorParameters
	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

Static Public Member Functions
static double	convertExposureToBrightness (double fExposure)
static double	convertBrightnessToExposure (double fBrightness)
Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)
static OdRxClass *	desc ()

Additional Inherited Members
Public Types inherited from OdGiToneOperatorParameters
enum	ExteriorDaylightMode { kDaylightOff = 0 , kDaylightOn = 1 , kDaylightAuto = 2 }

Detailed Description

Class that contains photographic exposure parameters. Corresponding C++ library: TD_Gi <group OdGi_Classes>

Definition at line 320 of file GiViewportTraits.h.

Constructor & Destructor Documentation

OdGiPhotographicExposureParameters() [1/2]

OdGiPhotographicExposureParameters::OdGiPhotographicExposureParameters

(

)

Default constructor for the OdGiPhotographicExposureParameters class. Sets default properties of OdGiToneOperatorParameters and initializes the following data members:

Value Description m_fExposure true Exposure value. m_fWhitePoint false White point in Kelvins which affects the chromaticity of a scene.

OdGiPhotographicExposureParameters() [2/2]

OdGiPhotographicExposureParameters::OdGiPhotographicExposureParameters

(

const OdGiPhotographicExposureParameters &

params

)

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

Parameters

params

[in] Photographic exposure parameters to copy.

~OdGiPhotographicExposureParameters()

virtual OdGiPhotographicExposureParameters::~OdGiPhotographicExposureParameters ( )

inlinevirtual

Destructor for the OdGiPhotographicExposureParameters class.

Definition at line 344 of file GiViewportTraits.h.

Member Function Documentation

convertBrightnessToExposure()

static double OdGiPhotographicExposureParameters::convertBrightnessToExposure ( double  fBrightness )

static

Returns the converted brightness value to an exposure.

Parameters

fBrightness

[in] Brightness value to convert.

convertExposureToBrightness()

static double OdGiPhotographicExposureParameters::convertExposureToBrightness ( double  fExposure )

static

Returns the converted exposure to a brightness value.

Parameters

fExposure

[in] Exposure value to convert.

exposure()

virtual double OdGiPhotographicExposureParameters::exposure ( ) const

virtual

Retrieves the exposure value.

ODRX_DECLARE_MEMBERS()

OdGiPhotographicExposureParameters::ODRX_DECLARE_MEMBERS

(

OdGiPhotographicExposureParameters

)

operator!=()

bool OdGiPhotographicExposureParameters::operator!=

(

const OdGiPhotographicExposureParameters &

params

)

const

Inequality operator for the OdGiPhotographicExposureParameters class.

Parameters

params

[in] Tone operator parameters to compare.

Returns

true if parameters are not equal, false otherwise.

operator=()

OdGiPhotographicExposureParameters & OdGiPhotographicExposureParameters::operator=

(

const OdGiPhotographicExposureParameters &

params

)

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

Parameters

params

[in] Parameters to assign.

operator==()

bool OdGiPhotographicExposureParameters::operator==

(

const OdGiPhotographicExposureParameters &

params

)

const

Equality operator for the OdGiPhotographicExposureParameters class.

Parameters

params

[in] Tone operator parameters to compare.

Returns

true if parameters are equal, false otherwise.

setBrightness()

virtual bool OdGiPhotographicExposureParameters::setBrightness ( double  fBrightness )

virtual

Sets the brightness for the parent OdGiToneOperatorParameters.

Parameters

fBrightness

[in] Brightness in range 0.0..200.0.

Reimplemented from OdGiToneOperatorParameters.

setExposure()

virtual bool OdGiPhotographicExposureParameters::setExposure ( double  fExposure )

virtual

Sets the exposure value. This value is a combination of a camera shutter speed and f-number (depth of field).

Parameters

fExposure

[in] Photographic exposure in range -6.0..21.0.

setWhitePoint()

virtual bool OdGiPhotographicExposureParameters::setWhitePoint ( double  fWhitePoint )

virtual

Sets the white point which affects the chromaticity of a scene.

Parameters

fWhitePoint

[in] White point in kelvins in range 1000.0..20000.0.

whitePoint()

virtual double OdGiPhotographicExposureParameters::whitePoint ( ) const

virtual

Retrieves the white point in kelvins.

whitePointToColor()

OdCmEntityColor OdGiPhotographicExposureParameters::whitePointToColor

(

)

const

Returns the converted white point to a color.

---

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

• GiViewportTraits.h