CFx SDK Documentation  2022 SP0
Public Member Functions | Protected Attributes | List of all members
OdGiLayerTraitsTakerView Class Reference

#include <GsLayerNode.h>

Inheritance diagram for OdGiLayerTraitsTakerView:
OdGiLayerTraitsTaker OdGiViewport OdGiLayerTraits_ OdGiDummyWorldDraw< OdGiDummyWorldGeometry< OdGiWorldDraw_ > > OdGiDummyViewportDraw< OdGiWrapperViewportGeometry< OdGiViewportDraw_ > > OdGiSubEntityTraits_ OdGiLayerTraitsData OdRxObject OdGiLayerTraits OdGiDummyCommonDraw< T > OdGiDummyCommonDraw< T > OdGiDummySubEntityTraits< OdGiSubEntityTraits > OdGiDrawableTraits OdGiSubEntityTraits OdRxObject OdGiDrawableTraits OdRxObject

Public Member Functions

 OdGiLayerTraitsTakerView (OdGsViewImpl &view)
 
OdGiViewportviewport () const
 
OdUInt32 sequenceNumber () const
 
bool isValidId (const OdUInt32 acgiId) const
 
OdDbStub * viewportObjectId () const
 
virtual OdGeMatrix3d getModelToEyeTransform () const
 
virtual OdGeMatrix3d getEyeToModelTransform () const
 
virtual OdGeMatrix3d getWorldToEyeTransform () const
 
virtual OdGeMatrix3d getEyeToWorldTransform () const
 
virtual bool isPerspective () const
 
virtual bool doPerspective (OdGePoint3d &pt) const
 
virtual bool doInversePerspective (OdGePoint3d &pt) const
 
virtual void getNumPixelsInUnitSquare (const OdGePoint3d &pt, OdGePoint2d &pixelDensity, bool bUsePerspective=true) const
 
virtual OdGePoint3d getCameraLocation () const
 
virtual OdGePoint3d getCameraTarget () const
 
virtual OdGeVector3d getCameraUpVector () const
 
virtual OdGeVector3d viewDir () const
 
virtual OdUInt32 viewportId () const
 
virtual OdInt16 acadWindowId () const
 
virtual void getViewportDcCorners (OdGePoint2d &lowerLeft, OdGePoint2d &upperRight) const
 
virtual bool getFrontAndBackClipValues (bool &clipFront, bool &clipBack, double &front, double &back) const
 
virtual double linetypeScaleMultiplier () const
 
virtual double linetypeGenerationCriteria () const
 
virtual bool layerVisible (OdDbStub *layerId) const
 
virtual void addRef ()
 
virtual void release ()
 
virtual double deviation (const OdGiDeviationType type, const OdGePoint3d &pt) const
 
virtual OdUInt32 numberOfIsolines () const
 
virtual OdGiRegenType regenType () const
 
virtual bool regenAbort () const
 
virtual OdGiContextcontext () const
 
- Public Member Functions inherited from OdGiLayerTraitsTaker
 OdGiLayerTraitsTaker ()
 
 OdGiLayerTraitsTaker (const OdGiBaseVectorizer *pRefView, OdGiContext *pContext=NULL)
 
void setRefView (const OdGiBaseVectorizer *pRefView)
 
void reset ()
 
OdDb::LineWeight lineweight () const
 
OdDbStub * linetype () const
 
OdDb::PlotStyleNameType plotStyleNameType () const
 
OdDbStub * plotStyleNameId () const
 
OdDbStub * materialId () const
 
void setColor (const OdCmEntityColor &color)
 
void setLineweight (OdDb::LineWeight lineweight)
 
void setLinetype (OdDbStub *pLinetypeId)
 
void setPlotStyleName (OdDb::PlotStyleNameType plotStyleNameType, OdDbStub *pPlotStyleNameId=0)
 
bool isOff () const
 
void setOff (bool bVal)
 
bool isPlottable () const
 
void setPlottable (bool bVal)
 
bool isLocked () const
 
void setLocked (bool bVal)
 
OdCmEntityColor trueColor () const
 
OdDbStub * layer () const
 
OdDbStub * lineType () const
 
OdGiFillType fillType () const
 
OdDb::LineWeight lineWeight () const
 
double lineTypeScale () const
 
double thickness () const
 
OdDbStub * material () const
 
const OdGiMappermapper () const
 
OdDbStub * visualStyle () const
 
OdCmTransparency transparency () const
 
OdUInt32 drawFlags () const
 
bool selectionGeom () const
 
ShadowFlags shadowFlags () const
 
bool sectionable () const
 
SelectionFlags selectionFlags () const
 
void setTrueColor (const OdCmEntityColor &color)
 
void setColor (OdUInt16 color)
 
void setLineType (OdDbStub *lineTypeId)
 
void setLineWeight (OdDb::LineWeight lineWeight)
 
void setMaterial (OdDbStub *pMaterialId)
 
void setTransparency (const OdCmTransparency &transparency)
 
OdCmEntityColor secondaryTrueColor () const
 
const OdGiDgLinetypeModifierslineStyleModifiers () const
 
const OdGiFillfill () const
 
OdGiSubEntityTraitssubEntityTraits () const
 
OdGiGeometryrawGeometry () const
 
bool isDragging () const
 
OdGiContextcontext () const
 
void setContext (OdGiContext *pContext)
 
OdGeMatrix3d getModelToWorldTransform () const
 
OdGeMatrix3d getWorldToModelTransform () const
 
- Public Member Functions inherited from OdGiLayerTraits
 ODRX_DECLARE_MEMBERS (OdGiLayerTraits)
 
- Public Member Functions inherited from OdGiDrawableTraits
 ODRX_DECLARE_MEMBERS (OdGiDrawableTraits)
 
- Public Member Functions inherited from OdRxObject
 ODRX_HEAP_OPERATORS ()
 
 OdRxObject ()
 
virtual ~OdRxObject ()
 
virtual OdRxObjectqueryX (const OdRxClass *pClass) const
 
virtual OdRxObjectx (const OdRxClass *pClass) const
 
virtual OdRxClassisA () const
 
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
 
- Public Member Functions inherited from OdGiDummySubEntityTraits< OdGiSubEntityTraits >
void setColor (OdUInt16)
 
void setTrueColor (const OdCmEntityColor &)
 
void setLayer (OdDbStub *)
 
void setLineType (OdDbStub *)
 
void setSelectionMarker (OdGsMarker)
 
void setFillType (OdGiFillType)
 
void setFillPlane (const OdGeVector3d *=0)
 
void setLineWeight (OdDb::LineWeight)
 
void setLineTypeScale (double=1.0)
 
void setThickness (double)
 
void setPlotStyleName (OdDb::PlotStyleNameType, OdDbStub *=0)
 
void setMaterial (OdDbStub *)
 
void setMapper (const OdGiMapper *)
 
void setVisualStyle (const OdDbStub *)
 
void setTransparency (const OdCmTransparency &)
 
void setDrawFlags (OdUInt32)
 
void setSelectionGeom (bool)
 
void setShadowFlags (OdGiSubEntityTraits::ShadowFlags)
 
void setSectionable (bool)
 
void setSelectionFlags (OdGiSubEntityTraits::SelectionFlags)
 
OdUInt16 color () const
 
OdCmEntityColor trueColor () const
 
OdDbStub * layer () const
 
OdDbStub * lineType () const
 
OdGiFillType fillType () const
 
bool fillPlane (OdGeVector3d &)
 
OdDb::LineWeight lineWeight () const
 
double lineTypeScale () const
 
double thickness () const
 
OdDb::PlotStyleNameType plotStyleNameType () const
 
OdDbStub * plotStyleNameId () const
 
OdDbStub * material () const
 
const OdGiMappermapper () const
 
void addLight (const OdDbStub *)
 
OdCmTransparency transparency () const
 
OdUInt32 drawFlags () const
 
bool selectionGeom () const
 
OdGiSubEntityTraits::ShadowFlags shadowFlags () const
 
bool sectionable () const
 
OdGiSubEntityTraits::SelectionFlags selectionFlags () const
 
- Public Member Functions inherited from OdGiSubEntityTraits
 ODRX_DECLARE_MEMBERS (OdGiSubEntityTraits)
 
virtual void setSecondaryTrueColor (const OdCmEntityColor &color)
 
virtual void setLineStyleModifiers (const OdGiDgLinetypeModifiers *pLSMod)
 
virtual void setFill (const OdGiFill *pFill)
 
virtual bool pushLineweightOverride (const OdGiLineweightOverride *pOverride)
 
virtual void popLineweightOverride ()
 
virtual OdUInt32 setupForEntity () const
 
- Public Member Functions inherited from OdGiLayerTraitsData
 OdGiLayerTraitsData ()
 
void operator= (const OdGiLayerTraitsData &other)
 
OdUInt32 flags () const
 
OdDb::LineWeight lineweight () const
 
OdDbStub * linetype () const
 
OdDb::PlotStyleNameType plotStyleNameType () const
 
OdDbStub * plotStyleNameId () const
 
const OdCmEntityColortrueColor () const
 
OdDbStub * materialId () const
 
OdCmTransparency transparency () const
 
void setTrueColor (const OdCmEntityColor &cl)
 
void setLineweight (OdDb::LineWeight lw)
 
void setLinetype (OdDbStub *id)
 
void setMaterial (OdDbStub *id)
 
void setTransparency (const OdCmTransparency &transparency)
 
bool isOff () const
 
void setOff (bool bVal)
 
bool isPlottable () const
 
void setPlottable (bool bVal)
 
bool isLocked () const
 
void setLocked (bool bVal)
 
bool isFrozen () const
 
bool isByBlock () const
 
- Public Member Functions inherited from OdGiViewport
 ODRX_DECLARE_MEMBERS (OdGiViewport)
 
virtual const OdGiContextualColorscontextualColors () const
 

Protected Attributes

OdGsViewImplm_view
 

Additional Inherited Members

- Public Types inherited from OdGiLayerTraits
enum  {
  kByBlock = (OdGiDrawable::kLastFlag << 1) , kFrozen = (OdGiDrawable::kLastFlag << 2) , kOff = (OdGiDrawable::kLastFlag << 3) , kPlottable = (OdGiDrawable::kLastFlag << 4) ,
  kLocked = (OdGiDrawable::kLastFlag << 5)
}
 
- 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
}
 
- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClassdesc ()
 
- Public Attributes inherited from OdGiLayerTraitsData
OdUInt32 m_flags
 
OdDb::LineWeight m_lineweight
 
OdDb::PlotStyleNameType m_plotStyleNameType
 
OdCmEntityColor m_color
 
OdDbStub * m_linetypeId
 
OdDbStub * m_plotStyleNameId
 
OdDbStub * m_materialId
 
OdCmTransparency m_cmTransparency
 
- Protected Member Functions inherited from OdGiLayerTraitsTaker
 ODRX_USING_HEAP_OPERATORS (OdGiDummyWorldDraw< OdGiDummyWorldGeometry< OdGiWorldDraw_ > >)
 
- Protected Member Functions inherited from OdGiLayerTraits_
OdCmEntityColor color () const
 
- Protected Member Functions inherited from OdGiSubEntityTraits_
OdUInt16 color () const
 

Detailed Description

This is a helper class to substitute OdGiLayerTraitsTaker in OdGsBaseModel::propagateLayerChanges() where vectorizers are not available to be set by setRefView(), and not actually required. <group OdGs_Classes>

Definition at line 188 of file GsLayerNode.h.

Constructor & Destructor Documentation

◆ OdGiLayerTraitsTakerView()

OdGiLayerTraitsTakerView::OdGiLayerTraitsTakerView ( OdGsViewImpl view)
inline

Definition at line 192 of file GsLayerNode.h.

Member Function Documentation

◆ acadWindowId()

virtual OdInt16 OdGiLayerTraitsTakerView::acadWindowId ( ) const
inlinevirtual

Returns the ID for this Viewport object..

Remarks
The value returned corresponds to the CVPORT system variable.

Implements OdGiViewport.

Definition at line 215 of file GsLayerNode.h.

◆ addRef()

virtual void OdGiLayerTraitsTakerView::addRef ( )
inlinevirtual

OdRxObject methods

Reimplemented from OdGiLayerTraitsTaker.

Definition at line 234 of file GsLayerNode.h.

◆ context()

virtual OdGiContext* OdGiLayerTraitsTakerView::context ( ) const
inlinevirtual

Definition at line 243 of file GsLayerNode.h.

◆ deviation()

virtual double OdGiLayerTraitsTakerView::deviation ( const OdGiDeviationType  type,
const OdGePoint3d pt 
) const
inlinevirtual

OdGiCommonDraw methods

Reimplemented from OdGiLayerTraitsTaker.

Definition at line 238 of file GsLayerNode.h.

◆ doInversePerspective()

virtual bool OdGiLayerTraitsTakerView::doInversePerspective ( OdGePoint3d point) const
inlinevirtual

Applies the inverse of the current perspective transformation to the specified point.

Parameters
point[in/out] Any 3D point.
Remarks
The point is transformed from normalized device coordinates to EyeSpace coordinates

Returns true if and only if the point was transformed; i.e., a perspective transform is active, and the point was neither too close or behind the camera.

See also
Coordinate Systems

Implements OdGiViewport.

Definition at line 207 of file GsLayerNode.h.

◆ doPerspective()

virtual bool OdGiLayerTraitsTakerView::doPerspective ( OdGePoint3d point) const
inlinevirtual

Applies the current perspective transformation to the specified point.

Parameters
point[in/out] Any 3D point.
Remarks
The point is transformed from EyeSpace coordinates to normalized device coordinates.

Returns true if and only if the point was transformed; i.e., a perspective transform is active, and the point was neither too close or behind the camera.

See also
Coordinate Systems

Implements OdGiViewport.

Definition at line 206 of file GsLayerNode.h.

◆ getCameraLocation()

virtual OdGePoint3d OdGiLayerTraitsTakerView::getCameraLocation ( ) const
inlinevirtual

Returns the WCS camera (eye) location for this Viewport object.

Implements OdGiViewport.

Definition at line 210 of file GsLayerNode.h.

◆ getCameraTarget()

virtual OdGePoint3d OdGiLayerTraitsTakerView::getCameraTarget ( ) const
inlinevirtual

Returns the WCS camera target for this Viewport object.

Implements OdGiViewport.

Definition at line 211 of file GsLayerNode.h.

◆ getCameraUpVector()

virtual OdGeVector3d OdGiLayerTraitsTakerView::getCameraUpVector ( ) const
inlinevirtual

Returns the WCS camera "up" vector for this Viewport object.

Implements OdGiViewport.

Definition at line 212 of file GsLayerNode.h.

◆ getEyeToModelTransform()

virtual OdGeMatrix3d OdGiLayerTraitsTakerView::getEyeToModelTransform ( ) const
inlinevirtual

Returns the transformation matrix from EyeSpace to ModelSpace for this Viewport object.

See also
Coordinate Systems

Implements OdGiViewport.

Definition at line 202 of file GsLayerNode.h.

◆ getEyeToWorldTransform()

virtual OdGeMatrix3d OdGiLayerTraitsTakerView::getEyeToWorldTransform ( ) const
inlinevirtual

Returns the transformation matrix from EyeSpace to WCS for this Viewport object.

See also
Coordinate Systems

Implements OdGiViewport.

Definition at line 204 of file GsLayerNode.h.

◆ getFrontAndBackClipValues()

virtual bool OdGiLayerTraitsTakerView::getFrontAndBackClipValues ( bool &  clipFront,
bool &  clipBack,
double &  front,
double &  back 
) const
inlinevirtual

Returns the front and back clipping parameters for this Viewport object.

Parameters
clipFront[out] Receives true if and only if front clipping is enabled.
clipBack[out] Receives true if and only if back clipping is enabled.
front[out] Receives the front clipping distance.
back[out] Receives the back clipping distance.
Remarks
Returns clipFront || clipBack.

front and back are the eye coordinate Z values.

Clipping planes are perpendicular to the view direction.

If the front clipping plane is enabled, geometry in front of it is not displayed.

If the back clipping plane is enabled, geometry in back of it is not displayed.

Implements OdGiViewport.

Definition at line 222 of file GsLayerNode.h.

◆ getModelToEyeTransform()

virtual OdGeMatrix3d OdGiLayerTraitsTakerView::getModelToEyeTransform ( ) const
inlinevirtual

OdGiViewport methods

Implements OdGiViewport.

Definition at line 201 of file GsLayerNode.h.

◆ getNumPixelsInUnitSquare()

virtual void OdGiLayerTraitsTakerView::getNumPixelsInUnitSquare ( const OdGePoint3d point,
OdGePoint2d pixelDensity,
bool  bUsePerspective = true 
) const
inlinevirtual

Returns the display pixel density at the specified point for this Viewport object.

Parameters
point[in] WCS center of the unit square.
pixelDensity[out] Receives the pixel density.
bUsePerspective[in] Enable perspective inclusion into pixel density calculation.
Remarks
Pixel density is measured in pixels per WCS unit.

This function can be used to determine if the geometry generated for an object will be smaller than the size of a pixel.

Implements OdGiViewport.

Definition at line 208 of file GsLayerNode.h.

◆ getViewportDcCorners()

virtual void OdGiLayerTraitsTakerView::getViewportDcCorners ( OdGePoint2d lowerLeft,
OdGePoint2d upperRight 
) const
inlinevirtual

Returns lower-left and upper-right corners of this Viewport object in normalized device Coordinates.

Parameters
lowerLeft[out] Receives the lower-left corner.
upperRight[out] Receives the upper-right.
Remarks
This information lets position items that are fixed in size and/or position with respect to a Viewport.
See also
Coordinate Systems

Implements OdGiViewport.

Definition at line 220 of file GsLayerNode.h.

◆ getWorldToEyeTransform()

virtual OdGeMatrix3d OdGiLayerTraitsTakerView::getWorldToEyeTransform ( ) const
inlinevirtual

Returns the transformation matrix from WCS to EyeSpace for this Viewport object.

See also
Coordinate Systems

Implements OdGiViewport.

Definition at line 203 of file GsLayerNode.h.

◆ isPerspective()

virtual bool OdGiLayerTraitsTakerView::isPerspective ( ) const
inlinevirtual

Returns true if and only if perspective mode is on for this Viewport.

Implements OdGiViewport.

Definition at line 205 of file GsLayerNode.h.

◆ isValidId()

bool OdGiLayerTraitsTakerView::isValidId ( const OdUInt32  acgiId) const
inlinevirtual

Reimplemented from OdGiLayerTraitsTaker.

Definition at line 197 of file GsLayerNode.h.

◆ layerVisible()

virtual bool OdGiLayerTraitsTakerView::layerVisible ( OdDbStub *  layerId) const
inlinevirtual

Returns true if and only if the specified layer is not frozen either globally or in this Viewport object.

Parameters
layerId[in] Object ID of OdLayerTableRecord.

Implements OdGiViewport.

Definition at line 231 of file GsLayerNode.h.

◆ linetypeGenerationCriteria()

virtual double OdGiLayerTraitsTakerView::linetypeGenerationCriteria ( ) const
inlinevirtual

Returns the WCS value below which linetype generation is not used.

Remarks
If the WCS length an entire linetype pattern is less than the returned value, then the linetype will be rendered as continuous.

Implements OdGiViewport.

Definition at line 230 of file GsLayerNode.h.

◆ linetypeScaleMultiplier()

virtual double OdGiLayerTraitsTakerView::linetypeScaleMultiplier ( ) const
inlinevirtual

Returns a multiplier that is used to scale all linetypes in this Viewport object.

Implements OdGiViewport.

Definition at line 229 of file GsLayerNode.h.

◆ numberOfIsolines()

virtual OdUInt32 OdGiLayerTraitsTakerView::numberOfIsolines ( ) const
inlinevirtual

Reimplemented from OdGiLayerTraitsTaker.

Definition at line 240 of file GsLayerNode.h.

◆ regenAbort()

virtual bool OdGiLayerTraitsTakerView::regenAbort ( ) const
inlinevirtual

Reimplemented from OdGiLayerTraitsTaker.

Definition at line 242 of file GsLayerNode.h.

◆ regenType()

virtual OdGiRegenType OdGiLayerTraitsTakerView::regenType ( ) const
inlinevirtual

Reimplemented from OdGiLayerTraitsTaker.

Definition at line 241 of file GsLayerNode.h.

◆ release()

virtual void OdGiLayerTraitsTakerView::release ( )
inlinevirtual

Declares the method decrementing the reference counter in objects derived from this class.

Remarks
It is the pure virtual method that does not have an implementation. You must redefine it in the derived class.
See also
<link smart_pointers_overview.html, Overview of Smart Pointer Classes>

Reimplemented from OdGiLayerTraitsTaker.

Definition at line 235 of file GsLayerNode.h.

◆ sequenceNumber()

OdUInt32 OdGiLayerTraitsTakerView::sequenceNumber ( ) const
inlinevirtual

Reimplemented from OdGiLayerTraitsTaker.

Definition at line 196 of file GsLayerNode.h.

◆ viewDir()

virtual OdGeVector3d OdGiLayerTraitsTakerView::viewDir ( ) const
inlinevirtual

Returns the vector from the camera target to the camera location.

Implements OdGiViewport.

Definition at line 213 of file GsLayerNode.h.

◆ viewport()

OdGiViewport& OdGiLayerTraitsTakerView::viewport ( ) const
inlinevirtual

OdGiViewportDraw methods

Reimplemented from OdGiLayerTraitsTaker.

Definition at line 195 of file GsLayerNode.h.

◆ viewportId()

virtual OdUInt32 OdGiLayerTraitsTakerView::viewportId ( ) const
inlinevirtual

Returns the OdGi Viewport ID for this Viewport object.

Remarks
The value returned has no relationshp to the CVPORT system variable.

Implements OdGiViewport.

Definition at line 214 of file GsLayerNode.h.

◆ viewportObjectId()

OdDbStub* OdGiLayerTraitsTakerView::viewportObjectId ( ) const
inlinevirtual

Reimplemented from OdGiLayerTraitsTaker.

Definition at line 198 of file GsLayerNode.h.

Member Data Documentation

◆ m_view

OdGsViewImpl& OdGiLayerTraitsTakerView::m_view
protected

Definition at line 245 of file GsLayerNode.h.


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