OdGePoint3d Class Reference

#include <GePoint3d.h>

Public Member Functions
	OdGePoint3d ()
	OdGePoint3d (double xx, double yy, double zz)
	OdGePoint3d (const OdGePlanarEnt &plane, const OdGePoint2d &pnt2d)
OdGePoint3d &	setToProduct (const OdGeMatrix3d &xfm, const OdGePoint3d &point)
OdGePoint3d &	transformBy (const OdGeMatrix3d &xfm)
OdGePoint3d &	rotateBy (double angle, const OdGeVector3d &vect, const OdGePoint3d &basePoint=OdGePoint3d::kOrigin)
OdGePoint3d &	mirror (const OdGePlane &plane)
OdGePoint3d &	scaleBy (double scaleFactor, const OdGePoint3d &basePoint=OdGePoint3d::kOrigin)
OdGePoint2d	convert2d (const OdGePlanarEnt &plane) const
OdGePoint2d	convert2d () const
OdGePoint3d	operator* (double scale) const
OdGePoint3d &	operator*= (double scale)
OdGePoint3d	operator/ (double scale) const
OdGePoint3d &	operator/= (double scale)
OdGePoint3d	operator+ (const OdGeVector3d &vect) const
OdGePoint3d &	operator+= (const OdGeVector3d &vect)
OdGePoint3d	operator- (const OdGeVector3d &vect) const
OdGePoint3d &	operator-= (const OdGeVector3d &vect)
OdGePoint3d &	setToSum (const OdGePoint3d &point, const OdGeVector3d &vect)
OdGeVector3d	operator- (const OdGePoint3d &point) const
const OdGeVector3d &	asVector () const
double	distanceTo (const OdGePoint3d &point) const
OdGePoint3d	project (const OdGePlane &plane, const OdGeVector3d &vect) const
OdGePoint3d	orthoProject (const OdGePlane &plane) const
bool	operator== (const OdGePoint3d &point) const
bool	operator!= (const OdGePoint3d &point) const
bool	isEqualTo (const OdGePoint3d &point, const OdGeTol &tol=OdGeContext::gTol) const
double	operator[] (unsigned int i) const
double &	operator[] (unsigned int i)
OdGePoint3d &	set (double xx, double yy, double zz)
OdGePoint3d &	set (const OdGePlanarEnt &plane, const OdGePoint2d &point)
OdGePoint3d &	swapWithPoint (OdGePoint3d &point)

Public Attributes
double	x
double	y
double	z

Static Public Attributes
static GE_STATIC_EXPORT const OdGePoint3d	kOrigin

Friends
GE_TOOLKIT_EXPORT OdGePoint3d	operator* (const OdGeMatrix3d &matrix, const OdGePoint3d &point)
GE_TOOLKIT_EXPORT OdGePoint3d	operator* (double scale, const OdGePoint3d &point)

Detailed Description

This class represents points (locations) in 3D space.

Remarks

OdGePoint3d may be viewed as an array[3] of doubles.

Corresponding C++ library: TD_Ge

<group OdGe_Classes>

See also

<link ge_BasicTypes.html, Working with Basic Geometry Types>

Definition at line 54 of file GePoint3d.h.

Constructor & Destructor Documentation

OdGePoint3d() [1/3]

OdGePoint3d::OdGePoint3d ( )

inline

Parameters

xx	[in] The X-coordinate of this point.
yy	[in] The Y-coordinate of this point.
zz	[in] The Z-coordinate of this point.
plane	[in] Any plane.
pnt2d	[in] Any 2D point.
source	[in] Object to be cloned.

Remarks

plane and pnt2d define a point as follows:

    p + uAxis * pnt2d.x + vAxis * pnt2d.y,

where p, uAxis, and vAxis are returned by the function call plane.get (p, uAxis, vAxis);

With no arguments, creates a point at the origin.

Definition at line 73 of file GePoint3d.h.

OdGePoint3d() [2/3]

OdGePoint3d::OdGePoint3d ( double  xx, double  yy, double  zz  )

inline

Definition at line 77 of file GePoint3d.h.

OdGePoint3d() [3/3]

OdGePoint3d::OdGePoint3d	(	const OdGePlanarEnt &	plane,
		const OdGePoint2d &	pnt2d
	)

Member Function Documentation

asVector()

const OdGeVector3d& OdGePoint3d::asVector ( ) const

inline

Returns this point as a vector.

Definition at line 246 of file GePoint3d.h.

convert2d() [1/2]

OdGePoint2d OdGePoint3d::convert2d ( ) const

inline

Definition at line 162 of file GePoint3d.h.

convert2d() [2/2]

OdGePoint2d OdGePoint3d::convert2d

(

const OdGePlanarEnt &

plane

)

const

Projects this point onto the specified plane.

Parameters

plane

[in] Any plane.

Remarks, If no plane is specified, this point is projected into the XY plane.

distanceTo()

double OdGePoint3d::distanceTo

(

const OdGePoint3d &

point

)

const

Returns the distance from this point to the specified point.

Parameters

point

[in] Any 3D point.

isEqualTo()

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

Returns true if and only if the distance from this point to point is within the specified tolerance.

Parameters

point	[in] Any 3D point.
tol	[in] Geometric tolerance.

mirror()

OdGePoint3d& OdGePoint3d::mirror

(

const OdGePlane &

plane

)

Mirrors this point about the specified plane.

Parameters

line	[in] Mirror Line.

operator!=()

bool OdGePoint3d::operator!= ( const OdGePoint3d &  point ) const

inline

Definition at line 283 of file GePoint3d.h.

operator*()

OdGePoint3d OdGePoint3d::operator* ( double  scale ) const

inline

Definition at line 167 of file GePoint3d.h.

operator*=()

OdGePoint3d& OdGePoint3d::operator*= ( double  scale )

inline

Definition at line 173 of file GePoint3d.h.

operator+()

OdGePoint3d OdGePoint3d::operator+ ( const OdGeVector3d &  vect ) const

inline

Definition at line 197 of file GePoint3d.h.

operator+=()

OdGePoint3d& OdGePoint3d::operator+= ( const OdGeVector3d &  vect )

inline

Definition at line 203 of file GePoint3d.h.

operator-() [1/2]

OdGeVector3d OdGePoint3d::operator- ( const OdGePoint3d &  point ) const

inline

Definition at line 237 of file GePoint3d.h.

operator-() [2/2]

OdGePoint3d OdGePoint3d::operator- ( const OdGeVector3d &  vect ) const

inline

Definition at line 212 of file GePoint3d.h.

operator-=()

OdGePoint3d& OdGePoint3d::operator-= ( const OdGeVector3d &  vect )

inline

Definition at line 218 of file GePoint3d.h.

operator/()

OdGePoint3d OdGePoint3d::operator/ ( double  scale ) const

inline

Definition at line 182 of file GePoint3d.h.

operator/=()

OdGePoint3d& OdGePoint3d::operator/= ( double  scale )

inline

Definition at line 188 of file GePoint3d.h.

operator==()

bool OdGePoint3d::operator== ( const OdGePoint3d &  point ) const

inline

Definition at line 277 of file GePoint3d.h.

operator[]() [1/2]

double& OdGePoint3d::operator[] ( unsigned int  i )

inline

Definition at line 315 of file GePoint3d.h.

operator[]() [2/2]

double OdGePoint3d::operator[] ( unsigned int  i ) const

inline

Parameters

i	[in] Index of coordinate.

Returns or references the ith coordinate of this point.

Remarks

0 returns or references the X-coordinate. 1 returns or references the Y-coordinate. 2 returns or references the Z-coordinate.

Definition at line 309 of file GePoint3d.h.

orthoProject()

OdGePoint3d OdGePoint3d::orthoProject

(

const OdGePlane &

plane

)

const

Projects this point onto the specified plane along the normal to the plane.

Parameters

plane

[in] Plane on which this point is to be projected

project()

OdGePoint3d OdGePoint3d::project	(	const OdGePlane &	plane,
		const OdGeVector3d &	vect
	)		const

Projects this point onto the specified plane along the specified vector.

Parameters

plane	[in] Plane on which this point is to be projected
vect	[in] Vector defining the projection direction.

rotateBy()

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

Rotates this point about the specified basePoint and axis of rotation by the specified angle.

Parameters

angle	[in] Rotation angle.
basePoint	[in] Basepoint.
vect	[in] Axis of rotation.

scaleBy()

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

Scales this point by the scale factor about the basepoint.

Parameters

scaleFactor	[in] Scale Factor. The scale factor must be greater than zero.
basePoint	[in] Basepoint.

set() [1/2]

OdGePoint3d& OdGePoint3d::set	(	const OdGePlanarEnt &	plane,
		const OdGePoint2d &	point
	)

Sets the parameters for this point according to the arguments

Parameters

plane	[in] Any plane.
point	[in] Any 2D point.

Remarks

Returns a reference to this point.

plane and pnt2d define a point as follows:

    p + uAxis * point.x + vAxis * point.y,

where p, uAxis, and vAxis are returned by the function call plane.get (p, uAxis, vAxis);

set() [2/2]

OdGePoint3d& OdGePoint3d::set ( double  xx, double  yy, double  zz  )

inline

Sets the parameters for this point according to the arguments

Parameters

xx	[in] The X-coordinate of this point.
yy	[in] The Y-coordinate of this point.
zz	[in] The Z-coordinate of this point.

Remarks

Returns a reference to this point.

plane and pnt2d define a point as follows:

    p + uAxis * point.x + vAxis * point.y,

where p, uAxis, and vAxis are returned by the function call plane.get (p, uAxis, vAxis);

Definition at line 337 of file GePoint3d.h.

setToProduct()

OdGePoint3d& OdGePoint3d::setToProduct	(	const OdGeMatrix3d &	xfm,
		const OdGePoint3d &	point
	)

Sets this point to the product of xfm * point, and returns a reference to this point.

Parameters

xfm	[in] A 3D matrix.
point	[in] Any 3D point.

setToSum()

OdGePoint3d& OdGePoint3d::setToSum	(	const OdGePoint3d &	point,
		const OdGeVector3d &	vect
	)

Sets this point to point + vect, and returns a reference to this point.

Parameters

point	[in] Any 3D point.
vect	[in] Any 3D vector.

swapWithPoint()

OdGePoint3d& OdGePoint3d::swapWithPoint

(

OdGePoint3d &

point

)

transformBy()

OdGePoint3d& OdGePoint3d::transformBy

(

const OdGeMatrix3d &

xfm

)

Sets this point to the result of the matrix multiplication xfm this point*. Returns a reference to this point.

Parameters

xfm	[in] A 3D matrix.

Friends And Related Function Documentation

operator* [1/2]

GE_TOOLKIT_EXPORT OdGePoint3d operator* ( const OdGeMatrix3d &  matrix, const OdGePoint3d &  point  )

friend

operator* [2/2]

GE_TOOLKIT_EXPORT OdGePoint3d operator* ( double  scale, const OdGePoint3d &  point  )

friend

Definition at line 95 of file GePoint3d.h.

Member Data Documentation

kOrigin

GE_STATIC_EXPORT const OdGePoint3d OdGePoint3d::kOrigin

static

Definition at line 89 of file GePoint3d.h.

x

double OdGePoint3d::x

Definition at line 367 of file GePoint3d.h.

y

double OdGePoint3d::y

Definition at line 368 of file GePoint3d.h.

z

double OdGePoint3d::z

Definition at line 369 of file GePoint3d.h.

---

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

• GePoint3d.h