CFx SDK Documentation  2022 SP0
Public Member Functions | Static Public Attributes | List of all members
OdGePlane Class Reference

#include <GePlane.h>

Inheritance diagram for OdGePlane:
OdGePlanarEnt OdGeSurface OdGeEntity3d

Public Member Functions

 OdGePlane ()
 
 OdGePlane (const OdGePlane &plane)
 
 OdGePlane (const OdGePoint3d &origin, const OdGeVector3d &normal)
 
 OdGePlane (const OdGePoint3d &uPnt, const OdGePoint3d &origin, const OdGePoint3d &vPnt)
 
 OdGePlane (const OdGePoint3d &origin, const OdGeVector3d &uAxis, const OdGeVector3d &vAxis)
 
 OdGePlane (double a, double b, double c, double d)
 
 TD_USING (OdGePlanarEnt::intersectWith)
 
bool intersectWith (const OdGePlane &plane, OdGeLine3d &intLine, const OdGeTol &tol=OdGeContext::gTol) const
 
bool intersectWith (const OdGeBoundedPlane &plane, OdGeLineSeg3d &intLine, const OdGeTol &tol=OdGeContext::gTol) const
 
double signedDistanceTo (const OdGePoint3d &point) const
 
OdGePlaneset (const OdGePoint3d &point, const OdGeVector3d &normal)
 
OdGePlaneset (const OdGePoint3d &uPnt, const OdGePoint3d &origin, const OdGePoint3d &vPnt)
 
OdGePlaneset (double a, double b, double c, double d)
 
OdGePlaneset (const OdGePoint3d &origin, const OdGeVector3d &uAxis, const OdGeVector3d &vAxis)
 
OdGePlaneoperator= (const OdGePlane &plane)
 
- Public Member Functions inherited from OdGePlanarEnt
bool intersectWith (const OdGeLinearEnt3d &line, OdGePoint3d &point, const OdGeTol &tol=OdGeContext::gTol) const
 
OdGePoint3d closestPointToLinearEnt (const OdGeLinearEnt3d &line, OdGePoint3d &pointOnLine, const OdGeTol &tol=OdGeContext::gTol) const
 
OdGePoint3d closestPointToPlanarEnt (const OdGePlanarEnt &plane, OdGePoint3d &pointOnOtherPlane, const OdGeTol &tol=OdGeContext::gTol) const
 
bool isParallelTo (const OdGeLinearEnt3d &line, const OdGeTol &tol=OdGeContext::gTol) const
 
bool isParallelTo (const OdGePlanarEnt &plane, const OdGeTol &tol=OdGeContext::gTol) const
 
bool isPerpendicularTo (const OdGeLinearEnt3d &line, const OdGeTol &tol=OdGeContext::gTol) const
 
bool isPerpendicularTo (const OdGePlanarEnt &plane, const OdGeTol &tol=OdGeContext::gTol) const
 
bool isCoplanarTo (const OdGePlanarEnt &plane, const OdGeTol &tol=OdGeContext::gTol) const
 
void get (OdGePoint3d &origin, OdGeVector3d &uAxis, OdGeVector3d &vAxis) const
 
void get (OdGePoint3d &uPnt, OdGePoint3d &origin, OdGePoint3d &vPnt) const
 
OdGePoint3d pointOnPlane () const
 
OdGeVector3d normal () const
 
void getCoefficients (double &a, double &b, double &c, double &d) const
 
void getCoordSystem (OdGePoint3d &origin, OdGeVector3d &axis1, OdGeVector3d &axis2) const
 
OdGePlanarEntoperator= (const OdGePlanarEnt &plane)
 
 TD_USING (OdGeSurface::project)
 
bool project (const OdGePoint3d &p, const OdGeVector3d &unitDir, OdGePoint3d &projP, const OdGeTol &tol=OdGeContext::gTol) const
 
- Public Member Functions inherited from OdGeSurface
OdGePoint2d paramOf (const OdGePoint3d &point, 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
 
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
 
OdGeSurfacereverseNormal ()
 
void getEnvelope (OdGeInterval &intrvlU, OdGeInterval &intrvlV) 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)
 
bool project (const OdGePoint3d &p, OdGePoint3d &projP, const OdGeTol &tol=OdGeContext::gTol) const
 
bool getReparameterization (bool &swapUV, double &uCoeffA, double &vCoeffA, double &uCoeffB, double &vCoeffB) const
 
void setReparameterization (bool swapUV=false, double uCoeffA=1., double vCoeffA=1., double uCoeffB=0., double vCoeffB=0.)
 
void getImplicitEnvelope (OdGeInterval &implicitIntrvlU, OdGeInterval &implicitIntrvlV) const
 
bool setEnvelope (const OdGeInterval &realIntrvlU, const OdGeInterval &realIntrvlV)
 
- 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
 

Static Public Attributes

static GE_STATIC_EXPORT const OdGePlane kXYPlane
 
static GE_STATIC_EXPORT const OdGePlane kYZPlane
 
static GE_STATIC_EXPORT const OdGePlane kZXPlane
 

Additional Inherited Members

- Protected Member Functions inherited from OdGePlanarEnt
 OdGePlanarEnt ()
 
 OdGePlanarEnt (const OdGePlanarEnt &plane)
 
- 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 infinite planes in 3D space.

Corresponding C++ library: TD_Ge

<group OdGe_Classes>

See also
<link ge_OdGePlane.html, Working with Planes>

Definition at line 44 of file GePlane.h.

Constructor & Destructor Documentation

◆ OdGePlane() [1/6]

OdGePlane::OdGePlane ( )
Parameters
origin[in] Origin of plane.
normal[in] The normal to the plane.
uPnt[in] A point at the end of the U-axis.
vPnt[in] A point at the end of the V-axis.
uAxis[in] The U-axis.
vAxis[in] The V-axis.
a[in] Coefficient a.
b[in] Coefficient b.
c[in] Coefficient c.
d[in] Coefficient d.
Remarks
A parametric point on the plane with parameters u and v maps to the point S(u,v) as follows
    S(u,v) = originOfPlanarEntity + (u * uAxis) + (v * vAxis)
uAxis and vAxis need not be either normalized or perpendicular, but they must not be collinear.

The orthonormal canonical coordinate system associated with a plane defined follows

@untitled table origin Origin of plane. originOfPlanarEntiity
axis1 A unit vector in the plane. uAxis.normal()
axis2 A unit vector perpendicular to the plane. uAxis.crossProduct(vAxis).normal()

The plane equation for this plane is as follows

    a * X + b * Y + c * Z + d = 0

◆ OdGePlane() [2/6]

OdGePlane::OdGePlane ( const OdGePlane plane)

◆ OdGePlane() [3/6]

OdGePlane::OdGePlane ( const OdGePoint3d origin,
const OdGeVector3d normal 
)

◆ OdGePlane() [4/6]

OdGePlane::OdGePlane ( const OdGePoint3d uPnt,
const OdGePoint3d origin,
const OdGePoint3d vPnt 
)

◆ OdGePlane() [5/6]

OdGePlane::OdGePlane ( const OdGePoint3d origin,
const OdGeVector3d uAxis,
const OdGeVector3d vAxis 
)

◆ OdGePlane() [6/6]

OdGePlane::OdGePlane ( double  a,
double  b,
double  c,
double  d 
)

Member Function Documentation

◆ intersectWith() [1/2]

bool OdGePlane::intersectWith ( const OdGeBoundedPlane plane,
OdGeLineSeg3d intLine,
const OdGeTol tol = OdGeContext::gTol 
) const

◆ intersectWith() [2/2]

bool OdGePlane::intersectWith ( const OdGePlane plane,
OdGeLine3d intLine,
const OdGeTol tol = OdGeContext::gTol 
) const

◆ operator=()

OdGePlane& OdGePlane::operator= ( const OdGePlane plane)

◆ set() [1/4]

OdGePlane& OdGePlane::set ( const OdGePoint3d origin,
const OdGeVector3d uAxis,
const OdGeVector3d vAxis 
)

Sets the parameters for this plane according to the arguments.

Parameters
origin[in] Origin of plane.
uAxis[in] The U-axis.
vAxis[in] The V-axis.
Returns
Returns a reference to this plane.
Remarks
A parametric point on the plane with parameters u and v maps to the point S(u,v) as follows
    S(u,v) = originOfPlanarEntity + (u * uAxis) + (v * vAxis)
uAxis and vAxis need not be either normalized or perpendicular, but they must not be collinear.

The orthonormal canonical coordinate system associated with a plane defined follows

@untitled table origin Origin of plane. originOfPlanarEntiity
axis1 A unit vector in the plane. uAxis.normal()
axis2 A unit vector perpendicular to the plane. uAxis.crossProduct(vAxis).normal()

The plane equation for this plane is as follows

    a * X + b * Y + c * Z + d = 0

◆ set() [2/4]

OdGePlane& OdGePlane::set ( const OdGePoint3d point,
const OdGeVector3d normal 
)

Sets the parameters for this plane according to the arguments.

Parameters
normal[in] The normal to the plane.
Returns
Returns a reference to this plane.
Remarks
A parametric point on the plane with parameters u and v maps to the point S(u,v) as follows
    S(u,v) = originOfPlanarEntity + (u * uAxis) + (v * vAxis)
uAxis and vAxis need not be either normalized or perpendicular, but they must not be collinear.

The orthonormal canonical coordinate system associated with a plane defined follows

@untitled table origin Origin of plane. originOfPlanarEntiity
axis1 A unit vector in the plane. uAxis.normal()
axis2 A unit vector perpendicular to the plane. uAxis.crossProduct(vAxis).normal()

The plane equation for this plane is as follows

    a * X + b * Y + c * Z + d = 0

◆ set() [3/4]

OdGePlane& OdGePlane::set ( const OdGePoint3d uPnt,
const OdGePoint3d origin,
const OdGePoint3d vPnt 
)

Sets the parameters for this plane according to the arguments.

Parameters
origin[in] Origin of plane.
uPnt[in] A point at the end of the U-axis.
vPnt[in] A point at the end of the V-axis.
Returns
Returns a reference to this plane.
Remarks
A parametric point on the plane with parameters u and v maps to the point S(u,v) as follows
    S(u,v) = originOfPlanarEntity + (u * uAxis) + (v * vAxis)
uAxis and vAxis need not be either normalized or perpendicular, but they must not be collinear.

The orthonormal canonical coordinate system associated with a plane defined follows

@untitled table origin Origin of plane. originOfPlanarEntiity
axis1 A unit vector in the plane. uAxis.normal()
axis2 A unit vector perpendicular to the plane. uAxis.crossProduct(vAxis).normal()

The plane equation for this plane is as follows

    a * X + b * Y + c * Z + d = 0

◆ set() [4/4]

OdGePlane& OdGePlane::set ( double  a,
double  b,
double  c,
double  d 
)

Sets the parameters for this plane according to the arguments.

Parameters
a[in] Coefficient a.
b[in] Coefficient b.
c[in] Coefficient c.
d[in] Coefficient d.
Returns
Returns a reference to this plane.
Remarks
A parametric point on the plane with parameters u and v maps to the point S(u,v) as follows
    S(u,v) = originOfPlanarEntity + (u * uAxis) + (v * vAxis)
uAxis and vAxis need not be either normalized or perpendicular, but they must not be collinear.

The orthonormal canonical coordinate system associated with a plane defined follows

@untitled table origin Origin of plane. originOfPlanarEntiity
axis1 A unit vector in the plane. uAxis.normal()
axis2 A unit vector perpendicular to the plane. uAxis.crossProduct(vAxis).normal()

The plane equation for this plane is as follows

    a * X + b * Y + c * Z + d = 0

◆ signedDistanceTo()

double OdGePlane::signedDistanceTo ( const OdGePoint3d point) const

Returns the signed distance to (elevation of) the specified point.

Parameters
point[in] Any 3D point.

◆ TD_USING()

OdGePlane::TD_USING ( OdGePlanarEnt::intersectWith  )

Returns true and the intersection point or line, if and only if the specified line or plane intersects with this plane.

Parameters
line[in] Any 3D linear entity.
plane[in] Any plane.
intLine[out] Receives the intersection line.
point[out] Receives the intersection point.
tol[in] Geometric tolerance.

Member Data Documentation

◆ kXYPlane

GE_STATIC_EXPORT const OdGePlane OdGePlane::kXYPlane
static

Definition at line 49 of file GePlane.h.

◆ kYZPlane

GE_STATIC_EXPORT const OdGePlane OdGePlane::kYZPlane
static

Definition at line 50 of file GePlane.h.

◆ kZXPlane

GE_STATIC_EXPORT const OdGePlane OdGePlane::kZXPlane
static

Definition at line 51 of file GePlane.h.


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