OdGiViewportTraitsData Class Reference

#include <GiViewportTraitsData.h>

Public Member Functions
	OdGiViewportTraitsData ()
OdGiDrawable::DrawableType	type () const
void	setBackground (OdDbStub *backgroundId)
OdDbStub *	background () const
void	setDefaultLightingOn (bool on)
bool	isDefaultLightingOn () const
void	setDefaultLightingType (OdGiViewportTraits::DefaultLightingType typ)
OdGiViewportTraits::DefaultLightingType	defaultLightingType () const
OdGeVector3d	userDefinedLightDirection () const
void	setUserDefinedLightDirection (const OdGeVector3d &lightDirection)
double	defaultLightingIntensity () const
void	setDefaultLightingIntensity (double dIntensity)
const OdCmEntityColor &	defaultLightingColor () const
void	setDefaultLightingColor (const OdCmEntityColor &color)
const OdGiShadowParameters &	defaultLightingShadowParameters () const
void	setDefaultLightingShadowParameters (const OdGiShadowParameters &params)
void	setAmbientLightColor (const OdCmEntityColor &clr)
const OdCmEntityColor &	ambientLightColor () const
void	setBrightness (double brightness)
double	brightness () const
void	setContrast (double contrast)
double	contrast () const
void	setRenderEnvironment (OdDbStub *renderEnvId)
OdDbStub *	renderEnvironment () const
void	setRenderSettings (OdDbStub *renderSettingsId)
OdDbStub *	renderSettings () const
void	setVisualStyle (OdDbStub *visualStyleId)
OdDbStub *	visualStyle () const
void	setToneOperatorParameters (const OdGiToneOperatorParameters &params)
void	toneOperatorParameters (OdGiToneOperatorParameters &params) const
const OdGiToneOperatorParameters &	toneOperatorParameters () const
bool	operator== (const OdGiViewportTraitsData &data2) const
bool	operator!= (const OdGiViewportTraitsData &data2) const

Static Public Member Functions
static bool	compareToneOps (const OdGiToneOperatorParametersPtr &op1, const OdGiToneOperatorParametersPtr &op2)

Detailed Description

Corresponding C++ library: TD_Gi <group OdGi_Classes>

See also

<link tv_working_with_lights, Work with Lights>

Definition at line 39 of file GiViewportTraitsData.h.

Constructor & Destructor Documentation

OdGiViewportTraitsData()

OdGiViewportTraitsData::OdGiViewportTraitsData ( )

inline

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

Value Description m_backgroundId NULL Viewport background identifier. m_bDefLightOn false Default lighting usage (on/off). m_lightType OdGiViewportTraits::kOneDistantLight Default Lighting type. m_userDefLightDir OdGeVector3d::kZAxis User-defined light direction. m_defLightIntensity 0.5 Default lighting intensity. m_defLightColor (255, 255, 255) Default lighting color. m_defShadowParams setShadowsOn(false) Shadow parameters for default lighting. m_colorAmbient - Ambient color. m_dBrightness 50.0 Overall viewport brightness. m_dContrast 50.0 Overall viewport contrast. m_renderEnvId NULL Render environment identifier. m_renderSettings NULL Render settings identifier. m_visualStyle NULL Visual style identifier. m_pToneOperators default settings* Tone operator parameters. Default settings are set internally with the createObject method.

Definition at line 78 of file GiViewportTraitsData.h.

Member Function Documentation

ambientLightColor()

const OdCmEntityColor & OdGiViewportTraitsData::ambientLightColor ( ) const

inline

Retrieves the ambient color (color in the shadows).

Definition at line 242 of file GiViewportTraitsData.h.

background()

OdDbStub * OdGiViewportTraitsData::background ( ) const

inline

Retrieves a pointer to the background for this viewport.

See also

<link tv_working_with_attributes_view_backgrounds, Work with View Backgrounds>

Definition at line 117 of file GiViewportTraitsData.h.

brightness()

double OdGiViewportTraitsData::brightness ( ) const

inline

Retrieves the brightness for this viewport.

Definition at line 259 of file GiViewportTraitsData.h.

compareToneOps()

static bool OdGiViewportTraitsData::compareToneOps ( const OdGiToneOperatorParametersPtr &  op1, const OdGiToneOperatorParametersPtr &  op2  )

inlinestatic

Compares tone parameters (static and non-static) for the viewport.

Parameters

op1	[in] First tone operator to compare.
op2	[in] Second tone operator to compare.

Returns

true if tone operators are equal, false otherwise.

Definition at line 384 of file GiViewportTraitsData.h.

contrast()

double OdGiViewportTraitsData::contrast ( ) const

inline

Retrieves the overall contrast for this viewport.

Definition at line 276 of file GiViewportTraitsData.h.

defaultLightingColor()

const OdCmEntityColor & OdGiViewportTraitsData::defaultLightingColor ( ) const

inline

Retrieves the default lighting color.

Definition at line 196 of file GiViewportTraitsData.h.

defaultLightingIntensity()

double OdGiViewportTraitsData::defaultLightingIntensity ( ) const

inline

Retrieves the intensity of default lighting.

Definition at line 179 of file GiViewportTraitsData.h.

defaultLightingShadowParameters()

const OdGiShadowParameters & OdGiViewportTraitsData::defaultLightingShadowParameters ( ) const

inline

Retrieves the default lighting shadow parameters.

See also

<link gi_shadows_rendering, Shadows Visualization>

Definition at line 215 of file GiViewportTraitsData.h.

defaultLightingType()

OdGiViewportTraits::DefaultLightingType OdGiViewportTraitsData::defaultLightingType ( ) const

inline

Retrieves the default lighting type.

Definition at line 153 of file GiViewportTraitsData.h.

isDefaultLightingOn()

bool OdGiViewportTraitsData::isDefaultLightingOn ( ) const

inline

Checks whether default lighting is turned on.

Returns

true if default lighting is on, false otherwise.

Definition at line 136 of file GiViewportTraitsData.h.

operator!=()

bool OdGiViewportTraitsData::operator!= ( const OdGiViewportTraitsData &  data2 ) const

inline

Inequality operator for the OdGiViewportTraitsData class. Traits are considered not equal if at least one of the following condition fails: Background identifiers are equal; Default lighting state flags are equal; User-defined light directions are equal; Default lighting intensity values are equal; Default lighting colors are equal; Ambient lighting colors are equal; Brightness values are equal. Contrast values are equal. Render environment identifiers are equal. Render settings identifiers are equal. Render environment identifiers are equal. Visual style identifiers are equal. Tone operators are equal.

Parameters

data2

[in] Viewport traits to compare.

Returns

true if viewport traits are not equal, false otherwise.

Definition at line 453 of file GiViewportTraitsData.h.

operator==()

bool OdGiViewportTraitsData::operator== ( const OdGiViewportTraitsData &  data2 ) const

inline

Equality operator for the OdGiViewportTraitsData class. Traits are considered equal if: Background identifiers are equal; Default lighting state flags are equal; User-defined light directions are equal; Default lighting intensity values are equal; Default lighting colors are equal; Ambient lighting colors are equal; Brightness values are equal. Contrast values are equal. Render environment identifiers are equal. Render settings identifiers are equal. Render environment identifiers are equal. Visual style identifiers are equal. Tone operators are equal.

Parameters

data2

[in] Viewport traits to compare.

Returns

true if viewport traits are equal, false otherwise.

Definition at line 416 of file GiViewportTraitsData.h.

renderEnvironment()

OdDbStub * OdGiViewportTraitsData::renderEnvironment ( ) const

inline

Retrieves a pointer to the render environment for this viewport. Used only in full renders.

Definition at line 293 of file GiViewportTraitsData.h.

renderSettings()

OdDbStub * OdGiViewportTraitsData::renderSettings ( ) const

inline

Retrieves a pointer to the render settings for this viewport. Used only in full renders.

Definition at line 310 of file GiViewportTraitsData.h.

setAmbientLightColor()

void OdGiViewportTraitsData::setAmbientLightColor ( const OdCmEntityColor &  clr )

inline

Sets the ambient color (color in the shadows) for this viewport.

Parameters

clr	[in] Ambient color.

Definition at line 235 of file GiViewportTraitsData.h.

setBackground()

void OdGiViewportTraitsData::setBackground ( OdDbStub *  backgroundId )

inline

Sets the background for this viewport.

Parameters

backgroundId

[in] Pointer to the background.

See also

<link tv_working_with_attributes_view_backgrounds, Work with View Backgrounds>

Definition at line 108 of file GiViewportTraitsData.h.

setBrightness()

void OdGiViewportTraitsData::setBrightness ( double  brightness )

inline

Sets the brightness for this viewport.

Parameters

brightness

[in] Brightness value.

Definition at line 252 of file GiViewportTraitsData.h.

setContrast()

void OdGiViewportTraitsData::setContrast ( double  contrast )

inline

Sets the overall contrast for this viewport.

Parameters

contrast

[in] Light contrast value.

Definition at line 269 of file GiViewportTraitsData.h.

setDefaultLightingColor()

void OdGiViewportTraitsData::setDefaultLightingColor ( const OdCmEntityColor &  color )

inline

Sets the color of default lighting.

Parameters

color

[in] Default lighting color.

Definition at line 204 of file GiViewportTraitsData.h.

setDefaultLightingIntensity()

void OdGiViewportTraitsData::setDefaultLightingIntensity ( double  dIntensity )

inline

Sets the intensity of default lighting.

Parameters

dIntensity

[in] Default lighting intensity.

Definition at line 187 of file GiViewportTraitsData.h.

setDefaultLightingOn()

void OdGiViewportTraitsData::setDefaultLightingOn ( bool  on )

inline

Enables or disables the default lighting.

Parameters

on	[in] Flag that specifies whether to enable the default lighting.

Definition at line 127 of file GiViewportTraitsData.h.

setDefaultLightingShadowParameters()

void OdGiViewportTraitsData::setDefaultLightingShadowParameters ( const OdGiShadowParameters &  params )

inline

Sets the default lighting shadow parameters.

Parameters

params

[in] Shadow parameters.

See also

<link gi_shadows_rendering, Shadows Visualization>

Definition at line 225 of file GiViewportTraitsData.h.

setDefaultLightingType()

void OdGiViewportTraitsData::setDefaultLightingType ( OdGiViewportTraits::DefaultLightingType  typ )

inline

Sets the default lighting type.

Parameters

typ	[in] One of the default lighting types.

Definition at line 146 of file GiViewportTraitsData.h.

setRenderEnvironment()

void OdGiViewportTraitsData::setRenderEnvironment ( OdDbStub *  renderEnvId )

inline

Sets the render environment for this viewport. Used only in full renders.

Parameters

renderEnvId

[in] Pointer to the render environment.

Definition at line 286 of file GiViewportTraitsData.h.

setRenderSettings()

void OdGiViewportTraitsData::setRenderSettings ( OdDbStub *  renderSettingsId )

inline

Sets the render settings for this viewport. Used only in full renders.

Parameters

renderSettingsId

[in] Pointer to the render settings.

Definition at line 303 of file GiViewportTraitsData.h.

setToneOperatorParameters()

void OdGiViewportTraitsData::setToneOperatorParameters ( const OdGiToneOperatorParameters &  params )

inline

Sets the tone parameters for this viewport.

Parameters

params

[in] Tone operator parameters.

Definition at line 342 of file GiViewportTraitsData.h.

setUserDefinedLightDirection()

void OdGiViewportTraitsData::setUserDefinedLightDirection ( const OdGeVector3d &  lightDirection )

inline

Sets the user-defined light direction for distant lights.

Parameters

lightDirection

[in] Vector that specifies the light direction.

Definition at line 170 of file GiViewportTraitsData.h.

setVisualStyle()

void OdGiViewportTraitsData::setVisualStyle ( OdDbStub *  visualStyleId )

inline

Sets the visual style for this viewport. Used only in full renders.

Parameters

visualStyleId

[in] Pointer to the render settings.

See also

<link tv_working_with_attributes_visual_styles, Work with Visual Styles>

Definition at line 322 of file GiViewportTraitsData.h.

toneOperatorParameters() [1/2]

const OdGiToneOperatorParameters & OdGiViewportTraitsData::toneOperatorParameters ( ) const

inline

Retrieves tone parameters for this viewport.

Definition at line 372 of file GiViewportTraitsData.h.

toneOperatorParameters() [2/2]

void OdGiViewportTraitsData::toneOperatorParameters ( OdGiToneOperatorParameters &  params ) const

inline

Retrieves tone parameters for this viewport.

Parameters

params

[out] Receives tone operator parameters.

Definition at line 361 of file GiViewportTraitsData.h.

type()

OdGiDrawable::DrawableType OdGiViewportTraitsData::type ( ) const

inline

Retrieves drawable type which is OdGiDrawable::kViewport for this object.

Definition at line 100 of file GiViewportTraitsData.h.

userDefinedLightDirection()

OdGeVector3d OdGiViewportTraitsData::userDefinedLightDirection ( ) const

inline

Retrieves the user-defined light direction for distant lights.

Definition at line 162 of file GiViewportTraitsData.h.

visualStyle()

OdDbStub * OdGiViewportTraitsData::visualStyle ( ) const

inline

Retrieves a pointer to the visual style for this viewport. Used only in full renders.

See also

<link tv_working_with_attributes_visual_styles, Work with Visual Styles>

Definition at line 332 of file GiViewportTraitsData.h.

---

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

• GiViewportTraitsData.h