gp_Pnt Class Reference

Defines a 3D cartesian point. More...

#include <gp_Pnt.hxx>

Public Member Functions
	gp_Pnt ()
	Creates a point with zero coordinates. More...
	gp_Pnt (const gp_XYZ &Coord)
	Creates a point from a XYZ object. More...
	gp_Pnt (const Standard_Real Xp, const Standard_Real Yp, const Standard_Real Zp)
	Creates a point with its 3 cartesian's coordinates : Xp, Yp, Zp. More...
void	SetCoord (const Standard_Integer Index, const Standard_Real Xi)
	Changes the coordinate of range Index : Index = 1 => X is modified Index = 2 => Y is modified Index = 3 => Z is modified Raised if Index != {1, 2, 3}. More...
void	SetCoord (const Standard_Real Xp, const Standard_Real Yp, const Standard_Real Zp)
	For this point, assigns the values Xp, Yp and Zp to its three coordinates. More...
void	SetX (const Standard_Real X)
	Assigns the given value to the X coordinate of this point. More...
void	SetY (const Standard_Real Y)
	Assigns the given value to the Y coordinate of this point. More...
void	SetZ (const Standard_Real Z)
	Assigns the given value to the Z coordinate of this point. More...
void	SetXYZ (const gp_XYZ &Coord)
	Assigns the three coordinates of Coord to this point. More...
Standard_Real	Coord (const Standard_Integer Index) const
	Returns the coordinate of corresponding to the value of Index : Index = 1 => X is returned Index = 2 => Y is returned Index = 3 => Z is returned Raises OutOfRange if Index != {1, 2, 3}. Raised if Index != {1, 2, 3}. More...
void	Coord (Standard_Real &Xp, Standard_Real &Yp, Standard_Real &Zp) const
	For this point gives its three coordinates Xp, Yp and Zp. More...
Standard_Real	X () const
	For this point, returns its X coordinate. More...
Standard_Real	Y () const
	For this point, returns its Y coordinate. More...
Standard_Real	Z () const
	For this point, returns its Z coordinate. More...
const gp_XYZ &	XYZ () const
	For this point, returns its three coordinates as a XYZ object. More...
const gp_XYZ &	Coord () const
	For this point, returns its three coordinates as a XYZ object. More...
gp_XYZ &	ChangeCoord ()
	Returns the coordinates of this point. Note: This syntax allows direct modification of the returned value. More...
void	BaryCenter (const Standard_Real Alpha, const gp_Pnt &P, const Standard_Real Beta)
	Assigns the result of the following expression to this point (Alpha*this + Beta*P) / (Alpha + Beta) More...
Standard_Boolean	IsEqual (const gp_Pnt &Other, const Standard_Real LinearTolerance) const
	Comparison Returns True if the distance between the two points is lower or equal to LinearTolerance. More...
Standard_Real	Distance (const gp_Pnt &Other) const
	Computes the distance between two points. More...
Standard_Real	SquareDistance (const gp_Pnt &Other) const
	Computes the square distance between two points. More...
void	Mirror (const gp_Pnt &P)
	Performs the symmetrical transformation of a point with respect to the point P which is the center of the symmetry. More...
gp_Pnt	Mirrored (const gp_Pnt &P) const
	Performs the symmetrical transformation of a point with respect to an axis placement which is the axis of the symmetry. More...
void	Mirror (const gp_Ax1 &A1)
gp_Pnt	Mirrored (const gp_Ax1 &A1) const
	Performs the symmetrical transformation of a point with respect to a plane. The axis placement A2 locates the plane of the symmetry : (Location, XDirection, YDirection). More...
void	Mirror (const gp_Ax2 &A2)
gp_Pnt	Mirrored (const gp_Ax2 &A2) const
	Rotates a point. A1 is the axis of the rotation. Ang is the angular value of the rotation in radians. More...
void	Rotate (const gp_Ax1 &A1, const Standard_Real Ang)
gp_Pnt	Rotated (const gp_Ax1 &A1, const Standard_Real Ang) const
	Scales a point. S is the scaling value. More...
void	Scale (const gp_Pnt &P, const Standard_Real S)
gp_Pnt	Scaled (const gp_Pnt &P, const Standard_Real S) const
	Transforms a point with the transformation T. More...
void	Transform (const gp_Trsf &T)
gp_Pnt	Transformed (const gp_Trsf &T) const
	Translates a point in the direction of the vector V. The magnitude of the translation is the vector's magnitude. More...
void	Translate (const gp_Vec &V)
gp_Pnt	Translated (const gp_Vec &V) const
	Translates a point from the point P1 to the point P2. More...
void	Translate (const gp_Pnt &P1, const gp_Pnt &P2)
gp_Pnt	Translated (const gp_Pnt &P1, const gp_Pnt &P2) const
void	DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const
	Dumps the content of me into the stream. More...
Standard_Boolean	InitFromJson (const Standard_SStream &theSStream, Standard_Integer &theStreamPos)
	Inits the content of me from the stream. More...

Detailed Description

Defines a 3D cartesian point.

Constructor & Destructor Documentation

gp_Pnt() [1/3]

gp_Pnt::gp_Pnt

(

)

Creates a point with zero coordinates.

gp_Pnt() [2/3]

gp_Pnt::gp_Pnt

(

const gp_XYZ &

Coord

)

Creates a point from a XYZ object.

gp_Pnt() [3/3]

gp_Pnt::gp_Pnt	(	const Standard_Real	Xp,
		const Standard_Real	Yp,
		const Standard_Real	Zp
	)

Creates a point with its 3 cartesian's coordinates : Xp, Yp, Zp.

Member Function Documentation

BaryCenter()

void gp_Pnt::BaryCenter	(	const Standard_Real	Alpha,
		const gp_Pnt &	P,
		const Standard_Real	Beta
	)

Assigns the result of the following expression to this point (Alpha*this + Beta*P) / (Alpha + Beta)

ChangeCoord()

gp_XYZ& gp_Pnt::ChangeCoord

(

)

Returns the coordinates of this point. Note: This syntax allows direct modification of the returned value.

Coord() [1/3]

Standard_Real gp_Pnt::Coord

(

const Standard_Integer

Index

)

const

Returns the coordinate of corresponding to the value of Index : Index = 1 => X is returned Index = 2 => Y is returned Index = 3 => Z is returned Raises OutOfRange if Index != {1, 2, 3}. Raised if Index != {1, 2, 3}.

Coord() [2/3]

void gp_Pnt::Coord	(	Standard_Real &	Xp,
		Standard_Real &	Yp,
		Standard_Real &	Zp
	)		const

For this point gives its three coordinates Xp, Yp and Zp.

Coord() [3/3]

const gp_XYZ& gp_Pnt::Coord

(

)

const

For this point, returns its three coordinates as a XYZ object.

Distance()

Standard_Real gp_Pnt::Distance

(

const gp_Pnt &

Other

)

const

Computes the distance between two points.

DumpJson()

void gp_Pnt::DumpJson	(	Standard_OStream &	theOStream,
		Standard_Integer	theDepth = -1
	)		const

Dumps the content of me into the stream.

InitFromJson()

Standard_Boolean gp_Pnt::InitFromJson	(	const Standard_SStream &	theSStream,
		Standard_Integer &	theStreamPos
	)

Inits the content of me from the stream.

IsEqual()

Standard_Boolean gp_Pnt::IsEqual	(	const gp_Pnt &	Other,
		const Standard_Real	LinearTolerance
	)		const

Comparison Returns True if the distance between the two points is lower or equal to LinearTolerance.

Mirror() [1/3]

void gp_Pnt::Mirror

(

const gp_Pnt &

P

)

Performs the symmetrical transformation of a point with respect to the point P which is the center of the symmetry.

Mirror() [2/3]

void gp_Pnt::Mirror

(

const gp_Ax1 &

A1

)

Mirror() [3/3]

void gp_Pnt::Mirror

(

const gp_Ax2 &

A2

)

Mirrored() [1/3]

gp_Pnt gp_Pnt::Mirrored

(

const gp_Pnt &

P

)

const

Performs the symmetrical transformation of a point with respect to an axis placement which is the axis of the symmetry.

Mirrored() [2/3]

gp_Pnt gp_Pnt::Mirrored

(

const gp_Ax1 &

A1

)

const

Performs the symmetrical transformation of a point with respect to a plane. The axis placement A2 locates the plane of the symmetry : (Location, XDirection, YDirection).

Mirrored() [3/3]

gp_Pnt gp_Pnt::Mirrored

(

const gp_Ax2 &

A2

)

const

Rotates a point. A1 is the axis of the rotation. Ang is the angular value of the rotation in radians.

Rotate()

void gp_Pnt::Rotate	(	const gp_Ax1 &	A1,
		const Standard_Real	Ang
	)

Rotated()

gp_Pnt gp_Pnt::Rotated	(	const gp_Ax1 &	A1,
		const Standard_Real	Ang
	)		const

Scales a point. S is the scaling value.

Scale()

void gp_Pnt::Scale	(	const gp_Pnt &	P,
		const Standard_Real	S
	)

Scaled()

gp_Pnt gp_Pnt::Scaled	(	const gp_Pnt &	P,
		const Standard_Real	S
	)		const

Transforms a point with the transformation T.

SetCoord() [1/2]

void gp_Pnt::SetCoord	(	const Standard_Integer	Index,
		const Standard_Real	Xi
	)

Changes the coordinate of range Index : Index = 1 => X is modified Index = 2 => Y is modified Index = 3 => Z is modified Raised if Index != {1, 2, 3}.

SetCoord() [2/2]

void gp_Pnt::SetCoord	(	const Standard_Real	Xp,
		const Standard_Real	Yp,
		const Standard_Real	Zp
	)

For this point, assigns the values Xp, Yp and Zp to its three coordinates.

SetX()

void gp_Pnt::SetX

(

const Standard_Real

X

)

Assigns the given value to the X coordinate of this point.

SetXYZ()

void gp_Pnt::SetXYZ

(

const gp_XYZ &

Coord

)

Assigns the three coordinates of Coord to this point.

SetY()

void gp_Pnt::SetY

(

const Standard_Real

Y

)

Assigns the given value to the Y coordinate of this point.

SetZ()

void gp_Pnt::SetZ

(

const Standard_Real

Z

)

Assigns the given value to the Z coordinate of this point.

SquareDistance()

Standard_Real gp_Pnt::SquareDistance

(

const gp_Pnt &

Other

)

const

Computes the square distance between two points.

Transform()

void gp_Pnt::Transform

(

const gp_Trsf &

T

)

Transformed()

gp_Pnt gp_Pnt::Transformed

(

const gp_Trsf &

T

)

const

Translates a point in the direction of the vector V. The magnitude of the translation is the vector's magnitude.

Translate() [1/2]

void gp_Pnt::Translate

(

const gp_Vec &

V

)

Translate() [2/2]

void gp_Pnt::Translate	(	const gp_Pnt &	P1,
		const gp_Pnt &	P2
	)

Translated() [1/2]

gp_Pnt gp_Pnt::Translated

(

const gp_Vec &

V

)

const

Translates a point from the point P1 to the point P2.

Translated() [2/2]

gp_Pnt gp_Pnt::Translated	(	const gp_Pnt &	P1,
		const gp_Pnt &	P2
	)		const

X()

Standard_Real gp_Pnt::X

(

)

const

For this point, returns its X coordinate.

XYZ()

const gp_XYZ& gp_Pnt::XYZ

(

)

const

For this point, returns its three coordinates as a XYZ object.

Y()

Standard_Real gp_Pnt::Y

(

)

const

For this point, returns its Y coordinate.

Z()

Standard_Real gp_Pnt::Z

(

)

const

For this point, returns its Z coordinate.

---

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

• gp_Pnt.hxx