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

#include <GeExternalBoundedSurface.h>

Inheritance diagram for OdGeExternalBoundedSurface:
OdGeSurface OdGeEntity3d

Public Member Functions

 OdGeExternalBoundedSurface ()
 
 OdGeExternalBoundedSurface (void *pSurfaceDef, OdGe::ExternalEntityKind surfaceKind, bool makeCopy=true)
 
 OdGeExternalBoundedSurface (const OdGeExternalBoundedSurface &source)
 
OdGe::ExternalEntityKind externalSurfaceKind () const
 
bool isDefined () const
 
void getExternalSurface (void *&pSurfaceDef) const
 
void getBaseSurface (OdGeSurface *&pSurfaceDef) const
 
void getBaseSurface (OdGeExternalSurface &unboundedSurfaceDef) const
 
bool isPlane () const
 
bool isSphere () const
 
bool isCylinder () const
 
bool isCone () const
 
bool isEllipCylinder () const
 
bool isEllipCone () const
 
bool isTorus () const
 
bool isNurbs () const
 
bool isExternalSurface () const
 
int numContours () const
 
void getContours (int &numContours, OdGeCurveBoundary *&contours) const
 
OdGeExternalBoundedSurfaceset (void *pSurfaceDef, OdGe::ExternalEntityKind surfaceKind, bool makeCopy=true)
 
bool isOwnerOfSurface () const
 
OdGeExternalBoundedSurfacesetToOwnSurface ()
 
OdGeExternalBoundedSurfaceoperator= (const OdGeExternalBoundedSurface &extBoundSurf)
 
- Public Member Functions inherited from OdGeSurface
OdGePoint2d paramOf (const OdGePoint3d &point, const OdGeTol &tol=OdGeContext::gTol) const
 
OdGePoint2d paramOf (const OdGePoint3d &point, const OdGeUvBox *uvBox, const OdGeTol &tol=OdGeContext::gTol) const
 
 TD_USING (OdGeEntity3d::isOn)
 
bool isOn (const OdGePoint3d &point, OdGePoint2d &paramPoint, const OdGeTol &tol=OdGeContext::gTol) const
 
OdGePoint3d closestPointTo (const OdGePoint3d &point, const OdGeTol &tol=OdGeContext::gTol) const
 
OdGePoint3d closestPointTo (const OdGePoint3d &point, OdGePoint2d *param, const OdGeUvBox *uvBox, const OdGeTol &tol=OdGeContext::gTol) const
 
void getClosestPointTo (const OdGePoint3d &point, OdGePointOnSurface &pntOnSurface, const OdGeTol &tol=OdGeContext::gTol) const
 
double distanceTo (const OdGePoint3d &point, const OdGeTol &tol=OdGeContext::gTol) const
 
bool isNormalReversed () const
 
bool isLeftHanded () const
 
OdGeSurfacereverseNormal ()
 
void getEnvelope (OdGeInterval &intrvlU, OdGeInterval &intrvlV) const
 
void getEnvelope (OdGeUvBox &uvbox) const
 
bool isClosedInU (const OdGeTol &tol=OdGeContext::gTol) const
 
bool isClosedInV (const OdGeTol &tol=OdGeContext::gTol) const
 
OdGePoint3d evalPoint (const OdGePoint2d &param) const
 
OdGePoint3d evalPoint (const OdGePoint2d &param, int numDeriv, OdGeVector3dArray &derivatives) const
 
OdGePoint3d evalPoint (const OdGePoint2d &param, int numDeriv, OdGeVector3dArray &derivatives, OdGeVector3d &normal) const
 
OdGeSurfaceoperator= (const OdGeSurface &surf)
 
OdGeExtents3d getGeomExtents (const OdGeUvBox &range=OdGeUvBox(), const OdGeMatrix3d *coordSystem=NULL) const
 
bool project (const OdGePoint3d &p, OdGePoint3d &projP, const OdGeTol &tol=OdGeContext::gTol) const
 
bool setEnvelope (const OdGeInterval &realIntrvlU, const OdGeInterval &realIntrvlV)
 
OdGeCurve3dmakeIsoparamCurve (bool byU, double param) const
 
OdGeCurve3dmakeIsoparamCurve (bool byU, double param, const OdGeInterval &interval) const
 
bool getPoles (OdGeDoubleArray *uParams, OdGeDoubleArray *vParams, OdGePoint3dArray *uPoints, OdGePoint3dArray *vPoints, double tol=1e-13) 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 OdGeSurface
 OdGeSurface ()
 
 OdGeSurface (const OdGeSurface &surf)
 
- Protected Member Functions inherited from OdGeEntity3d
 OdGeEntity3d ()
 
 OdGeEntity3d (const OdGeEntity3d &)
 
void connectTo (OdGeEntity3dImpl *)
 

Detailed Description

This class represents bounded surfaces, whose definitions are external to the OdGe library.

Remarks
Each instance of OdGeExternalBoundedSurface is composed of an instance of an OdExternalSurface and a collection of instances of OdGeCurveBoundary.

OdGeExternalBoundedSurface instances can be treated as any other OdGeSurface.

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

One example of using OdGeExternalBoundedSurface is to access an ACIS surface.

Corresponding C++ library: TD_Ge

<group OdGe_Classes>

Definition at line 51 of file GeExternalBoundedSurface.h.

Constructor & Destructor Documentation

◆ OdGeExternalBoundedSurface() [1/3]

OdGeExternalBoundedSurface::OdGeExternalBoundedSurface ( )

Default constructor for OdGeExternalBoundedSurface.

◆ OdGeExternalBoundedSurface() [2/3]

OdGeExternalBoundedSurface::OdGeExternalBoundedSurface ( void pSurfaceDef,
OdGe::ExternalEntityKind  surfaceKind,
bool  makeCopy = true 
)

Constructor for OdGeExternalBoundedSurface.

Parameters
pSurfaceDef[in] Pointer to the surface definition.
surfaceKind[in] Information about system that created the surface.
makeCopy[in] Makes a copy of curveDef.
Remarks
Possible values for surfaceKind:

@untitled table kAcisEntity kExternalEntityUndefined

◆ OdGeExternalBoundedSurface() [3/3]

OdGeExternalBoundedSurface::OdGeExternalBoundedSurface ( const OdGeExternalBoundedSurface source)

Copy constructor for the OdGeExternalBoundedSurface class.

Parameters
source[in] External bounded surface to copy.

Member Function Documentation

◆ externalSurfaceKind()

OdGe::ExternalEntityKind OdGeExternalBoundedSurface::externalSurfaceKind ( ) const

Returns information about the system that created the surface.

Remarks
Possible values for externalSurfaceKind:

@untitled table kAcisEntity kExternalEntityUndefined

◆ getBaseSurface() [1/2]

void OdGeExternalBoundedSurface::getBaseSurface ( OdGeExternalSurface unboundedSurfaceDef) const

Returns the unbounded surface.

Parameters
unboundedSurfaceDef[out] Receives the unbounded surface definition.

◆ getBaseSurface() [2/2]

void OdGeExternalBoundedSurface::getBaseSurface ( OdGeSurface *&  pSurfaceDef) const

Returns the unbounded surface.

Parameters
pSurfaceDef[out] Receives a pointer to the unbounded surface definition.
Remarks
If called with a pointer to OdGeSurface, the OdExternalSurface will be converted to a native OdGeSurface, if possible.

◆ getContours()

void OdGeExternalBoundedSurface::getContours ( int &  numContours,
OdGeCurveBoundary *&  contours 
) const

Returns an array of the contours on this surface.

Parameters
numContours[out] Receives the number of contours on this surface.
contours[out] Receives the array of contours.

◆ getExternalSurface()

void OdGeExternalBoundedSurface::getExternalSurface ( void *&  pSurfaceDef) const

Returns a copy of the raw surface definition.

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

◆ isCone()

bool OdGeExternalBoundedSurface::isCone ( ) const

Return true if and only if the unbounded base surface can be represented as an OdGeCone.

◆ isCylinder()

bool OdGeExternalBoundedSurface::isCylinder ( ) const

Return true if and only if the unbounded base surface can be represented as an OdGeCylinder.

◆ isDefined()

bool OdGeExternalBoundedSurface::isDefined ( ) const

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

◆ isEllipCone()

bool OdGeExternalBoundedSurface::isEllipCone ( ) const

Return true if and only if the unbounded base surface can be represented as an OdGeEllipCone.

◆ isEllipCylinder()

bool OdGeExternalBoundedSurface::isEllipCylinder ( ) const

Return true if and only if the unbounded base surface can be represented as an OdGeEllipCylinder.

◆ isExternalSurface()

bool OdGeExternalBoundedSurface::isExternalSurface ( ) const

Return true if and only if the unbounded base surface cannot be represented as an native OdGeSurface.

◆ isNurbs()

bool OdGeExternalBoundedSurface::isNurbs ( ) const

Return true if and only if the unbounded base surface can be represented as an OdGeNurbSurface.

◆ isOwnerOfSurface()

bool OdGeExternalBoundedSurface::isOwnerOfSurface ( ) const

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

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

◆ isPlane()

bool OdGeExternalBoundedSurface::isPlane ( ) const

Return true if and only if the unbounded base surface can be represented as an OdGePlanarEnt.

◆ isSphere()

bool OdGeExternalBoundedSurface::isSphere ( ) const

Return true if and only if the unbounded base surface can be represented as an OdGeSphere.

◆ isTorus()

bool OdGeExternalBoundedSurface::isTorus ( ) const

Return true if and only if the unbounded base surface can be represented as an OdGeTorus.

◆ numContours()

int OdGeExternalBoundedSurface::numContours ( ) const

Returns the number of contours on this surface.

◆ operator=()

OdGeExternalBoundedSurface & OdGeExternalBoundedSurface::operator= ( const OdGeExternalBoundedSurface extBoundSurf)

Assignment operator for the OdGeExternalBoundedSurface object.

Parameters
extBoundSurf[in] External bounded surface to assign.
Returns
A reference to this OdGeExternalBoundedSurface object.

◆ set()

OdGeExternalBoundedSurface & OdGeExternalBoundedSurface::set ( void pSurfaceDef,
OdGe::ExternalEntityKind  surfaceKind,
bool  makeCopy = true 
)

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

Parameters
pSurfaceDef[in] Pointer to the surface definition.
surfaceKind[in] Information about system that created the surface.
makeCopy[in] If true, makes a copy of the surface definition.

◆ setToOwnSurface()

OdGeExternalBoundedSurface & OdGeExternalBoundedSurface::setToOwnSurface ( )

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

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

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