CFx SDK Documentation  2023 SP0
Public Types | Public Member Functions | List of all members
OdGiConveyorContext Class Referenceabstract

#include <GiConveyorGeometry.h>

Inheritance diagram for OdGiConveyorContext:
OdGiBaseVectorizer OdGiConveyorContextWrapper AECGe::Harvester OdGiBaseVectorizerImpl OdGiExtCalc AECGe::HarvesterOverall OdGsBaseVectorizer OdGsBaseVectorizeViewJoin< OdGsBaseVectorizer > OdGsBaseMaterialVectorizer OdGsBaseVectorizeViewJoinMT< OdGsBaseVectorizer > OdGsBaseVectorizeViewDef OdGsBaseMaterialViewPC OdGsBaseVectorizeViewMT OdGsBaseVectorizeViewJoin< OdGsBaseMaterialViewPC > OdGsBaseVectorizeViewJoinMT< OdGsBaseMaterialViewPC > OdGsBaseMaterialView OdGsBaseMaterialViewMT

Public Types

enum  ConveyorContextFlags {
  kSpatialFilterSimplPline = 1 , kSpatialFilterSimplNurbs = 2 , kSpatialFilterSimplText = 4 , kSpatialFilterSimplShape = 8 ,
  kSpatialFilterSimplAll , kEmbranchmentSimplText = 16 , kEmbranchmentSimplNurbs = 32 , kEmbranchmentSimplAll = (kEmbranchmentSimplText | kEmbranchmentSimplNurbs) ,
  kConveyorSimplAll = (kSpatialFilterSimplAll | kEmbranchmentSimplAll) , kPlineMarkers = 64 , kForceMarkersOnModified = 128 , kPolylineMarkers = 256 ,
  kPlineAllowArcProc = 512 , kTestMode = 1024 , kLineTyperAfterMetafile = 2048
}
 

Public Member Functions

virtual ~OdGiConveyorContext ()
 
virtual OdGiContext & giContext () const =0
 
virtual OdGiSubEntityTraits & subEntityTraits () const =0
 
virtual const OdGiSubEntityTraitsData & effectiveTraits () const =0
 
virtual void setEffectiveTraits (const OdGiSubEntityTraitsData &traits, const OdGeVector3d *fillNormal=NULL)=0
 
virtual bool effectivelyVisible () const
 
virtual const OdGiDrawableDesc * currentDrawableDesc () const =0
 
virtual const OdGiDrawable * currentDrawable () const =0
 
virtual const OdGiViewport * giViewport () const =0
 
virtual const OdGsView * gsView () const =0
 
virtual void onTraitsModified ()=0
 
virtual void onTextProcessing (const OdGePoint3d &, const OdGeVector3d &, const OdGeVector3d &)
 
virtual bool regenAbort () const =0
 
virtual const OdGiPathNode * currentGiPath () const =0
 
virtual const OdGiDeviation & worldDeviation () const =0
 
virtual const OdGiDeviation & modelDeviation () const =0
 
virtual const OdGiDeviation & eyeDeviation () const =0
 
virtual OdGeMatrix3d getModelToWorldTransform () const =0
 
virtual OdGeMatrix3d getWorldToModelTransform () const =0
 
virtual const OdGiLineweightOverride * currentLineweightOverride () const
 
virtual OdUInt32 drawContextFlags () const
 
virtual double annotationScale () const
 

Detailed Description

This class implements an interface that allows conveyor nodes to interact with parent objects.

Remarks
This interface gives abstract access to OdGiBaseVectorizer level data and services. Many conveyor nodes require a pointer to an OdGiConveyorContext interface, in order to be initialized.

Corresponding C++ library: TD_Gi <group OdGi_Classes>

Definition at line 53 of file GiConveyorGeometry.h.

Member Enumeration Documentation

◆ ConveyorContextFlags

enum OdGiConveyorContext::ConveyorContextFlags
Enumerator
kSpatialFilterSimplPline 
kSpatialFilterSimplNurbs 
kSpatialFilterSimplText 
kSpatialFilterSimplShape 
kSpatialFilterSimplAll 
kEmbranchmentSimplText 
kEmbranchmentSimplNurbs 
kEmbranchmentSimplAll 
kConveyorSimplAll 
kPlineMarkers 
kForceMarkersOnModified 
kPolylineMarkers 
kPlineAllowArcProc 
kTestMode 
kLineTyperAfterMetafile 

Definition at line 186 of file GiConveyorGeometry.h.

Constructor & Destructor Documentation

◆ ~OdGiConveyorContext()

virtual OdGiConveyorContext::~OdGiConveyorContext ( )
inlinevirtual

Definition at line 56 of file GiConveyorGeometry.h.

Member Function Documentation

◆ annotationScale()

virtual double OdGiConveyorContext::annotationScale ( ) const
inlinevirtual

Returns current annotationScale value of conveyor context.

Reimplemented in OdGiBaseVectorizerImpl.

Definition at line 220 of file GiConveyorGeometry.h.

◆ currentDrawable()

virtual const OdGiDrawable* OdGiConveyorContext::currentDrawable ( ) const
pure virtual

Returns the current OdGiDrawable object for this ConveyorContext object.

Remarks
This is the object currently being vectorized by the framework.

Implemented in OdGiConveyorContextWrapper, and OdGiBaseVectorizer.

◆ currentDrawableDesc()

virtual const OdGiDrawableDesc* OdGiConveyorContext::currentDrawableDesc ( ) const
pure virtual

Returns the current OdGiDrawableDesc instance for this ConveyorContext object.

Remarks
This instance contains information about the current drawable object (the object itself, rendering flags, etc.).

Implemented in OdGiConveyorContextWrapper, and OdGiBaseVectorizer.

◆ currentGiPath()

virtual const OdGiPathNode* OdGiConveyorContext::currentGiPath ( ) const
pure virtual

Returns current drawable nesting graph.

Implemented in OdGiConveyorContextWrapper, and OdGiBaseVectorizer.

◆ currentLineweightOverride()

virtual const OdGiLineweightOverride* OdGiConveyorContext::currentLineweightOverride ( ) const
inlinevirtual

Returns current lineweight override (if present).

Reimplemented in OdGiBaseVectorizerImpl, and OdGiConveyorContextWrapper.

Definition at line 184 of file GiConveyorGeometry.h.

◆ drawContextFlags()

virtual OdUInt32 OdGiConveyorContext::drawContextFlags ( ) const
inlinevirtual

Returns set of conveyor context flags.

Reimplemented in OdGiConveyorContextWrapper, and OdGiBaseVectorizer.

Definition at line 215 of file GiConveyorGeometry.h.

◆ effectivelyVisible()

virtual bool OdGiConveyorContext::effectivelyVisible ( ) const
inlinevirtual

Checks the current visibility state for current traits.

Reimplemented in OdGiConveyorContextWrapper, and OdGiBaseVectorizer.

Definition at line 88 of file GiConveyorGeometry.h.

◆ effectiveTraits()

virtual const OdGiSubEntityTraitsData& OdGiConveyorContext::effectiveTraits ( ) const
pure virtual

Returns the traits currently in effect for this ConveyorContext object.

Implemented in OdGiConveyorContextWrapper, OdGiExtCalc, and OdGiBaseVectorizer.

◆ eyeDeviation()

virtual const OdGiDeviation& OdGiConveyorContext::eyeDeviation ( ) const
pure virtual

Returns deviations array accessor for eye coordinate system.

Implemented in OdGiConveyorContextWrapper, and OdGiBaseVectorizer.

◆ getModelToWorldTransform()

virtual OdGeMatrix3d OdGiConveyorContext::getModelToWorldTransform ( ) const
pure virtual

Returns the model-to-world coordinate transform matrix for the entity being vectorized.

Remarks
This is the inverse of the matrix returned by getWorldToModelTransform().

If an entity is in one or more blocks, this matrix can be used to determine the WCS coordinates of the entity.

Implemented in OdGiBaseVectorizerImpl, OdGiConveyorContextWrapper, and OdGiBaseVectorizer.

◆ getWorldToModelTransform()

virtual OdGeMatrix3d OdGiConveyorContext::getWorldToModelTransform ( ) const
pure virtual

Returns the world-to-model coordinate transform matrix for the entity being vectorized.

Remarks
This is the inverse of the matrix returned by getModelToWorldTransform().

Implemented in OdGiBaseVectorizerImpl, OdGiConveyorContextWrapper, and OdGiBaseVectorizer.

◆ giContext()

virtual OdGiContext& OdGiConveyorContext::giContext ( ) const
pure virtual

Returns the OdGiContext object associated with this ConveyorContext object.

Implemented in OdGiConveyorContextWrapper, and OdGiBaseVectorizer.

◆ giViewport()

virtual const OdGiViewport* OdGiConveyorContext::giViewport ( ) const
pure virtual

Returns the OdGiViewport associated with this ConveyorContext object.

Implemented in OdGiBaseVectorizerImpl, OdGiConveyorContextWrapper, and OdGiBaseVectorizer.

◆ gsView()

virtual const OdGsView* OdGiConveyorContext::gsView ( ) const
pure virtual

Returns the OdGsView associated with this ConveyorContext object.

Implemented in OdGiBaseVectorizerImpl, OdGiConveyorContextWrapper, and OdGiBaseVectorizer.

◆ modelDeviation()

virtual const OdGiDeviation& OdGiConveyorContext::modelDeviation ( ) const
pure virtual

Returns deviations array accessor for model coordinate system.

Implemented in OdGiConveyorContextWrapper, and OdGiBaseVectorizer.

◆ onTextProcessing()

virtual void OdGiConveyorContext::onTextProcessing ( const OdGePoint3d &  ,
const OdGeVector3d &  ,
const OdGeVector3d &   
)
inlinevirtual

Notification function called by the vectorization framework whenever the text is become to be rendered.

Remarks
This function provides a hook for setting geometry transformation before text was drawn.

Reimplemented in OdGiConveyorContextWrapper.

Definition at line 135 of file GiConveyorGeometry.h.

◆ onTraitsModified()

virtual void OdGiConveyorContext::onTraitsModified ( )
pure virtual

Notification function called by the vectorization framework whenever the rendering attributes have changed.

Remarks
This function is called before sending any geometry through the geometry conveyor.

This function provides a hook for setting rendering attributes for the final geometry handler (e.g. Win GDI device).

Implemented in OdGsBaseVectorizer, OdGsBaseMaterialVectorizer, OdGiBaseVectorizerImpl, OdGiConveyorContextWrapper, and OdGiBaseVectorizer.

◆ regenAbort()

virtual bool OdGiConveyorContext::regenAbort ( ) const
pure virtual

Returns true if and only if regen was aborted.

Implemented in OdGsBaseVectorizer, OdGiConveyorContextWrapper, OdGiExtCalc, and OdGiBaseVectorizer.

◆ setEffectiveTraits()

virtual void OdGiConveyorContext::setEffectiveTraits ( const OdGiSubEntityTraitsData &  traits,
const OdGeVector3d *  fillNormal = NULL 
)
pure virtual

Sets the traits currently in effect for this ConveyorContext object.

Parameters
traits[in] New traits data which will be used for effective traits substitution.
fillNormal[in] Optional fill normal.

Implemented in OdGiConveyorContextWrapper, and OdGiBaseVectorizer.

◆ subEntityTraits()

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

Returns the OdGiSubEntityTraits instance associated with this ConveyorContext object.

Remarks
The OdGiSubEntityTraits object is used to register attribute changes with the vectorization framework.

Implemented in OdGiConveyorContextWrapper, and OdGiBaseVectorizer.

◆ worldDeviation()

virtual const OdGiDeviation& OdGiConveyorContext::worldDeviation ( ) const
pure virtual

Returns deviations array accessor for world coordinate system.

Implemented in OdGiConveyorContextWrapper, and OdGiBaseVectorizer.

The documentation for this class was generated from the following file:
Generated on Thu Feb 24 2022 15:10:59