CFx SDK Documentation  2022 SP0
Public Member Functions | List of all members
OdGeExternalCurve3d Class Reference

#include <GeExternalCurve3d.h>

Inheritance diagram for OdGeExternalCurve3d:
OdGeCurve3d OdGeEntity3d

Public Member Functions

 OdGeExternalCurve3d ()
 
 OdGeExternalCurve3d (const OdGeExternalCurve3d &source)
 
 OdGeExternalCurve3d (void *pCurveDef, OdGe::ExternalEntityKind curveKind, bool makeCopy=true)
 
bool isLine () const
 
bool isRay () const
 
bool isLineSeg () const
 
bool isCircArc () const
 
bool isEllipArc () const
 
bool isNurbCurve () const
 
bool isDefined () const
 
bool isNativeCurve (OdGeCurve3d *&nativeCurve) const
 
void getExternalCurve (void *&pCurveDef) const
 
OdGe::ExternalEntityKind externalCurveKind () const
 
OdGeExternalCurve3dset (void *pCurveDef, OdGe::ExternalEntityKind curveKind, bool makeCopy=true)
 
OdGeExternalCurve3doperator= (const OdGeExternalCurve3d &extCurve)
 
bool isOwnerOfCurve () const
 
OdGeExternalCurve3dsetToOwnCurve ()
 
- Public Member Functions inherited from OdGeCurve3d
void getInterval (OdGeInterval &interval) const
 
void getInterval (OdGeInterval &interval, OdGePoint3d &start, OdGePoint3d &end) const
 
OdGeCurve3dreverseParam ()
 
OdGeCurve3dsetInterval ()
 
bool setInterval (const OdGeInterval &interval)
 
double distanceTo (const OdGePoint3d &point, const OdGeTol &tol=OdGeContext::gTol) const
 
double distanceTo (const OdGeCurve3d &curve, const OdGeTol &tol=OdGeContext::gTol) const
 
OdGePoint3d closestPointTo (const OdGePoint3d &point, const OdGeTol &tol=OdGeContext::gTol) const
 
OdGePoint3d closestPointTo (const OdGeCurve3d &curve, OdGePoint3d &pntOnOtherCrv, const OdGeTol &tol=OdGeContext::gTol) const
 
void getClosestPointTo (const OdGePoint3d &point, OdGePointOnCurve3d &pntOnCrv, const OdGeTol &tol=OdGeContext::gTol) const
 
void getClosestPointTo (const OdGeCurve3d &curve, OdGePointOnCurve3d &pntOnThisCrv, OdGePointOnCurve3d &pntOnOtherCrv, const OdGeTol &tol=OdGeContext::gTol) const
 
OdGePoint3d projClosestPointTo (const OdGePoint3d &point, const OdGeVector3d &projectDirection, const OdGeTol &tol=OdGeContext::gTol) const
 
OdGePoint3d projClosestPointTo (const OdGeCurve3d &curve, const OdGeVector3d &projectDirection, OdGePoint3d &pntOnOtherCrv, const OdGeTol &tol=OdGeContext::gTol) const
 
void getProjClosestPointTo (const OdGePoint3d &point, const OdGeVector3d &projectDirection, OdGePointOnCurve3d &pntOnCrv, const OdGeTol &tol=OdGeContext::gTol) const
 
void getProjClosestPointTo (const OdGeCurve3d &curve, const OdGeVector3d &projectDirection, OdGePointOnCurve3d &pntOnThisCrv, OdGePointOnCurve3d &pntOnOtherCrv, const OdGeTol &tol=OdGeContext::gTol) const
 
bool getNormalPoint (const OdGePoint3d &point, OdGePointOnCurve3d &pntOnCrv, const OdGeTol &tol=OdGeContext::gTol) const
 
OdGeBoundBlock3d boundBlock () const
 
OdGeBoundBlock3d boundBlock (const OdGeInterval &range) const
 
OdGeBoundBlock3d orthoBoundBlock () const
 
OdGeBoundBlock3d orthoBoundBlock (const OdGeInterval &range) const
 
OdGeEntity3dproject (const OdGePlane &projectionPlane, const OdGeVector3d &projectDirection, const OdGeTol &tol=OdGeContext::gTol) const
 
OdGeEntity3dorthoProject (const OdGePlane &projectionPlane, const OdGeTol &tol=OdGeContext::gTol) const
 
 TD_USING (OdGeEntity3d::isOn)
 
bool isOn (const OdGePoint3d &point, double &param, const OdGeTol &tol=OdGeContext::gTol) const
 
bool isOn (double param, const OdGeTol &tol=OdGeContext::gTol) const
 
double paramOf (const OdGePoint3d &point, const OdGeTol &tol=OdGeContext::gTol) const
 
void getTrimmedOffset (double distance, const OdGeVector3d &planeNormal, OdGeCurve3dPtrArray &offsetCurveList, OdGe::OffsetCrvExtType extensionType=OdGe::kFillet, const OdGeTol &tol=OdGeContext::gTol) const
 
bool isClosed (const OdGeTol &tol=OdGeContext::gTol) const
 
bool isPlanar (OdGePlane &plane, const OdGeTol &tol=OdGeContext::gTol) const
 
bool isLinear (OdGeLine3d &line, const OdGeTol &tol=OdGeContext::gTol) const
 
bool isCoplanarWith (const OdGeCurve3d &curve, OdGePlane &plane, const OdGeTol &tol=OdGeContext::gTol) const
 
bool isPeriodic (double &period) const
 
double length (double fromParam, double toParam, double tol=OdGeContext::gTol.equalPoint()) const
 
double length (double tol=OdGeContext::gTol.equalPoint()) const
 
double paramAtLength (double datumParam, double length, bool posParamDir=true, double tol=OdGeContext::gTol.equalPoint()) const
 
bool area (double startParam, double endParam, double &value, const OdGeTol &tol=OdGeContext::gTol) const
 
bool isDegenerate (OdGe::EntityId &degenerateType, const OdGeTol &tol=OdGeContext::gTol) const
 
bool isDegenerate (OdGeEntity3d *&pConvertedEntity, const OdGeTol &tol=OdGeContext::gTol) const
 
void getSplitCurves (double param, OdGeCurve3d *&piece1, OdGeCurve3d *&piece2) const
 
bool explode (OdGeCurve3dPtrArray &explodedCurves, OdGeIntArray &newExplodedCurves, const OdGeInterval *pInterval=NULL) const
 
void getLocalClosestPoints (const OdGePoint3d &point, OdGePointOnCurve3d &approxPntOnThisCrv, const OdGeInterval *pInterval1=NULL, const OdGeTol &tol=OdGeContext::gTol) const
 
void getLocalClosestPoints (const OdGeCurve3d &curve, OdGePointOnCurve3d &approxPntOnThisCrv, OdGePointOnCurve3d &approxPntOnOtherCrv, const OdGeInterval *pInterval1=NULL, const OdGeInterval *pInterval2=NULL, const OdGeTol &tol=OdGeContext::gTol) const
 
bool hasStartPoint (OdGePoint3d &startPoint) const
 
bool hasEndPoint (OdGePoint3d &endPoint) const
 
OdGePoint3d evalPoint (double param) const
 
OdGePoint3d evalPoint (double param, int numDeriv, OdGeVector3dArray &derivatives) const
 
void getSamplePoints (double fromParam, double toParam, double approxEps, OdGePoint3dArray &pointArray, OdGeDoubleArray &paramArray, bool forceResampling=false) const
 
void getSamplePoints (int numSample, OdGePoint3dArray &pointArray) const
 
void getSamplePoints (int numSample, OdGePoint3dArray &pointArray, OdGeDoubleArray &paramArray) const
 
OdGeCurve3doperator= (const OdGeCurve3d &curve)
 
void getSamplePoints (double fromParam, double toParam, double approxEps, OdGePoint3dArray &pointArray, OdGeDoubleArray *paramArray=NULL) const
 
void getSamplePoints (const OdGeInterval *paramInterval, double approxEps, OdGePoint3dArray &pointArray, OdGeDoubleArray *pParamArray=NULL) const
 
void appendSamplePoints (double fromParam, double toParam, double approxEps, OdGePoint3dArray &pointArray, OdGeDoubleArray *pParamArray=NULL) const
 
void appendSamplePoints (int numSample, OdGePoint3dArray &pointArray, OdGeDoubleArray *pParamArray=NULL) const
 
void appendSamplePoints (const OdGeInterval *paramInterval, double approxEps, OdGePoint3dArray &pointArray, OdGeDoubleArray *pParamArray=NULL) const
 
- Public Member Functions inherited from OdGeEntity3d
 ODRX_HEAP_OPERATORS ()
 
 ~OdGeEntity3d ()
 
bool isKindOf (OdGe::EntityId entType) const
 
OdGe::EntityId type () const
 
OdGeEntity3dcopy () const
 
OdGeEntity3doperator= (const OdGeEntity3d &entity)
 
bool operator== (const OdGeEntity3d &entity) const
 
bool operator!= (const OdGeEntity3d &entity) const
 
bool isEqualTo (const OdGeEntity3d &object, const OdGeTol &tol=OdGeContext::gTol) const
 
OdGeEntity3dtransformBy (const OdGeMatrix3d &xfm)
 
OdGeEntity3dtranslateBy (const OdGeVector3d &translateVec)
 
OdGeEntity3drotateBy (double angle, const OdGeVector3d &vect, const OdGePoint3d &basePoint=OdGePoint3d::kOrigin)
 
OdGeEntity3dmirror (const OdGePlane &plane)
 
OdGeEntity3dscaleBy (double scaleFactor, const OdGePoint3d &basePoint=OdGePoint3d::kOrigin)
 
bool isOn (const OdGePoint3d &point, const OdGeTol &tol=OdGeContext::gTol) const
 

Additional Inherited Members

- Protected Member Functions inherited from OdGeCurve3d
 OdGeCurve3d ()
 
 OdGeCurve3d (const OdGeCurve3d &source)
 
- Protected Member Functions inherited from OdGeEntity3d
 OdGeEntity3d ()
 
 OdGeEntity3d (const OdGeEntity3d &)
 
void connectTo (OdGeEntity3dImpl *)
 

Detailed Description

This class represents, as OdGeCurve3d curves, 3D curves whose definitions are external to the OdGe library.

Remarks
OdGeExternalCurve3d curve instances can be treated as any other OdCurve3d.

You can access the OdGeExternalCurve3d as a corresponding native OdGeCurve3d curve, if such a corresponding curve exists, or you may (more efficiently) access the external data in its native form.

One example of using OdGeOdGeExternalCurve3d is to represent an ACIS curve.

Corresponding C++ library: TD_Ge

<group OdGe_Classes>

Definition at line 52 of file GeExternalCurve3d.h.

Constructor & Destructor Documentation

◆ OdGeExternalCurve3d() [1/3]

OdGeExternalCurve3d::OdGeExternalCurve3d ( )
Parameters
pCurveDef[in] Pointer to the curve definition.
curveKind[in] Information about system that created the curve.
makeCopy[in] Makes a copy of the curve definition.
source[in] Object to be cloned.
Remarks
Without arguments, the constructor creates an empty instance.

Possible values for curveKind:

@untitled table kAcisEntity kExternalEntityUndefined

◆ OdGeExternalCurve3d() [2/3]

OdGeExternalCurve3d::OdGeExternalCurve3d ( const OdGeExternalCurve3d source)

◆ OdGeExternalCurve3d() [3/3]

OdGeExternalCurve3d::OdGeExternalCurve3d ( void pCurveDef,
OdGe::ExternalEntityKind  curveKind,
bool  makeCopy = true 
)

Member Function Documentation

◆ externalCurveKind()

OdGe::ExternalEntityKind OdGeExternalCurve3d::externalCurveKind ( ) const

Rerurns information about the system that created the curve.

Remarks
Possible values for curveKind:

@untitled table kAcisEntity kExternalEntityUndefined

◆ getExternalCurve()

void OdGeExternalCurve3d::getExternalCurve ( void *&  pCurveDef) const

Returns a copy of the raw curve definition.

Parameters
pCurveDef[out] Receives a pointer to a copy of the raw curve definition.
Remarks
It is up to the caller to delete the memory allocated.

◆ isCircArc()

bool OdGeExternalCurve3d::isCircArc ( ) const

Return true if and only if the external curve can be represented as an OdGeCircArc3d.

◆ isDefined()

bool OdGeExternalCurve3d::isDefined ( ) const

Returns true if and only if the curve is defined (not an empty instance).

◆ isEllipArc()

bool OdGeExternalCurve3d::isEllipArc ( ) const

Return true if and only if the external curve can be represented as an OdGeEllipArc3d.

◆ isLine()

bool OdGeExternalCurve3d::isLine ( ) const

Return true if and only if the external curve can be represented as an OdGeLine3d.

◆ isLineSeg()

bool OdGeExternalCurve3d::isLineSeg ( ) const

Return true if and only if the external curve can be represented as an OdGeLineSeg3d.

◆ isNativeCurve()

bool OdGeExternalCurve3d::isNativeCurve ( OdGeCurve3d *&  nativeCurve) const

Return true if and only if the external curve can be represented as a native OdGeCurve3d, and returns a pointer to an instance of that native curve.

Parameters
nativeCurve[out] Receives the native curve.
Remarks
The returned object is created with the new operator, and it is the responsibility of the caller to delete it.

◆ isNurbCurve()

bool OdGeExternalCurve3d::isNurbCurve ( ) const

Return true if and only if the external curve can be represented as an OdGeNurbCurve3d.

◆ isOwnerOfCurve()

bool OdGeExternalCurve3d::isOwnerOfCurve ( ) const

Returns true if and only if the external curve owns the data.

Remarks
If the external curve owns the data, it will be destroyed when the curve is destroyed.

◆ isRay()

bool OdGeExternalCurve3d::isRay ( ) const

Return true if and only if the external curve can be represented as an OdGeRay3d.

◆ operator=()

OdGeExternalCurve3d& OdGeExternalCurve3d::operator= ( const OdGeExternalCurve3d extCurve)

◆ set()

OdGeExternalCurve3d& OdGeExternalCurve3d::set ( void pCurveDef,
OdGe::ExternalEntityKind  curveKind,
bool  makeCopy = true 
)

Sets the parameters for this external curve according to the arguments, and returns a reference to this external curve.

Parameters
pCurveDef[in] Pointer to the curve definition.
curveKind[in] Information about system that created the curve.
makeCopy[in] If true, makes a copy of the curve definition.

◆ setToOwnCurve()

OdGeExternalCurve3d& OdGeExternalCurve3d::setToOwnCurve ( )

Forces this external curve to own the data, and returns a reference to this curve.

Remarks
If the external curve owns the data, it will be destroyed when the curve is destroyed.

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