CFx SDK Documentation 2024 SP0
Loading...
Searching...
No Matches
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 OdGsBaseVectorizeViewDef OdGsBaseMaterialViewPC OdGsBaseVectorizeViewJoin< OdGsBaseMaterialViewPC > OdGsBaseMaterialView

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 54 of file GiConveyorGeometry.h.

Member Enumeration Documentation

◆ ConveyorContextFlags

enum OdGiConveyorContext::ConveyorContextFlags

Conveyor geometry context flags.

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

Definition at line 243 of file GiConveyorGeometry.h.

Constructor & Destructor Documentation

◆ ~OdGiConveyorContext()

virtual OdGiConveyorContext::~OdGiConveyorContext ( )
inlinevirtual

Destructor for the OdGiConveyorContext class.

Definition at line 60 of file GiConveyorGeometry.h.

Member Function Documentation

◆ annotationScale()

virtual double OdGiConveyorContext::annotationScale ( ) const
inlinevirtual

Retrieves current annotationScale value of conveyor context.

Returns
annotation scale as double value.

Reimplemented in OdGiBaseVectorizerImpl.

Definition at line 283 of file GiConveyorGeometry.h.

◆ currentDrawable()

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

Retrieves the current OdGiDrawable object for this ConveyorContext object.

Returns
pointer to an instance of OdGiDrawable that represents a drawable.
Remarks
This is the object currently being vectorized by the framework.

Implemented in OdGiBaseVectorizer, and OdGiConveyorContextWrapper.

◆ currentDrawableDesc()

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

Retrieves the current OdGiDrawableDesc instance for this ConveyorContext object.

Returns
pointer to an instance of OdGiDrawableDesc that provides information about a drawable.
Remarks
This instance contains information about the current drawable object (the object itself, rendering flags, etc.).

Implemented in OdGiBaseVectorizer, and OdGiConveyorContextWrapper.

◆ currentGiPath()

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

Retrieves current drawable nesting graph.

Returns
pointer to the OdGiPathNode instance.

Implemented in OdGiBaseVectorizer, and OdGiConveyorContextWrapper.

◆ currentLineweightOverride()

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

Retrieves current lineweight override (if present).

Returns
pointer to the OdGiLineweightOverride instance.

Reimplemented in OdGiConveyorContextWrapper, and OdGiBaseVectorizerImpl.

Definition at line 238 of file GiConveyorGeometry.h.

◆ drawContextFlags()

virtual OdUInt32 OdGiConveyorContext::drawContextFlags ( ) const
inlinevirtual

Retrieves set of conveyor context flags.

Returns
context flags as OdUInt32 value.

Reimplemented in OdGiBaseVectorizer, and OdGiConveyorContextWrapper.

Definition at line 275 of file GiConveyorGeometry.h.

◆ effectivelyVisible()

virtual bool OdGiConveyorContext::effectivelyVisible ( ) const
inlinevirtual

Checks the current visibility state for current traits.

Returns
true if effective traits are visible, false otherwise.

Reimplemented in OdGiBaseVectorizer, and OdGiConveyorContextWrapper.

Definition at line 104 of file GiConveyorGeometry.h.

◆ effectiveTraits()

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

Retrieves the traits currently in effect for this ConveyorContext object.

Returns
effective traits as OdGiSubEntityTraitsData object.

Implemented in OdGiBaseVectorizer, OdGiExtCalc, OdGiConveyorContextWrapper, and OdGiBaseVectorizerImpl.

◆ eyeDeviation()

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

Retrieves deviations array accessor for eye coordinate system.

Returns
the OdGiDeviation instance that represents eye deviation.

Implemented in OdGiBaseVectorizer, and OdGiConveyorContextWrapper.

◆ getModelToWorldTransform()

virtual OdGeMatrix3d OdGiConveyorContext::getModelToWorldTransform ( ) const
pure virtual

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

Returns
model-to-world coordinate transform matrix.
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 OdGiBaseVectorizer, OdGiConveyorContextWrapper, and OdGiBaseVectorizerImpl.

◆ getWorldToModelTransform()

virtual OdGeMatrix3d OdGiConveyorContext::getWorldToModelTransform ( ) const
pure virtual

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

Returns
world-to-model coordinate transform matrix.
Remarks
This is the inverse of the matrix returned by getModelToWorldTransform().

Implemented in OdGiBaseVectorizer, OdGiConveyorContextWrapper, and OdGiBaseVectorizerImpl.

◆ giContext()

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

Retrieves the OdGiContext object associated with this ConveyorContext object.

Returns
a reference to the corresponding OdGiContext object.

Implemented in OdGiBaseVectorizer, and OdGiConveyorContextWrapper.

◆ giViewport()

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

Retrieves the OdGiViewport associated with this ConveyorContext object.

Returns
pointer to an instance of OdGiViewport that represents a viewport.

Implemented in OdGiBaseVectorizer, OdGiConveyorContextWrapper, and OdGiBaseVectorizerImpl.

◆ gsView()

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

Retrieves the OdGsView associated with this ConveyorContext object.

Returns
pointer to an instance of OdGsView that represents a view.
See also
<link tv_working_with_base_classes_view, Work with Visualize Graphical Views>

Implemented in OdGiBaseVectorizer, OdGiConveyorContextWrapper, and OdGiBaseVectorizerImpl.

◆ modelDeviation()

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

Retrieves deviations array accessor for model coordinate system.

Returns
the OdGiDeviation instance that represents model deviation.

Implemented in OdGiBaseVectorizer, and OdGiConveyorContextWrapper.

◆ 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 165 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 OdGiBaseVectorizer, OdGiConveyorContextWrapper, OdGiBaseVectorizerImpl, OdGsBaseMaterialVectorizer, and OdGsBaseVectorizer.

◆ regenAbort()

virtual bool OdGiConveyorContext::regenAbort ( ) const
pure virtual

Checks whenever regen was aborted.

Returns
true regeneration was aborted, false otherwise.

Implemented in OdGiBaseVectorizer, OdGiExtCalc, OdGiConveyorContextWrapper, and OdGsBaseVectorizer.

◆ 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 OdGiBaseVectorizer, and OdGiConveyorContextWrapper.

◆ subEntityTraits()

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

Retrieves the OdGiSubEntityTraits instance associated with this ConveyorContext object.

Returns
OdGiSubEntityTraits instance associated with this ConveyorContext object.
Remarks
The OdGiSubEntityTraits object is used to register attribute changes with the vectorization framework.

Implemented in OdGiBaseVectorizer, and OdGiConveyorContextWrapper.

◆ worldDeviation()

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

Retrieves deviations array accessor for world coordinate system.

Returns
the OdGiDeviation instance that represents world deviation.

Implemented in OdGiBaseVectorizer, and OdGiConveyorContextWrapper.

The documentation for this class was generated from the following file:
Generated on Wed Apr 5 2023 17:31:15