CFx SDK Documentation 2024 SP0
Loading...
Searching...
No Matches
Public Member Functions | List of all members
OdGiCommonDraw Class Referenceabstract

#include <GiCommonDraw.h>

Inheritance diagram for OdGiCommonDraw:
OdRxObject OdGiViewportDraw OdGiWorldDraw OdGiDummyCommonDraw< OdGiViewportDraw > OdGiWrapperCommonDraw< OdGiViewportDraw > OdGiViewportDraw_ OdGiDummyCommonDraw< OdGiWorldDraw > OdGiWrapperCommonDraw< OdGiWorldDraw > OdGiWorldDraw_ OdGiDummyGeometry< OdGiViewportDraw_ > OdGiWrapperGeometry< OdGiViewportDraw_ > OdGiBaseVectorizer OdGiDummyCommonDraw< OdGiWorldDraw_ > OdGiDummyGeometry< OdGiWorldDraw_ > AECGe::Harvester OdGiBaseVectorizerImpl OdGiExtCalc OdGiWorldDrawImpl AECGe::HarvesterOverall OdGsBaseVectorizer OdGiBaseVectorizer OdGsBaseVectorizeViewJoin< OdGsBaseVectorizer > OdGsBaseMaterialVectorizer AECGe::Harvester OdGiBaseVectorizerImpl OdGiExtCalc OdGsBaseVectorizeViewDef OdGsBaseMaterialViewPC AECGe::HarvesterOverall OdGsBaseVectorizer OdGsBaseVectorizeViewJoin< OdGsBaseMaterialViewPC > OdGsBaseVectorizeViewJoin< OdGsBaseVectorizer > OdGsBaseMaterialVectorizer OdGsBaseMaterialView OdGsBaseVectorizeViewDef OdGsBaseMaterialViewPC OdGsBaseVectorizeViewJoin< OdGsBaseMaterialViewPC > OdGsBaseMaterialView

Public Member Functions

 ODRX_DECLARE_MEMBERS (OdGiCommonDraw)
 
virtual OdGiRegenType regenType () const =0
 
virtual bool regenAbort () const =0
 
virtual OdGiSubEntityTraitssubEntityTraits () const =0
 
virtual OdGiGeometryrawGeometry () const =0
 
virtual bool isDragging () const =0
 
virtual double deviation (const OdGiDeviationType deviationType, const OdGePoint3d &pointOnCurve) const =0
 
virtual OdUInt32 numberOfIsolines () const =0
 
virtual OdGiContextcontext () const =0
 
virtual const OdGiPathNodecurrentGiPath () const
 
virtual bool displayModelerSilhouettes () const
 
- 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 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 OdRxClassdesc ()
 

Detailed Description

This class is the base class for entity-level vectorization within the ODA Platform.

See also
TD_Gi

<group OdGi_Classes>

Definition at line 765 of file GiCommonDraw.h.

Member Function Documentation

◆ context()

virtual OdGiContext * OdGiCommonDraw::context ( ) const
pure virtual

Retrieves context associated with this object.

Returns
Pointer to the associated context.

Implemented in OdGiWorldDrawImpl, OdGiBaseVectorizer, OdGiWrapperCommonDraw< OdGiViewportDraw >, and OdGiWrapperCommonDraw< OdGiWorldDraw >.

◆ currentGiPath()

virtual const OdGiPathNode * OdGiCommonDraw::currentGiPath ( ) const
virtual

Retrieves the current drawable nesting graph.

Returns
current drawable nesting graph.

Reimplemented in OdGiBaseVectorizer, OdGiWorldDraw_, OdGiViewportDraw_, OdGiWrapperCommonDraw< OdGiViewportDraw >, and OdGiWrapperCommonDraw< OdGiWorldDraw >.

◆ deviation()

virtual double OdGiCommonDraw::deviation ( const OdGiDeviationType  deviationType,
const OdGePoint3d pointOnCurve 
) const
pure virtual

Retrieves the recommended maximum deviation of the current vectorization for the specified point on a curve.

Parameters
deviationType[in] Deviation type.
pointOnCurve[in] Point on a curve.
Returns
recommended maximum difference (with respect to the current active viewport) between the actual curve or surface, and the tessellated curve or surface.
Remarks
deviationType must be one of the following:

Value kOdGiMaxDevForCircle 0
kOdGiMaxDevForCurve 1
kOdGiMaxDevForBoundary 2
kOdGiMaxDevForIsoline 3 kOdGiMaxDevForFacet 4

Remarks
This method uses circle zoom percent as appropriate.

Implemented in OdGiBaseVectorizer, OdGiBaseVectorizerImpl, OdGsBaseVectorizer, OdGiWrapperCommonDraw< OdGiViewportDraw >, OdGiWrapperCommonDraw< OdGiWorldDraw >, OdGiDummyCommonDraw< OdGiViewportDraw >, OdGiDummyCommonDraw< OdGiWorldDraw_ >, and OdGiDummyCommonDraw< OdGiWorldDraw >.

◆ displayModelerSilhouettes()

virtual bool OdGiCommonDraw::displayModelerSilhouettes ( ) const
virtual

Checks whether silhouette curves should be generated (basically should return OdDbDatabase::getDISPSILH, but the behavior could be specialized).

Returns
true if silhouette curves should be generated, false otherwise.

Reimplemented in OdGiWrapperCommonDraw< OdGiViewportDraw >, and OdGiWrapperCommonDraw< OdGiWorldDraw >.

◆ isDragging()

virtual bool OdGiCommonDraw::isDragging ( ) const
pure virtual

Checks whether this vectorization process is the result of a "drag" operation.

Returns
true if this vectorization process is the result of a "drag" operation, false otherwise.

Implemented in OdGiBaseVectorizer, OdGiWrapperCommonDraw< OdGiViewportDraw >, OdGiWrapperCommonDraw< OdGiWorldDraw >, OdGiDummyCommonDraw< OdGiViewportDraw >, OdGiDummyCommonDraw< OdGiWorldDraw_ >, OdGiDummyCommonDraw< OdGiWorldDraw >, and OdGsBaseVectorizer.

◆ numberOfIsolines()

virtual OdUInt32 OdGiCommonDraw::numberOfIsolines ( ) const
pure virtual

Retrieves the number of isolines to be drawn on surfaces during this vectorization.

Returns
number of isolines.
Remarks
Isolines are lines or curves which are used to represent the entity. For example, if an entity is a sphere and this method returns 3, the sphere should be displayed as 3 circles with a common center and planes that are perpendicular to each other.

Implemented in OdGiWorldDrawImpl, OdGiBaseVectorizer, OdGiWrapperCommonDraw< OdGiViewportDraw >, OdGiWrapperCommonDraw< OdGiWorldDraw >, OdGiDummyCommonDraw< OdGiViewportDraw >, OdGiDummyCommonDraw< OdGiWorldDraw_ >, and OdGiDummyCommonDraw< OdGiWorldDraw >.

◆ ODRX_DECLARE_MEMBERS()

OdGiCommonDraw::ODRX_DECLARE_MEMBERS ( OdGiCommonDraw  )

◆ rawGeometry()

virtual OdGiGeometry & OdGiCommonDraw::rawGeometry ( ) const
pure virtual

Provides access to this object's "drawing interface."

Remarks
The "drawing interface" is a set of geometry functions used during the vectorization process.

Implemented in OdGiWorldDrawImpl, OdGiBaseVectorizer, OdGiWrapperCommonDraw< OdGiViewportDraw >, and OdGiWrapperCommonDraw< OdGiWorldDraw >.

◆ regenAbort()

virtual bool OdGiCommonDraw::regenAbort ( ) const
pure virtual

◆ regenType()

virtual OdGiRegenType OdGiCommonDraw::regenType ( ) const
pure virtual

Retrieves the regeneration type of the current vectorization process.

Returns
one of the following regeneration types:

Value eOdGiRegenTypeInvalid 0 kOdGiStandardDisplay 2 kOdGiHideOrShadeCommand 3 kOdGiRenderCommand 4 kOdGiForExplode 5 kOdGiSaveWorldDrawForProxy 6 kOdGiForExtents 7

Implemented in AECGe::Harvester, OdGiBaseVectorizer, OdGiExtCalc, OdGiWrapperCommonDraw< OdGiViewportDraw >, OdGiWrapperCommonDraw< OdGiWorldDraw >, OdGiDummyCommonDraw< OdGiViewportDraw >, OdGiDummyCommonDraw< OdGiWorldDraw_ >, OdGiDummyCommonDraw< OdGiWorldDraw >, and OdGiBaseVectorizerImpl.

◆ subEntityTraits()

virtual OdGiSubEntityTraits & OdGiCommonDraw::subEntityTraits ( ) const
pure virtual

Provides access to this object's subentity traits.

Returns
sub-entity traits.
Remarks
This allows the modification of the vectorization attributes such as color, linetype, etc.

Implemented in OdGiWorldDrawImpl, OdGiBaseVectorizer, OdGiWrapperCommonDraw< OdGiViewportDraw >, and OdGiWrapperCommonDraw< OdGiWorldDraw >.


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