CFx SDK Documentation  2020SP3
Public Types | Public Member Functions | List of all members
OdGiViewportTraits Class Referenceabstract

#include <GiViewportTraits.h>

Inheritance diagram for OdGiViewportTraits:
OdGiSubEntityTraits OdGiDrawableTraits OdRxObject

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, kInternalDrawFlags = kDisableLayoutCache | kClipSetIsEmpty, kDrawPolygonFill = 0x100000, kExcludeFromViewExt = 0x200000,
  kDrawDgLsPolyWithoutBreaks = 0x400000, kPolygonProcessing = 0x800000, kDisableAutoGenerateNormals = 0x1000000, kDisableFillModeCheck = 0x2000000,
  kDrawUnderlayReference = 0x4000000, kFxNoFillOnSelect = 0x08000000, kInheritableDrawFlags
}
 
enum  ShadowFlags { kShadowsCastAndReceive = 0, kShadowsDoesNotCast = 1, kShadowsDoesNotReceive = 2, kShadowsIgnore = kShadowsDoesNotCast | kShadowsDoesNotReceive }
 
enum  SelectionFlags { kNoSelectionFlags = 0, kSelectionIgnore = 1, kHighlightingGeometry = 2, 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 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 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 bool pushLineweightOverride (const OdGiLineweightOverride *pOverride)
 
virtual void popLineweightOverride ()
 
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>

Definition at line 175 of file GiViewportTraits.h.

Member Enumeration Documentation

◆ DefaultLightingType

enum OdGiViewportTraits::DefaultLightingType
Enumerator
kOneDistantLight 
kTwoDistantLights 
kBackLighting 
kUserDefinedLight 

Definition at line 180 of file GiViewportTraits.h.

Member Function Documentation

◆ ambientLightColor()

virtual OdCmEntityColor OdGiViewportTraits::ambientLightColor ( ) const
pure virtual

◆ background()

virtual OdDbStub* OdGiViewportTraits::background ( ) const
pure virtual

◆ brightness()

virtual double OdGiViewportTraits::brightness ( ) const
pure virtual

◆ contrast()

virtual double OdGiViewportTraits::contrast ( ) const
pure virtual

◆ defaultLightingColor()

virtual OdCmEntityColor OdGiViewportTraits::defaultLightingColor ( ) const
pure virtual

◆ defaultLightingIntensity()

virtual double OdGiViewportTraits::defaultLightingIntensity ( ) const
pure virtual

◆ defaultLightingShadowParameters()

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

◆ defaultLightingType()

virtual DefaultLightingType OdGiViewportTraits::defaultLightingType ( ) const
pure virtual

◆ isDefaultLightingOn()

virtual bool OdGiViewportTraits::isDefaultLightingOn ( ) const
pure virtual

◆ ODRX_DECLARE_MEMBERS()

OdGiViewportTraits::ODRX_DECLARE_MEMBERS ( OdGiViewportTraits  )

◆ renderEnvironment()

virtual OdDbStub* OdGiViewportTraits::renderEnvironment ( ) const
pure virtual

◆ renderSettings()

virtual OdDbStub* OdGiViewportTraits::renderSettings ( ) const
pure virtual

◆ setAmbientLightColor()

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

◆ setBackground()

virtual void OdGiViewportTraits::setBackground ( OdDbStub *  bg)
pure virtual

◆ setBrightness()

virtual void OdGiViewportTraits::setBrightness ( double  brightness)
pure virtual

◆ setContrast()

virtual void OdGiViewportTraits::setContrast ( double  contrast)
pure virtual

◆ setDefaultLightingColor()

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

◆ setDefaultLightingIntensity()

virtual void OdGiViewportTraits::setDefaultLightingIntensity ( double  dIntensity)
pure virtual

◆ setDefaultLightingOn()

virtual void OdGiViewportTraits::setDefaultLightingOn ( bool  b)
pure virtual

◆ setDefaultLightingShadowParameters()

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

◆ setDefaultLightingType()

virtual void OdGiViewportTraits::setDefaultLightingType ( DefaultLightingType  )
pure virtual

◆ setRenderEnvironment()

virtual void OdGiViewportTraits::setRenderEnvironment ( OdDbStub *  re)
pure virtual

◆ setRenderSettings()

virtual void OdGiViewportTraits::setRenderSettings ( OdDbStub *  rs)
pure virtual

◆ setToneOperatorParameters()

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

◆ setUserDefinedLightDirection()

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

◆ toneOperatorParameters()

virtual void OdGiViewportTraits::toneOperatorParameters ( OdGiToneOperatorParameters &  params)
pure virtual

◆ userDefinedLightDirection()

virtual OdGeVector3d OdGiViewportTraits::userDefinedLightDirection ( ) const
pure virtual
The documentation for this class was generated from the following file:
Generated on Mon Oct 12 2020 11:50:06