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

#include <GeExternalSurface.h>

Inheritance diagram for OdGeExternalSurface:
OdGeSurface OdGeEntity3d

Public Member Functions

 OdGeExternalSurface ()
 
 OdGeExternalSurface (void *pSurfaceDef, OdGe::ExternalEntityKind surfaceKind, bool makeCopy=true)
 
 OdGeExternalSurface (const OdGeExternalSurface &source)
 
void getExternalSurface (void *&pSurfaceDef) const
 
OdGe::ExternalEntityKind externalSurfaceKind () const
 
bool isPlane () const
 
bool isSphere () const
 
bool isCylinder () const
 
bool isCone () const
 
bool isEllipCylinder () const
 
bool isEllipCone () const
 
bool isTorus () const
 
bool isNurbSurface () const
 
bool isDefined () const
 
bool isNativeSurface (OdGeSurface *&nativeSurface) const
 
OdGeExternalSurfaceoperator= (const OdGeExternalSurface &extSurf)
 
OdGeExternalSurfaceset (void *pSurfaceDef, OdGe::ExternalEntityKind surfaceKind, bool makeCopy=true)
 
bool isOwnerOfSurface () const
 
OdGeExternalSurfacesetToOwnSurface ()
 
- 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 unbounded surfaces, whose definitions are external to the OdGe library, as OdGeSurface.

Remarks
OdGeExternalSurface instances can be treated as any other OdGeSurface.

You can access the OdGeExternalSurface 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 OdGeExternalSurface is to access an ACIS surface.

Corresponding C++ library: TD_Ge

<group OdGe_Classes>

Definition at line 55 of file GeExternalSurface.h.

Constructor & Destructor Documentation

◆ OdGeExternalSurface() [1/3]

OdGeExternalSurface::OdGeExternalSurface ( )

Default constructor for the OdGeExternalSurface class. Constructs an undefined external surface.

◆ OdGeExternalSurface() [2/3]

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

Constructor for the OdGeExternalSurface class.

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.

◆ OdGeExternalSurface() [3/3]

OdGeExternalSurface::OdGeExternalSurface ( const OdGeExternalSurface source)

Copy constructor for the OdGeExternalSurface class.

Parameters
source[in] Object to be copied.

Member Function Documentation

◆ externalSurfaceKind()

OdGe::ExternalEntityKind OdGeExternalSurface::externalSurfaceKind ( ) const

Rerurns information about the system that created the surface.

Remarks
Possible values for externalSurfaceKind:

@untitled table kAcisEntity kExternalEntityUndefined

◆ getExternalSurface()

void OdGeExternalSurface::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 OdGeExternalSurface::isCone ( ) const

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

◆ isCylinder()

bool OdGeExternalSurface::isCylinder ( ) const

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

◆ isDefined()

bool OdGeExternalSurface::isDefined ( ) const

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

◆ isEllipCone()

bool OdGeExternalSurface::isEllipCone ( ) const

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

◆ isEllipCylinder()

bool OdGeExternalSurface::isEllipCylinder ( ) const

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

◆ isNativeSurface()

bool OdGeExternalSurface::isNativeSurface ( OdGeSurface *&  nativeSurface) const

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

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

◆ isNurbSurface()

bool OdGeExternalSurface::isNurbSurface ( ) const

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

◆ isOwnerOfSurface()

bool OdGeExternalSurface::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 surface is destroyed.

◆ isPlane()

bool OdGeExternalSurface::isPlane ( ) const

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

◆ isSphere()

bool OdGeExternalSurface::isSphere ( ) const

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

◆ isTorus()

bool OdGeExternalSurface::isTorus ( ) const

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

◆ operator=()

OdGeExternalSurface & OdGeExternalSurface::operator= ( const OdGeExternalSurface extSurf)

Assignment operator for the OdGeExternalSurface class.

Parameters
extSurf[in] External surface to assign.
Returns
Reference to this OdGeExternalSurface.

◆ set()

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

Sets the parameters for this external 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()

OdGeExternalSurface & OdGeExternalSurface::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: