CFx SDK Documentation 2024 SP0
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
OdGiConveyorContextWrapper Class Reference

#include <GiConveyorGeometry.h>

Inheritance diagram for OdGiConveyorContextWrapper:
OdGiConveyorContext

Public Member Functions

OdGiConveyorContext * getOriginalContext () const
 
void setOriginalContext (OdGiConveyorContext *pCtx)
 
 OdGiConveyorContextWrapper (OdGiConveyorContext *pCtx=NULL)
 
OdGiContext & giContext () const
 
OdGiSubEntityTraits & subEntityTraits () const
 
const OdGiSubEntityTraitsData & effectiveTraits () const
 
void setEffectiveTraits (const OdGiSubEntityTraitsData &traits, const OdGeVector3d *fillNormal=NULL)
 
bool effectivelyVisible () const
 
const OdGiDrawableDesc * currentDrawableDesc () const
 
const OdGiDrawable * currentDrawable () const
 
const OdGiViewport * giViewport () const
 
const OdGsView * gsView () const
 
void onTraitsModified ()
 
void onTextProcessing (const OdGePoint3d &position, const OdGeVector3d &direction, const OdGeVector3d &upVector)
 
bool regenAbort () const
 
const OdGiPathNode * currentGiPath () const
 
const OdGiDeviation & worldDeviation () const
 
const OdGiDeviation & modelDeviation () const
 
const OdGiDeviation & eyeDeviation () const
 
OdGeMatrix3d getModelToWorldTransform () const
 
OdGeMatrix3d getWorldToModelTransform () const
 
const OdGiLineweightOverride * currentLineweightOverride () const
 
OdUInt32 drawContextFlags () const
 
- Public Member Functions inherited from OdGiConveyorContext
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
 

Protected Attributes

OdGiConveyorContext * m_pCtx
 

Additional Inherited Members

- Public Types inherited from OdGiConveyorContext
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
}
 

Detailed Description

See also
TD_Gi <group OdGi_Classes>

Definition at line 292 of file GiConveyorGeometry.h.

Constructor & Destructor Documentation

◆ OdGiConveyorContextWrapper()

OdGiConveyorContextWrapper::OdGiConveyorContextWrapper ( OdGiConveyorContext *  pCtx = NULL)
inlineexplicit

Constructor for the OdGiConveyorContextWrapper class.

Parameters
pCtx[in] Pointer to a conveyor context.

Definition at line 317 of file GiConveyorGeometry.h.

Member Function Documentation

◆ currentDrawable()

const OdGiDrawable * OdGiConveyorContextWrapper::currentDrawable ( ) const
inlinevirtual

Retrieves the current OdGiDrawable object for this object.

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

Implements OdGiConveyorContext.

Definition at line 380 of file GiConveyorGeometry.h.

◆ currentDrawableDesc()

const OdGiDrawableDesc * OdGiConveyorContextWrapper::currentDrawableDesc ( ) const
inlinevirtual

Retrieves the current OdGiDrawableDesc instance for this 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.).

Implements OdGiConveyorContext.

Definition at line 369 of file GiConveyorGeometry.h.

◆ currentGiPath()

const OdGiPathNode * OdGiConveyorContextWrapper::currentGiPath ( ) const
inlinevirtual

Retrieves current drawable nesting graph.

Returns
pointer to the OdGiPathNode instance.

Implements OdGiConveyorContext.

Definition at line 440 of file GiConveyorGeometry.h.

◆ currentLineweightOverride()

const OdGiLineweightOverride * OdGiConveyorContextWrapper::currentLineweightOverride ( ) const
inlinevirtual

Retrieves current lineweight override (if present).

Returns
pointer to the OdGiLineweightOverride instance.

Reimplemented from OdGiConveyorContext.

Definition at line 497 of file GiConveyorGeometry.h.

◆ drawContextFlags()

OdUInt32 OdGiConveyorContextWrapper::drawContextFlags ( ) const
inlinevirtual

Retrieves set of conveyor context flags.

Returns
context flags as OdUInt32 value.

Reimplemented from OdGiConveyorContext.

Definition at line 505 of file GiConveyorGeometry.h.

◆ effectivelyVisible()

bool OdGiConveyorContextWrapper::effectivelyVisible ( ) const
inlinevirtual

Checks the current visibility state for current traits.

Returns
true if effective traits are visible, false otherwise.

Reimplemented from OdGiConveyorContext.

Definition at line 358 of file GiConveyorGeometry.h.

◆ effectiveTraits()

const OdGiSubEntityTraitsData & OdGiConveyorContextWrapper::effectiveTraits ( ) const
inlinevirtual

Retrieves the traits currently in effect for this ConveyorContext object.

Returns
effective traits as OdGiSubEntityTraitsData object.

Implements OdGiConveyorContext.

Definition at line 342 of file GiConveyorGeometry.h.

◆ eyeDeviation()

const OdGiDeviation & OdGiConveyorContextWrapper::eyeDeviation ( ) const
inlinevirtual

Retrieves deviations array accessor for eye coordinate system.

Returns
the OdGiDeviation instance that represents eye deviation.

Implements OdGiConveyorContext.

Definition at line 464 of file GiConveyorGeometry.h.

◆ getModelToWorldTransform()

OdGeMatrix3d OdGiConveyorContextWrapper::getModelToWorldTransform ( ) const
inlinevirtual

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.

Implements OdGiConveyorContext.

Definition at line 478 of file GiConveyorGeometry.h.

◆ getOriginalContext()

OdGiConveyorContext * OdGiConveyorContextWrapper::getOriginalContext ( ) const
inline

Retrieves original drawing context associated with this object.

Returns
pointer to the OdGiConveyorContext instance.

Definition at line 303 of file GiConveyorGeometry.h.

◆ getWorldToModelTransform()

OdGeMatrix3d OdGiConveyorContextWrapper::getWorldToModelTransform ( ) const
inlinevirtual

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().

Implements OdGiConveyorContext.

Definition at line 489 of file GiConveyorGeometry.h.

◆ giContext()

OdGiContext & OdGiConveyorContextWrapper::giContext ( ) const
inlinevirtual

Retrieves Gi context.

Returns
Gi context as OdGiContext instance.

Implements OdGiConveyorContext.

Definition at line 326 of file GiConveyorGeometry.h.

◆ giViewport()

const OdGiViewport * OdGiConveyorContextWrapper::giViewport ( ) const
inlinevirtual

Retrieves the OdGiViewport associated with this object.

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

Implements OdGiConveyorContext.

Definition at line 388 of file GiConveyorGeometry.h.

◆ gsView()

const OdGsView * OdGiConveyorContextWrapper::gsView ( ) const
inlinevirtual

Retrieves the OdGsView associated with this 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>

Implements OdGiConveyorContext.

Definition at line 398 of file GiConveyorGeometry.h.

◆ modelDeviation()

const OdGiDeviation & OdGiConveyorContextWrapper::modelDeviation ( ) const
inlinevirtual

Retrieves deviations array accessor for model coordinate system.

Returns
the OdGiDeviation instance that represents model deviation.

Implements OdGiConveyorContext.

Definition at line 456 of file GiConveyorGeometry.h.

◆ onTextProcessing()

void OdGiConveyorContextWrapper::onTextProcessing ( const OdGePoint3d &  position,
const OdGeVector3d &  direction,
const OdGeVector3d &  upVector 
)
inlinevirtual

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

Parameters
position[in] Text position.
direction[in] Text direction vector.
upVector[in] Text up-vector.
Remarks
This function provides a hook for setting geometry transformation before text was drawn.

Reimplemented from OdGiConveyorContext.

Definition at line 423 of file GiConveyorGeometry.h.

◆ onTraitsModified()

void OdGiConveyorContextWrapper::onTraitsModified ( )
inlinevirtual

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).

Implements OdGiConveyorContext.

Definition at line 410 of file GiConveyorGeometry.h.

◆ regenAbort()

bool OdGiConveyorContextWrapper::regenAbort ( ) const
inlinevirtual

Checks whenever regen was aborted.

Returns
true regeneration was aborted, false otherwise.

Implements OdGiConveyorContext.

Definition at line 432 of file GiConveyorGeometry.h.

◆ setEffectiveTraits()

void OdGiConveyorContextWrapper::setEffectiveTraits ( const OdGiSubEntityTraitsData &  traits,
const OdGeVector3d *  fillNormal = NULL 
)
inlinevirtual

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.

Implements OdGiConveyorContext.

Definition at line 349 of file GiConveyorGeometry.h.

◆ setOriginalContext()

void OdGiConveyorContextWrapper::setOriginalContext ( OdGiConveyorContext *  pCtx)
inline

Sets original drawing context for this object.

Parameters
pCtx[in] Pointer to original drawing context to set.

Definition at line 310 of file GiConveyorGeometry.h.

◆ subEntityTraits()

OdGiSubEntityTraits & OdGiConveyorContextWrapper::subEntityTraits ( ) const
inlinevirtual

Retrieves entity traits.

Returns
entity traits as OdGiSubEntityTraits instance.

Implements OdGiConveyorContext.

Definition at line 334 of file GiConveyorGeometry.h.

◆ worldDeviation()

const OdGiDeviation & OdGiConveyorContextWrapper::worldDeviation ( ) const
inlinevirtual

Retrieves deviations array accessor for world coordinate system.

Returns
the OdGiDeviation instance that represents world deviation.

Implements OdGiConveyorContext.

Definition at line 448 of file GiConveyorGeometry.h.

Member Data Documentation

◆ m_pCtx

OdGiConveyorContext* OdGiConveyorContextWrapper::m_pCtx
protected

Definition at line 295 of file GiConveyorGeometry.h.

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