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

#include <GiModelToViewProc.h>

Inheritance diagram for OdGiModelToViewProc:
OdRxObject

Public Types

enum  ClippingCS { kClipInEyeSpace , kClipInWorldSpace , kClipInOutputSpace }
 

Public Member Functions

 ODRX_DECLARE_MEMBERS (OdGiModelToViewProc)
 
virtual void setDrawContext (OdGiConveyorContext *pDrawCtx)=0
 
virtual OdGiConveyorInputmodelInput ()=0
 
virtual OdGiConveyorInputeyeInput ()=0
 
virtual OdGiConveyorOutputoutput ()=0
 
virtual void setEyeToOutputTransform (const OdGeMatrix3d &xMat)=0
 
virtual const OdGeMatrix3deyeToOutputTransform () const =0
 
virtual void setView (const OdGePoint3d &target, const OdGeVector3d &xVector, const OdGeVector3d &upVector, const OdGeVector3d &eyeVector)=0
 
virtual void setWorldToEyeTransform (const OdGeMatrix3d &xMat)=0
 
virtual const OdGeMatrix3dworldToEyeTransform () const =0
 
virtual const OdGeMatrix3deyeToWorldTransform () const =0
 
virtual const OdGeMatrix3dmodelToEyeTransform () const =0
 
virtual const OdGeMatrix3deyeToModelTransform () const =0
 
virtual void pushModelTransform (const OdGeMatrix3d &xMat)=0
 
virtual void popModelTransform ()=0
 
virtual bool isEmptyModelMatrixStack () const =0
 
virtual const OdGeMatrix3dmodelToWorldTransform () const =0
 
virtual const OdGeMatrix3dworldToModelTransform () const =0
 
virtual OdGiXformgetModelToEyeXform ()=0
 
virtual const OdGiXformgetModelToEyeXform () const =0
 
virtual OdGiXformgetEyeToModelXform ()=0
 
virtual const OdGiXformgetEyeToModelXform () const =0
 
virtual void pushClipBoundary (OdGiClipBoundary *pBoundary)=0
 
virtual void pushClipBoundary (OdGiClipBoundary *pBoundary, OdGiAbstractClipBoundary *pClipInfo)=0
 
virtual void popClipBoundary ()=0
 
virtual bool isClipping () const =0
 
virtual bool isEmptyClipSet () const =0
 
virtual void initGeometryClipStatus ()=0
 
virtual int getGeometryClipStatus (bool bSectioning=false, bool bClear=false)=0
 
virtual void setWorldDeviation (const OdGiDeviation &worldDev)=0
 
virtual void setWorldDeviation (const OdGeDoubleArray &deviations)=0
 
virtual const OdGiDeviationworldDeviation () const =0
 
virtual const OdGiDeviationmodelDeviation () const =0
 
virtual const OdGiDeviationeyeDeviation () const =0
 
virtual void setClippingSpace (ClippingCS newClipCS)=0
 
virtual ClippingCS currentClippingSpace () const =0
 
virtual void enableAnalyticCurvesClipping (bool bEnable=true)=0
 
virtual bool isAnalyticCurvesClippingEnabled () const =0
 
virtual void enableClippingDebugLog (const OdString &fileName)=0
 
virtual void disableClippingDebugLog ()=0
 
virtual bool isClippingDebugLogEnabled () const =0
 
virtual void switchSectioning (bool bEnable)=0
 
virtual bool isSectioningEnabled () const =0
 
- 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
 

Protected Member Functions

 OdGiModelToViewProc ()
 

Additional Inherited Members

- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClassdesc ()
 

Detailed Description

<group OdGi_Classes>

Definition at line 42 of file GiModelToViewProc.h.

Member Enumeration Documentation

◆ ClippingCS

Enumerator
kClipInEyeSpace 
kClipInWorldSpace 
kClipInOutputSpace 

Definition at line 264 of file GiModelToViewProc.h.

Constructor & Destructor Documentation

◆ OdGiModelToViewProc()

OdGiModelToViewProc::OdGiModelToViewProc ( )
protected

Member Function Documentation

◆ currentClippingSpace()

virtual ClippingCS OdGiModelToViewProc::currentClippingSpace ( ) const
pure virtual

Retrieves current clipping space.

Returns
current clipping space as a value from the ClippingCS enumeration.

◆ disableClippingDebugLog()

virtual void OdGiModelToViewProc::disableClippingDebugLog ( )
pure virtual

Disables clipping debug logging.

◆ enableAnalyticCurvesClipping()

virtual void OdGiModelToViewProc::enableAnalyticCurvesClipping ( bool  bEnable = true)
pure virtual

Enables or disables analytic mode for curve clipping.

Parameters
bEnable[in] Flag that specifies whether to enable analytic mode for curve clipping.

◆ enableClippingDebugLog()

virtual void OdGiModelToViewProc::enableClippingDebugLog ( const OdString fileName)
pure virtual

Enables clipping debug logging.

Parameters
fileName[in] Path to file where debug information is logged.

◆ eyeDeviation()

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

Retrieves the maximum EyeSpace (ECS) deviation for this VectorizeView object.

Returns
maximum eye space (ECS) deviation as the OdGiDeviation instance.

◆ eyeInput()

virtual OdGiConveyorInput & OdGiModelToViewProc::eyeInput ( )
pure virtual

◆ eyeToModelTransform()

virtual const OdGeMatrix3d & OdGiModelToViewProc::eyeToModelTransform ( ) const
pure virtual

Retrieves eye to model transform matrix.

Returns
reference to OdGeMatrix3d that represents eye to model transform matrix.

◆ eyeToOutputTransform()

virtual const OdGeMatrix3d & OdGiModelToViewProc::eyeToOutputTransform ( ) const
pure virtual

◆ eyeToWorldTransform()

virtual const OdGeMatrix3d & OdGiModelToViewProc::eyeToWorldTransform ( ) const
pure virtual

Retrieves eye to world transform matrix.

Returns
reference to OdGeMatrix3d that represents eye to world transform matrix.

◆ getEyeToModelXform() [1/2]

virtual const OdGiXform * OdGiModelToViewProc::getEyeToModelXform ( ) const
pure virtual

◆ getEyeToModelXform() [2/2]

virtual OdGiXform * OdGiModelToViewProc::getEyeToModelXform ( )
pure virtual

◆ getGeometryClipStatus()

virtual int OdGiModelToViewProc::getGeometryClipStatus ( bool  bSectioning = false,
bool  bClear = false 
)
pure virtual

Checks whether previously called geometry primitive was partially or completely clipped.

Parameters
bSectioning[in] Include sections and cut geometry output.
bClear[in] Clear exist clip status after result return.
Returns
0 in case if geometry doesn't clipped, 1 if geometry clipped partially or 2 if geometry clipped completely.

◆ getModelToEyeXform() [1/2]

virtual const OdGiXform * OdGiModelToViewProc::getModelToEyeXform ( ) const
pure virtual

◆ getModelToEyeXform() [2/2]

virtual OdGiXform * OdGiModelToViewProc::getModelToEyeXform ( )
pure virtual

◆ initGeometryClipStatus()

virtual void OdGiModelToViewProc::initGeometryClipStatus ( )
pure virtual

Clears geometry clip status.

◆ isAnalyticCurvesClippingEnabled()

virtual bool OdGiModelToViewProc::isAnalyticCurvesClippingEnabled ( ) const
pure virtual

Checks whether analytic mode for curve clipping is enabled.

Returns
true if analytic mode for curve clipping is enabled, false otherwise.

◆ isClipping()

virtual bool OdGiModelToViewProc::isClipping ( ) const
pure virtual

Checks whether clipping stage chain is not empty.

Returns
true if clipping stage chain is not empty, false otherwise.

◆ isClippingDebugLogEnabled()

virtual bool OdGiModelToViewProc::isClippingDebugLogEnabled ( ) const
pure virtual

Checks whether clipping debug logging is enabled.

Returns
true if clipping debug logging is enabled, false otherwise.

◆ isEmptyClipSet()

virtual bool OdGiModelToViewProc::isEmptyClipSet ( ) const
pure virtual

Checks whether clip set is empty.

Returns
true if clip set is empty, false otherwise.

◆ isEmptyModelMatrixStack()

virtual bool OdGiModelToViewProc::isEmptyModelMatrixStack ( ) const
pure virtual

Checks whether model transform stack does not contain any transform matrix.

Returns
true if model matrix stack is empty, false otherwise.

◆ isSectioningEnabled()

virtual bool OdGiModelToViewProc::isSectioningEnabled ( ) const
pure virtual

Checks whether sectioning (clipping) is enabled.

Returns
true if sectioning is enabled, false otherwise.

◆ modelDeviation()

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

Retrieves the maximum ModelSpace (UCS) deviation for this VectorizeView object.

Returns
maximum ModelSpace (UCS) deviation as the OdGiDeviation instance.

◆ modelInput()

virtual OdGiConveyorInput & OdGiModelToViewProc::modelInput ( )
pure virtual

◆ modelToEyeTransform()

virtual const OdGeMatrix3d & OdGiModelToViewProc::modelToEyeTransform ( ) const
pure virtual

Retrieves model to eye transform matrix.

Returns
reference to OdGeMatrix3d that represents model to eye transform matrix.

◆ modelToWorldTransform()

virtual const OdGeMatrix3d & OdGiModelToViewProc::modelToWorldTransform ( ) const
pure virtual

Retrieves model to world transform matrix.

Returns
reference to OdGeMatrix3d that represents model to world transform matrix.

◆ ODRX_DECLARE_MEMBERS()

OdGiModelToViewProc::ODRX_DECLARE_MEMBERS ( OdGiModelToViewProc  )

◆ output()

virtual OdGiConveyorOutput & OdGiModelToViewProc::output ( )
pure virtual

◆ popClipBoundary()

virtual void OdGiModelToViewProc::popClipBoundary ( )
pure virtual

Removes the top clip boundary from the clip stack.

See also
<link tv_planarClip_sample, Planar Clipping Section Generation for a Custom Entity>

◆ popModelTransform()

virtual void OdGiModelToViewProc::popModelTransform ( )
pure virtual

Removes the top transformation off the current transformation stack.

◆ pushClipBoundary() [1/2]

virtual void OdGiModelToViewProc::pushClipBoundary ( OdGiClipBoundary pBoundary)
pure virtual

Specifies a clip boundary for the current clip stack.

Parameters
pBoundary[in] Pointer to the boundary.
Remarks
Subsequent objects are clipped until popClipBoundary() is called.
See also
<link tv_planarClip_sample, Planar Clipping Section Generation for a Custom Entity>

◆ pushClipBoundary() [2/2]

virtual void OdGiModelToViewProc::pushClipBoundary ( OdGiClipBoundary pBoundary,
OdGiAbstractClipBoundary pClipInfo 
)
pure virtual

Specifies a clip boundary for the current clip stack.

Parameters
pBoundary[in] Pointer to the boundary.
pClipInfo[in] Pointer to the additional object that specifies clip boundary type.
Remarks
Subsequent objects are clipped until popClipBoundary() is called.
See also
<link tv_planarClip_sample, Planar Clipping Section Generation for a Custom Entity>

◆ pushModelTransform()

virtual void OdGiModelToViewProc::pushModelTransform ( const OdGeMatrix3d xMat)
pure virtual

Specifies a model transformation matrix for the current transformation stack.

Remarks
The specified transformation is concatenated to the current model transformation (which is initially the identity transform).
Parameters
xMat[in] Transformation matrix.

◆ setClippingSpace()

virtual void OdGiModelToViewProc::setClippingSpace ( ClippingCS  newClipCS)
pure virtual

Sets clipping space.

Parameters
newClipCS[in] New coordinate space for clipping.

◆ setDrawContext()

virtual void OdGiModelToViewProc::setDrawContext ( OdGiConveyorContext pDrawCtx)
pure virtual

Sets the draw context object (to access to traits, etc).

Parameters
pDrawCtx[in] Pointer to the draw context.

◆ setEyeToOutputTransform()

virtual void OdGiModelToViewProc::setEyeToOutputTransform ( const OdGeMatrix3d xMat)
pure virtual

◆ setView()

virtual void OdGiModelToViewProc::setView ( const OdGePoint3d target,
const OdGeVector3d xVector,
const OdGeVector3d upVector,
const OdGeVector3d eyeVector 
)
pure virtual

Sets view (camera) parameters.

Parameters
target[in] Camera target.
xVector[in] Vector that defines x-axis.
upVector[in] Vector that defines upward direction of camera.
eyeVector[in] Vector that defines direction from camera target to camera position.

◆ setWorldDeviation() [1/2]

virtual void OdGiModelToViewProc::setWorldDeviation ( const OdGeDoubleArray deviations)
pure virtual

Sets the maximum world (WCS) deviation for this object.

Parameters
deviations[in] Array of deviation values.

◆ setWorldDeviation() [2/2]

virtual void OdGiModelToViewProc::setWorldDeviation ( const OdGiDeviation worldDev)
pure virtual

Sets the maximum world (WCS) deviation for this object.

Parameters
worldDev[in] Deviation.

◆ setWorldToEyeTransform()

virtual void OdGiModelToViewProc::setWorldToEyeTransform ( const OdGeMatrix3d xMat)
pure virtual

Sets world to eye transform matrix.

Parameters
xMat[in] Transform matrix.

◆ switchSectioning()

virtual void OdGiModelToViewProc::switchSectioning ( bool  bEnable)
pure virtual

Enables or disables sectioning (clipping).

Parameters
bEnable[in] Flag that specifies whether to enable sectioning.

◆ worldDeviation()

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

Retrieves the maximum world (WCS) deviation for this object.

Returns
maximum world space (WCS) deviation as the OdGiDeviation instance.

◆ worldToEyeTransform()

virtual const OdGeMatrix3d & OdGiModelToViewProc::worldToEyeTransform ( ) const
pure virtual

Retrieves world to eye transform matrix.

Returns
reference to OdGeMatrix3d that represents world to eye transform matrix.

◆ worldToModelTransform()

virtual const OdGeMatrix3d & OdGiModelToViewProc::worldToModelTransform ( ) const
pure virtual

Retrieves world to model transform matrix.

Returns
reference to OdGeMatrix3d that represents world to model transform matrix.

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