#include <GePlanarEnt.h>

Inheritance diagram for OdGePlanarEnt:

Public Member Functions
	GE_OPERATORS_OVERRIDE_3D (OdGePlanarEnt)

bool	isOnPlane (const OdGePoint3d &point, const OdGeTol &tol=OdGeContext::gTol) const

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

OdGePlanarEnt &	operator= (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
	GE_OPERATORS_OVERRIDE_3D (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

OdGeSurface &	reverseNormal ()

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

OdGeSurface &	operator= (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)

OdGeCurve3d *	makeIsoparamCurve (bool byU, double param) const

OdGeCurve3d *	makeIsoparamCurve (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

OdGeEntity3d *	copy () const

OdGeEntity3d &	operator= (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

OdGeEntity3d &	transformBy (const OdGeMatrix3d &xfm)

OdGeEntity3d &	translateBy (const OdGeVector3d &translateVec)

OdGeEntity3d &	rotateBy (double angle, const OdGeVector3d &vect, const OdGePoint3d &basePoint=OdGePoint3d::kOrigin)

OdGeEntity3d &	mirror (const OdGePlane &plane)

OdGeEntity3d &	scaleBy (double scaleFactor, const OdGePoint3d &basePoint=OdGePoint3d::kOrigin)

bool	isOn (const OdGePoint3d &point, const OdGeTol &tol=OdGeContext::gTol) const

Protected Member Functions
	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 is the base class for all OdGe planes in 3D space.

Remarks

A parametric point on the plane with parameters u and v maps to the point S(u,v) as follows

      <pre>
      S(u,v) = originOfPlanarEntity + (u * uAxis) + (v * vAxis)
      </pre>

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 as follows

Description Computed as origin Origin of plane. origin
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 a plane is as follows

      <pre>
      a * X + b * Y + c * Z + d = 0
      </pre>

Corresponding C++ library: TD_Ge

Definition at line 67 of file GePlanarEnt.h.

Constructor & Destructor Documentation

◆ OdGePlanarEnt() [1/2]

OdGePlanarEnt::OdGePlanarEnt ( )

protected

◆ OdGePlanarEnt() [2/2]

OdGePlanarEnt::OdGePlanarEnt ( const OdGePlanarEnt & plane )

protected

Member Function Documentation

◆ closestPointToLinearEnt()

OdGePoint3d OdGePlanarEnt::closestPointToLinearEnt	(	const OdGeLinearEnt3d &	line,
		OdGePoint3d &	pointOnLine,
		const OdGeTol &	tol = OdGeContext::gTol ) const

Returns the point on this plane that is closest to the specified linear entity, and the point on the linear entity that is closest to this plane.

Parameters

line	[in] A 3D linear entity for which the closest point is computed.
pointOnLine	[out] Receives the closest point on the linear entity.
tol	[in] Geometric tolerance.

◆ closestPointToPlanarEnt()

OdGePoint3d OdGePlanarEnt::closestPointToPlanarEnt	(	const OdGePlanarEnt &	plane,
		OdGePoint3d &	pointOnOtherPlane,
		const OdGeTol &	tol = OdGeContext::gTol ) const

Returns the point on this plane that is closest to the specified plane, and the point on the specified plane that is closest to this plane.

Parameters

plane	[in] Any planar entity to which the closest point is computed.
pointOnOtherPlane	[out] Receives the closest point on the plane.
tol	[in] Geometric tolerance.

◆ GE_OPERATORS_OVERRIDE_3D()

OdGePlanarEnt::GE_OPERATORS_OVERRIDE_3D ( OdGePlanarEnt )

◆ get() [1/2]

void OdGePlanarEnt::get	(	OdGePoint3d &	origin,
		OdGeVector3d &	uAxis,
		OdGeVector3d &	vAxis ) const

Returns the parameters of this plane.

Parameters

origin	[in] The origin of this plane.
uAxis	[in] The U-axis.
vAxis	[in] The V-axis.

Remarks

The U-axis and V-axis cannot be collinear, and are defined as follows

    <pre>
    uAxis=uPnt-origin
    vAxis=vPnt-origin
    </pre>

◆ get() [2/2]

void OdGePlanarEnt::get	(	OdGePoint3d &	uPnt,
		OdGePoint3d &	origin,
		OdGePoint3d &	vPnt ) const

Returns the parameters of this plane.

Parameters

origin	[in] The origin of this plane.
uPnt	[in] A point at the end of the U-axis.
vPnt	[in] A point at the end of the V-axis.

Remarks

The U-axis and V-axis cannot be collinear, and are defined as follows

    <pre>
    uAxis=uPnt-origin
    vAxis=vPnt-origin
    </pre>

◆ getCoefficients()

void OdGePlanarEnt::getCoefficients	(	double &	a,
		double &	b,
		double &	c,
		double &	d ) const

Returns the coefficients of the plane equation for this plane.

Parameters

a	[out] Receives the coefficient a.
b	[out] Receives the coefficient b.
c	[out] Receives the coefficient c.
d	[out] Receives the coefficient d.

◆ getCoordSystem()

void OdGePlanarEnt::getCoordSystem	(	OdGePoint3d &	origin,
		OdGeVector3d &	axis1,
		OdGeVector3d &	axis2 ) const

Returns the orthonormal canonical coordinate system of this plane.

Parameters

origin	[out] Receives the origin of this plane
axis1	[out] Receives a unit vector in the plane.
axis2	[out] Receives a unit vector perpendicular to the plane.

◆ intersectWith()

bool OdGePlanarEnt::intersectWith	(	const OdGeLinearEnt3d &	line,
		OdGePoint3d &	point,
		const OdGeTol &	tol = OdGeContext::gTol ) const

Returns true and the intersection with the specified linear entity, if and only if the specified linear entity intersects with this plane.

Parameters

line	[in] A 3D linear entity with which the intersection is computed.
point	[out] Receives the point of intersection.
tol	[in] Geometric tolerance.

◆ isCoplanarTo()

bool OdGePlanarEnt::isCoplanarTo	(	const OdGePlanarEnt &	plane,
		const OdGeTol &	tol = OdGeContext::gTol ) const

Returns true if and only if the specified plane is coplanar with this one.

Parameters

plane	[in] Any plane that is tested to be coplanar to this planar entity.
tol	[in] Geometric tolerance.

◆ isOnPlane()

bool OdGePlanarEnt::isOnPlane	(	const OdGePoint3d &	point,
		const OdGeTol &	tol = OdGeContext::gTol ) const

Returns true if and only if the specified point is on this plane, regardless of the envelope, as determined by the tolerance.

Parameters

point	[in] Point to be queried.
tol	[in] Geometric tolerance.

◆ isParallelTo() [1/2]

bool OdGePlanarEnt::isParallelTo	(	const OdGeLinearEnt3d &	line,
		const OdGeTol &	tol = OdGeContext::gTol ) const

Returns true if and only if the specified entity is parallel to this one.

Parameters

line	[in] Any 3D linear entity that is tested to be parallel to this planar entity.
tol	[in] Geometric tolerance.

◆ isParallelTo() [2/2]

bool OdGePlanarEnt::isParallelTo	(	const OdGePlanarEnt &	plane,
		const OdGeTol &	tol = OdGeContext::gTol ) const

Returns true if and only if the specified entity is parallel to this one.

Parameters

plane	[in] Any planar entity that is tested to be parallel to this planar entity.
tol	[in] Geometric tolerance.

◆ isPerpendicularTo() [1/2]

bool OdGePlanarEnt::isPerpendicularTo	(	const OdGeLinearEnt3d &	line,
		const OdGeTol &	tol = OdGeContext::gTol ) const

Returns true if and only if the specified entity is perpendicular to this one.

Parameters

line	[in] Any 3D linear entity that is tested to be perpendicular to this planar entity.
tol	[in] Geometric tolerance.

◆ isPerpendicularTo() [2/2]

bool OdGePlanarEnt::isPerpendicularTo	(	const OdGePlanarEnt &	plane,
		const OdGeTol &	tol = OdGeContext::gTol ) const

Returns true if and only if the specified entity is perpendicular to this one.

Parameters

plane	[in] Any planar entity that is tested to be perpendicular to this planar entity.
tol	[in] Geometric tolerance.

◆ normal()

OdGeVector3d OdGePlanarEnt::normal ( ) const

Returns the normal to the plane as a unit vector.

◆ operator=()

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

Assignment operator for the OdGePlanarEnt object.

Parameters

plane [in] Planar entity to assign.

Returns: Reference to this OdGePlanarEnt object.

◆ pointOnPlane()

OdGePoint3d OdGePlanarEnt::pointOnPlane ( ) const

Returns an arbitrary point on the plane.

◆ project()

bool OdGePlanarEnt::project	(	const OdGePoint3d &	p,
		const OdGeVector3d &	unitDir,
		OdGePoint3d &	projP,
		const OdGeTol &	tol = OdGeContext::gTol ) const

Projects a point onto this surface in given direction.

Parameters

p	[in] Any 3D point.
unitDir	[in] Unit vector specifying the projection direction.
projP	[out] Receives the point on this surface.
tol	[in] Geometric tolerance.

Returns: true if and only if there is a point on this surface, projP, where unitDir passes through the point p.

◆ TD_USING()

OdGePlanarEnt::TD_USING ( OdGeSurface::project )

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

GePlanarEnt.h

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ OdGePlanarEnt() [1/2]

◆ OdGePlanarEnt() [2/2]

Member Function Documentation

◆ closestPointToLinearEnt()

◆ closestPointToPlanarEnt()

◆ GE_OPERATORS_OVERRIDE_3D()

◆ get() [1/2]

◆ get() [2/2]

◆ getCoefficients()

◆ getCoordSystem()

◆ intersectWith()

◆ isCoplanarTo()

◆ isOnPlane()

◆ isParallelTo() [1/2]

◆ isParallelTo() [2/2]

◆ isPerpendicularTo() [1/2]

◆ isPerpendicularTo() [2/2]

◆ normal()

◆ operator=()

◆ pointOnPlane()

◆ project()

◆ TD_USING()