CFx SDK Documentation  2020SP3
Public Member Functions | List of all members
OdGeSurfSurfInt Class Reference

#include <GeSurfSurfInt.h>

Inheritance diagram for OdGeSurfSurfInt:
OdGeEntity3d

Public Member Functions

 OdGeSurfSurfInt ()
 
 OdGeSurfSurfInt (const OdGeSurface &srf1, const OdGeSurface &srf2, const OdGeTol &tol=OdGeContext::gTol)
 
 OdGeSurfSurfInt (const OdGeSurfSurfInt &source)
 
const OdGeSurfacesurface1 () const
 
const OdGeSurfacesurface2 () const
 
OdGeTol tolerance () const
 
int numResults (OdGeIntersectError &status) const
 
OdGeCurve3dintCurve (int intNum, bool isExternal, OdGeIntersectError &status) const
 
OdGeCurve2dintParamCurve (int intNum, bool isExternal, bool isFirst, OdGeIntersectError &status) const
 
OdGePoint3d intPoint (int intNum, OdGeIntersectError &status) const
 
void getIntPointParams (int intNum, OdGePoint2d &param1, OdGePoint2d &param2, OdGeIntersectError &status) const
 
void getIntConfigs (int intNum, OdGe::ssiConfig &surf1Left, OdGe::ssiConfig &surf1Right, OdGe::ssiConfig &surf2Left, OdGe::ssiConfig &surf2Right, OdGe::ssiType &intType, int &dim, OdGeIntersectError &status) const
 
int getDimension (int intNum, OdGeIntersectError &status) const
 
OdGe::ssiType getType (int intNum, OdGeIntersectError &status) const
 
OdGeSurfSurfIntset (const OdGeSurface &srf1, const OdGeSurface &srf2, const OdGeTol &tol=OdGeContext::gTol)
 
OdGeSurfSurfIntoperator= (const OdGeSurfSurfInt &surfSurfInt)
 
- 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 OdGeEntity3d
 OdGeEntity3d ()
 
 OdGeEntity3d (const OdGeEntity3d &)
 
void connectTo (OdGeEntity3dImpl *)
 

Detailed Description

This class holds the intersection data of two surfaces.

Remarks
This object contains references to surface objects but does not own them. Actual intersection calculations are not performed until a query function is called. Any returned objects other than pointers to the referenced surfaces are owned by the called.

Corresponding C++ library: TD_Ge

<group OdGe_Classes>

Definition at line 47 of file GeSurfSurfInt.h.

Constructor & Destructor Documentation

◆ OdGeSurfSurfInt() [1/3]

OdGeSurfSurfInt::OdGeSurfSurfInt ( )
Parameters
srf1[in] First surface.
srf2[in] Second surface.
tol[in] Geometric tolerance.
source[in] Object to be cloned.

◆ OdGeSurfSurfInt() [2/3]

OdGeSurfSurfInt::OdGeSurfSurfInt ( const OdGeSurface srf1,
const OdGeSurface srf2,
const OdGeTol tol = OdGeContext::gTol 
)

◆ OdGeSurfSurfInt() [3/3]

OdGeSurfSurfInt::OdGeSurfSurfInt ( const OdGeSurfSurfInt source)

Member Function Documentation

◆ getDimension()

int OdGeSurfSurfInt::getDimension ( int  intNum,
OdGeIntersectError status 
) const

Description Pending.

Parameters
intNum[in] The zero-based index of the intersection curve to return.
status[out] Receives the status of the intersection.
Remarks
Possible values for status are as follows:

@untitled table kXXOk kXXIndexOutOfRange kXXWrongDimensionAtIndex kXXUnknown

Remarks
Currently not implemented.

◆ getIntConfigs()

void OdGeSurfSurfInt::getIntConfigs ( int  intNum,
OdGe::ssiConfig surf1Left,
OdGe::ssiConfig surf1Right,
OdGe::ssiConfig surf2Left,
OdGe::ssiConfig surf2Right,
OdGe::ssiType intType,
int &  dim,
OdGeIntersectError status 
) const

Returns the configurations on either side of the intersection each surface.

Parameters
intNum[in] The zero-based index of the intersection curve to return.
surf1Left[out] Receives the configuration for surface 1 on the left side of the intersection.
surf1Right[out] Receives the configuration for surface 1 on the right side of the intersection.
surf2Left[out] Receives the configuration for surface 2 on the left side of the intersection.
surf2Right[out] Receives the configuration for surface 2 on the right side of the intersection.
status[out] Receives the status of the intersection.
Remarks
Possible values for surf1Left, surf1Right, surf2Left, and surf2Right are as follows:

@untitled table kSSIUnknown kSSIOut Neighborhood is outside this surface. kSSIIn Neighborhood is inside this surface. kSSICoincident Non-zero area intersection.

Possible values for status are as follows:

@untitled table kXXOk kXXIndexOutOfRange kXXWrongDimensionAtIndex kXXUnknown

Remarks
Currently not implemented.

◆ getIntPointParams()

void OdGeSurfSurfInt::getIntPointParams ( int  intNum,
OdGePoint2d param1,
OdGePoint2d param2,
OdGeIntersectError status 
) const

Returns the parameter pairs for the specified intersection point with respect to each surface, and the status of the intersection.

Parameters
intNum[in] The zero-based index of the intersection curve to return.
param1[out] Receives the parameter pair of the intersection point with respect to the first curve.
param2[out] Receives the parameter pair of the intersection point with respect to the second curve.
status[out] Receives the status of the intersection.

Possible values for status are as follows:

@untitled table kXXOk kXXIndexOutOfRange kXXWrongDimensionAtIndex kXXUnknown

Remarks
Currently not implemented.

◆ getType()

OdGe::ssiType OdGeSurfSurfInt::getType ( int  intNum,
OdGeIntersectError status 
) const

Returns the type of the specified intersection.

Parameters
intNum[in] The zero-based index of the intersection curve to return.
status[out] Receives the status of the intersection.
Remarks
Possible return values for the configuratons are as follows:

@untitled table kXXOk kXXIndexOutOfRange kXXWrongDimensionAtIndex kXXUnknown

Remarks
Currently not implemented.

◆ intCurve()

OdGeCurve3d* OdGeSurfSurfInt::intCurve ( int  intNum,
bool  isExternal,
OdGeIntersectError status 
) const

Returns the 3D curve representing the specified intersection and the status of the intersection.

Parameters
intNum[in] The zero-based index of the intersection curve to return.
isExternal[in] Unknown.
status[out] Receives the status of the intersection.
Remarks
Possible values for status are as follows:

@untitled table kXXOk kXXIndexOutOfRange kXXWrongDimensionAtIndex kXXUnknown

Remarks
Currently not implemented.

◆ intParamCurve()

OdGeCurve2d* OdGeSurfSurfInt::intParamCurve ( int  intNum,
bool  isExternal,
bool  isFirst,
OdGeIntersectError status 
) const

Returns the 2D curve representing the specified intersection and the status of the intersection.

Parameters
intNum[in] The zero-based index of the intersection curve to return.
isExternal[in] Unknown.
isFirst[in] If true, returns the curve on the first surface, otherwise it the curve on the second surface.
status[out] Receives the status of the intersection.
Remarks
If the intersection is not a 2d curve, returns 0.

Possible values for status are as follows:

@untitled table kXXOk kXXIndexOutOfRange kXXWrongDimensionAtIndex kXXUnknown

Remarks
Currently not implemented.

◆ intPoint()

OdGePoint3d OdGeSurfSurfInt::intPoint ( int  intNum,
OdGeIntersectError status 
) const

Returns the 3d point representing the specified intersection, and the status of the intersection.

Parameters
intNum[in] The zero-based index of the intersection curve to return.
status[out] Receives the status of the intersection.
Remarks
If the intersection is not a 3d point, returns 0.

Possible values for status are as follows:

@untitled table kXXOk kXXIndexOutOfRange kXXWrongDimensionAtIndex kXXUnknown

Remarks
Currently not implemented.

◆ numResults()

int OdGeSurfSurfInt::numResults ( OdGeIntersectError status) const

Returns the number of intersections between the two surfaces, and the status of the intersections.

Parameters
status[out] Receives the status of the intersection.
Remarks
Possible values for status are as follows:

@untitled table kXXOk kXXIndexOutOfRange kXXWrongDimensionAtIndex kXXUnknown

Remarks
Currently not implemented.

◆ operator=()

OdGeSurfSurfInt& OdGeSurfSurfInt::operator= ( const OdGeSurfSurfInt surfSurfInt)

◆ set()

OdGeSurfSurfInt& OdGeSurfSurfInt::set ( const OdGeSurface srf1,
const OdGeSurface srf2,
const OdGeTol tol = OdGeContext::gTol 
)

Sets the surfaces and tolerances whose intersection data is to be determines. Returns a reference to this SurfSurfInt.

Parameters
srf1[in] First surface.
srf2[in] Second surface.
tol[in] Geometric tolerance.

◆ surface1()

const OdGeSurface* OdGeSurfSurfInt::surface1 ( ) const

Returns the first surface.

◆ surface2()

const OdGeSurface* OdGeSurfSurfInt::surface2 ( ) const

Returns the second surface.

◆ tolerance()

OdGeTol OdGeSurfSurfInt::tolerance ( ) const

Returns the tolerance for determining intersections.


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