#include <GiViewportTraits.h>

Inheritance diagram for OdGiViewportTraits:

Public Types
enum	DefaultLightingType { kOneDistantLight = 0 , kTwoDistantLights = 1 , kBackLighting = 2 , kUserDefinedLight = 3 }

Public Types inherited from OdGiSubEntityTraits
enum	DrawFlags { kNoDrawFlags = 0x0000 , kDrawBackfaces = 0x0001 , kDrawHatchGroup = 0x0002 , kDrawFrontfacesOnly = 0x0004 , kDrawGradientFill = 0x0008 , kDrawSolidFill = 0x0010 , kDrawNoLineWeight = 0x0020 , kDrawNoPlotstyle = 0x0080 , kDrawContourFill = 0x08000 , kDisableLayoutCache = 0x10000 , kDrawBoundaryForClipping = 0x20000 , kDrawBoundaryForClippingDrw = 0x40000 , kClipSetIsEmpty = 0x80000 , kDrawPolygonFill = 0x100000 , kExcludeFromViewExt = 0x200000 , kDrawDgLsPolyWithoutBreaks = 0x400000 , kPolygonProcessing = 0x800000 , kDisableAutoGenerateNormals = 0x1000000 , kDisableFillModeCheck = 0x2000000 , kDrawUnderlayReference = 0x4000000 , kLineStyleScaleOverride = 0x8000000 , kDisableDisplayClipping = 0x10000000 , kRegenTypeDependent2dDraw = 0x20000000 , kInternalDrawFlags = kDisableLayoutCache \| kClipSetIsEmpty \| kRegenTypeDependent2dDraw , kDrawGeometryForExtents = 0x04000 , kFxNoFillOnSelect = 0x40000000 , kInheritableDrawFlags }

enum	LockFlags { kNoLockFlags = 0x00000000 , kLockColors = 0x00000001 , kLockLineWeight = 0x00000002 , kLockLineType = 0x00000004 , kLockLineTypeScale = 0x00000008 , kLockLayer = 0x00000010 , kLockByBlockLayer = 0x00000020 , kKeepAuxDataAndLockFlags = 0x00000040 , kInheritableLockFlags = kLockColors \| kLockLineWeight \| kLockLineType \| kLockLineTypeScale \| kLockLayer \| kKeepAuxDataAndLockFlags }

enum	ShadowFlags { kShadowsCastAndReceive = 0 , kShadowsDoesNotCast = 1 , kShadowsDoesNotReceive = 2 , kShadowsIgnore = kShadowsDoesNotCast \| kShadowsDoesNotReceive }

enum	SelectionFlags { kNoSelectionFlags = 0 , kSelectionIgnore = 1 , kHighlightingGeometry = 2 , kHiddenInHighlight = 4 , kFxSubentitySelection = 0x80 }

enum	SubEntityHints { kHint2DAttributes = 1 , kHint3DAttributes = 2 , kHintAllAttributes = kHint2DAttributes \| kHint3DAttributes , kHintSnapModeOn = 4 , kHintDefaultState = kHintAllAttributes }

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdGiViewportTraits)

virtual bool	isDefaultLightingOn () const =0

virtual void	setDefaultLightingOn (bool b)=0

virtual DefaultLightingType	defaultLightingType () const =0

virtual void	setDefaultLightingType (DefaultLightingType)=0

virtual OdGeVector3d	userDefinedLightDirection () const =0

virtual void	setUserDefinedLightDirection (const OdGeVector3d &lightDirection)=0

virtual double	defaultLightingIntensity () const =0

virtual void	setDefaultLightingIntensity (double dIntensity)=0

virtual OdCmEntityColor	defaultLightingColor () const =0

virtual void	setDefaultLightingColor (const OdCmEntityColor &color)=0

virtual void	defaultLightingShadowParameters (OdGiShadowParameters &params) const =0

virtual void	setDefaultLightingShadowParameters (const OdGiShadowParameters &params)=0

virtual void	setAmbientLightColor (const OdCmEntityColor &color)=0

virtual OdCmEntityColor	ambientLightColor () const =0

virtual void	setContrast (double contrast)=0

virtual double	contrast () const =0

virtual void	setBrightness (double brightness)=0

virtual double	brightness () const =0

virtual void	setBackground (OdDbStub *bg)=0

virtual OdDbStub *	background () const =0

virtual void	setRenderEnvironment (OdDbStub *re)=0

virtual OdDbStub *	renderEnvironment () const =0

virtual void	setRenderSettings (OdDbStub *rs)=0

virtual OdDbStub *	renderSettings () const =0

virtual void	setToneOperatorParameters (const OdGiToneOperatorParameters &params)=0

virtual void	toneOperatorParameters (OdGiToneOperatorParameters &params)=0

Public Member Functions inherited from OdGiSubEntityTraits
	ODRX_DECLARE_MEMBERS (OdGiSubEntityTraits)

virtual void	setColor (OdUInt16 color)=0

virtual void	setTrueColor (const OdCmEntityColor &color)=0

virtual void	setLayer (OdDbStub *layerId)=0

virtual void	setLineType (OdDbStub *lineTypeId)=0

virtual void	setSelectionMarker (OdGsMarker selectionMarker)=0

virtual void	setFillType (OdGiFillType fillType)=0

virtual void	setFillPlane (const OdGeVector3d *pNormal=0)

virtual void	setLineWeight (OdDb::LineWeight lineWeight)=0

virtual void	setLineTypeScale (double lineTypeScale=1.0)=0

virtual void	setThickness (double thickness)=0

virtual void	setPlotStyleName (OdDb::PlotStyleNameType plotStyleNameType, OdDbStub *plotStyleNameId=0)=0

virtual void	setMaterial (OdDbStub *materialId)=0

virtual void	setMapper (const OdGiMapper *pMapper)=0

virtual void	setVisualStyle (const OdDbStub *visualStyleId)

virtual void	setTransparency (const OdCmTransparency &transparency)

virtual void	setDrawFlags (OdUInt32 drawFlags)

virtual void	setLockFlags (OdUInt32 lockFlags)

virtual void	setSelectionGeom (bool bSelectionFlag)

virtual void	setShadowFlags (ShadowFlags shadowFlags)

virtual void	setSectionable (bool bSectionableFlag)

virtual void	setSelectionFlags (SelectionFlags selectionFlags)

virtual OdUInt16	color () const =0

virtual OdCmEntityColor	trueColor () const =0

virtual OdDbStub *	layer () const =0

virtual OdDbStub *	lineType () const =0

virtual OdGiFillType	fillType () const =0

virtual bool	fillPlane (OdGeVector3d &normal)

virtual OdDb::LineWeight	lineWeight () const =0

virtual double	lineTypeScale () const =0

virtual double	thickness () const =0

virtual OdDb::PlotStyleNameType	plotStyleNameType () const =0

virtual OdDbStub *	plotStyleNameId () const =0

virtual OdDbStub *	material () const =0

virtual const OdGiMapper *	mapper () const =0

virtual OdDbStub *	visualStyle () const

virtual OdCmTransparency	transparency () const

virtual OdUInt32	drawFlags () const

virtual OdUInt32	lockFlags () const

virtual bool	selectionGeom () const

virtual ShadowFlags	shadowFlags () const

virtual bool	sectionable () const

virtual SelectionFlags	selectionFlags () const

virtual void	setSecondaryTrueColor (const OdCmEntityColor &color)

virtual OdCmEntityColor	secondaryTrueColor () const

virtual void	setLineStyleModifiers (const OdGiDgLinetypeModifiers *pLSMod)

virtual const OdGiDgLinetypeModifiers *	lineStyleModifiers () const

virtual void	setFill (const OdGiFill *pFill)

virtual const OdGiFill *	fill () const

virtual void	setAuxData (const OdGiAuxiliaryDataPtr &pAuxData)

virtual OdGiAuxiliaryDataPtr	auxData () const

virtual bool	pushLineweightOverride (const OdGiLineweightOverride *pOverride)

virtual void	popLineweightOverride ()

virtual bool	pushPaletteOverride (const OdGiPalette *pOverride)

virtual void	popPaletteOverride ()

virtual OdUInt32	setupForEntity () const

virtual void	addLight (const OdDbStub *lightId)

Public Member Functions inherited from OdGiDrawableTraits
	ODRX_DECLARE_MEMBERS (OdGiDrawableTraits)

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

Corresponding C++ library: TD_Gi <group OdGi_Classes>

See also: <link tv_working_with_lights, Work with Lights>

Definition at line 464 of file GiViewportTraits.h.

Member Enumeration Documentation

◆ DefaultLightingType

enum OdGiViewportTraits::DefaultLightingType

Represents default lighting types for a viewport.

Enumerator
kOneDistantLight	One distant light (that is located infinitely far from a scene).
kTwoDistantLights	Two distant lights (that are located infinitely far from a scene).
kBackLighting	Background is the source of default lighting.
kUserDefinedLight	Default lighting is defined by user.

Definition at line 472 of file GiViewportTraits.h.

Member Function Documentation

◆ ambientLightColor()

virtual OdCmEntityColor OdGiViewportTraits::ambientLightColor ( ) const

pure virtual

Retrieves the ambient color (color in the shadows).

◆ background()

virtual OdDbStub * OdGiViewportTraits::background ( ) const

pure virtual

Retrieves a pointer to the background for this viewport.

◆ brightness()

virtual double OdGiViewportTraits::brightness ( ) const

pure virtual

Retrieves the brightness for this viewport.

◆ contrast()

virtual double OdGiViewportTraits::contrast ( ) const

pure virtual

Retrieves the overall contrast for this viewport.

◆ defaultLightingColor()

virtual OdCmEntityColor OdGiViewportTraits::defaultLightingColor ( ) const

pure virtual

Retrieves the default lighting color.

◆ defaultLightingIntensity()

virtual double OdGiViewportTraits::defaultLightingIntensity ( ) const

pure virtual

Retrieves the intensity of default lighting.

◆ defaultLightingShadowParameters()

virtual void OdGiViewportTraits::defaultLightingShadowParameters ( OdGiShadowParameters & params ) const

pure virtual

Retrieves the default lighting shadow parameters.

Parameters

params [out] Receives default shadow parameters.

◆ defaultLightingType()

virtual DefaultLightingType OdGiViewportTraits::defaultLightingType ( ) const

pure virtual

Retrieves the default lighting type.

◆ isDefaultLightingOn()

virtual bool OdGiViewportTraits::isDefaultLightingOn ( ) const

pure virtual

Checks whether default lighting is turned on.

Returns: true if default lighting is on, false otherwise.

◆ ODRX_DECLARE_MEMBERS()

OdGiViewportTraits::ODRX_DECLARE_MEMBERS ( OdGiViewportTraits )

◆ renderEnvironment()

virtual OdDbStub * OdGiViewportTraits::renderEnvironment ( ) const

pure virtual

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

◆ renderSettings()

virtual OdDbStub * OdGiViewportTraits::renderSettings ( ) const

pure virtual

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

◆ setAmbientLightColor()

virtual void OdGiViewportTraits::setAmbientLightColor ( const OdCmEntityColor & color )

pure virtual

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

Parameters

color [in] Ambient color.

◆ setBackground()

virtual void OdGiViewportTraits::setBackground ( OdDbStub * bg )

pure virtual

Sets the background for this viewport.

Parameters

bg	[in] Pointer to the background.

◆ setBrightness()

virtual void OdGiViewportTraits::setBrightness ( double brightness )

pure virtual

Sets the brightness for this viewport.

Parameters

brightness [in] Brightness value.

◆ setContrast()

virtual void OdGiViewportTraits::setContrast ( double contrast )

pure virtual

Sets the overall contrast for this viewport.

Parameters

contrast [in] Light contrast value.

◆ setDefaultLightingColor()

virtual void OdGiViewportTraits::setDefaultLightingColor ( const OdCmEntityColor & color )

pure virtual

Sets the intensity of default lighting.

Parameters

color [in] Default lighting color.

◆ setDefaultLightingIntensity()

virtual void OdGiViewportTraits::setDefaultLightingIntensity ( double dIntensity )

pure virtual

Sets the intensity of default lighting.

Parameters

dIntensity [in] Default lighting intensity.

◆ setDefaultLightingOn()

virtual void OdGiViewportTraits::setDefaultLightingOn ( bool b )

pure virtual

Enables or disables the default lighting.

Parameters

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

◆ setDefaultLightingShadowParameters()

virtual void OdGiViewportTraits::setDefaultLightingShadowParameters ( const OdGiShadowParameters & params )

pure virtual

Sets the default lighting shadow parameters.

Parameters

params [in] Shadow parameters.

◆ setDefaultLightingType()

virtual void OdGiViewportTraits::setDefaultLightingType ( DefaultLightingType )

pure virtual

Sets the default lighting type.

Parameters

DefaultLightingType [in] One of the default lighting types.

◆ setRenderEnvironment()

virtual void OdGiViewportTraits::setRenderEnvironment ( OdDbStub * re )

pure virtual

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

Parameters

re	[in] Pointer to the render environment.

◆ setRenderSettings()

virtual void OdGiViewportTraits::setRenderSettings ( OdDbStub * rs )

pure virtual

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

Parameters

rs	[in] Pointer to the render settings.

◆ setToneOperatorParameters()

virtual void OdGiViewportTraits::setToneOperatorParameters ( const OdGiToneOperatorParameters & params )

pure virtual

Sets the tone parameters for this viewport.

Parameters

params [in] Tone operator parameters.

◆ setUserDefinedLightDirection()

virtual void OdGiViewportTraits::setUserDefinedLightDirection ( const OdGeVector3d & lightDirection )

pure virtual

Sets the user-defined light direction for distant lights.

Parameters

lightDirection [in] Vector that specifies the light direction.

◆ toneOperatorParameters()

virtual void OdGiViewportTraits::toneOperatorParameters ( OdGiToneOperatorParameters & params )

pure virtual

Retrieves tone parameters for this viewport.

Parameters

params [out] Receives tone operator parameters.

◆ userDefinedLightDirection()

virtual OdGeVector3d OdGiViewportTraits::userDefinedLightDirection ( ) const

pure virtual

Retrieves the user-defined light direction for distant lights.

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

GiViewportTraits.h

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ DefaultLightingType

Member Function Documentation

◆ ambientLightColor()

◆ background()

◆ brightness()

◆ contrast()

◆ defaultLightingColor()

◆ defaultLightingIntensity()

◆ defaultLightingShadowParameters()

◆ defaultLightingType()

◆ isDefaultLightingOn()

◆ ODRX_DECLARE_MEMBERS()

◆ renderEnvironment()

◆ renderSettings()

◆ setAmbientLightColor()

◆ setBackground()

◆ setBrightness()

◆ setContrast()

◆ setDefaultLightingColor()

◆ setDefaultLightingIntensity()

◆ setDefaultLightingOn()

◆ setDefaultLightingShadowParameters()

◆ setDefaultLightingType()

◆ setRenderEnvironment()

◆ setRenderSettings()

◆ setToneOperatorParameters()

◆ setUserDefinedLightDirection()

◆ toneOperatorParameters()

◆ userDefinedLightDirection()