gce_MakeDir2d Class Reference

This class implements the following algorithms used to create a Dir2d from gp. More...

#include <gce_MakeDir2d.hxx>

Inheritance diagram for gce_MakeDir2d:

Public Member Functions
	gce_MakeDir2d (const gp_Vec2d &V)
	Normalizes the vector V and creates a direction. Status is "NullVector" if V.Magnitude() <= Resolution.
	gce_MakeDir2d (const gp_XY &Coord)
	Creates a direction from a triplet of coordinates. Status is "NullVector" if Coord.Modulus() <= Resolution from gp.
	gce_MakeDir2d (const Standard_Real Xv, const Standard_Real Yv)
	Creates a direction with its 3 cartesian coordinates. Status is "NullVector" if Sqrt(Xv*Xv + Yv*Yv ) <= Resolution.
	gce_MakeDir2d (const gp_Pnt2d &P1, const gp_Pnt2d &P2)
	Make a Dir2d from gp <TheDir> passing through 2 Pnt <P1>,<P2>. Status is "ConfusedPoints" if <P1> and <P2> are confused. Warning If an error occurs (that is, when IsDone returns false), the Status function returns:
const gp_Dir2d &	Value () const
	Returns the constructed unit vector. Exceptions StdFail_NotDone if no unit vector is constructed.
const gp_Dir2d &	Operator () const
	operator gp_Dir2d () const
Public Member Functions inherited from gce_Root
Standard_Boolean	IsDone () const
	Returns true if the construction is successful.
gce_ErrorType	Status () const
	Returns the status of the construction:

Additional Inherited Members
Protected Attributes inherited from gce_Root
gce_ErrorType	TheError

Detailed Description

This class implements the following algorithms used to create a Dir2d from gp.

• Create a Dir2d with 2 points.
• Create a Dir2d with a Vec2d.
• Create a Dir2d with a XY from gp.
• Create a Dir2d with a 2 Reals (Coordinates).

Constructor & Destructor Documentation

gce_MakeDir2d() [1/4]

gce_MakeDir2d::gce_MakeDir2d

(

const gp_Vec2d &

V

)

Normalizes the vector V and creates a direction. Status is "NullVector" if V.Magnitude() <= Resolution.

gce_MakeDir2d() [2/4]

gce_MakeDir2d::gce_MakeDir2d

(

const gp_XY &

Coord

)

Creates a direction from a triplet of coordinates. Status is "NullVector" if Coord.Modulus() <= Resolution from gp.

gce_MakeDir2d() [3/4]

gce_MakeDir2d::gce_MakeDir2d	(	const Standard_Real	Xv,
		const Standard_Real	Yv
	)

Creates a direction with its 3 cartesian coordinates. Status is "NullVector" if Sqrt(Xv*Xv + Yv*Yv ) <= Resolution.

gce_MakeDir2d() [4/4]

gce_MakeDir2d::gce_MakeDir2d	(	const gp_Pnt2d &	P1,
		const gp_Pnt2d &	P2
	)

Make a Dir2d from gp <TheDir> passing through 2 Pnt <P1>,<P2>. Status is "ConfusedPoints" if <P1> and <P2> are confused. Warning If an error occurs (that is, when IsDone returns false), the Status function returns:

• gce_ConfusedPoints if points P1 and P2 are coincident, or
• gce_NullVector if one of the following is less than or equal to gp::Resolution():
• the magnitude of vector V,
• the modulus of Coord,
• Sqrt(Xv*Xv + Yv*Yv).

Member Function Documentation

Operator()

const gp_Dir2d & gce_MakeDir2d::Operator

(

)

const

operator gp_Dir2d()

gce_MakeDir2d::operator gp_Dir2d

(

)

const

Value()

const gp_Dir2d & gce_MakeDir2d::Value

(

)

const

Returns the constructed unit vector. Exceptions StdFail_NotDone if no unit vector is constructed.

---

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

• gce_MakeDir2d.hxx