gce_MakeDir Class Reference

This class implements construction algorithms for gp_Dir. Supported constructions include: More...

#include <gce_MakeDir.hxx>

Inheritance diagram for gce_MakeDir:

Public Member Functions
	gce_MakeDir (const gp_Vec &V)
	Normalizes the vector V and creates a direction.
	gce_MakeDir (const gp_XYZ &Coord)
	Creates a direction from a coordinate vector.
	gce_MakeDir (const double Xv, const double Yv, const double Zv)
	Creates a direction with its 3 cartesian coordinates.
	gce_MakeDir (const gp_Pnt &P1, const gp_Pnt &P2)
	Creates a direction from two points.
const gp_Dir &	Value () const
	Returns the constructed unit vector. Exceptions StdFail_NotDone if no unit vector is constructed.
gp_Dir	Operator () const
	Alias for Value() returning a copy.
	operator gp_Dir () const
	Conversion operator returning the constructed object.
Public Member Functions inherited from gce_Root
bool	IsDone () const
	Returns true if the construction is successful.
bool	IsError () const
	Returns true if the construction has failed.
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 construction algorithms for gp_Dir. Supported constructions include:

• direction from vector or coordinate components;
• direction from two points.

Constructor & Destructor Documentation

gce_MakeDir() [1/4]

gce_MakeDir::gce_MakeDir

(

const gp_Vec &

V

)

Normalizes the vector V and creates a direction.

Note

Construction fails with gce_NullVector if V.Magnitude() <= gp::Resolution().

Parameters

[in]

V

direction vector

gce_MakeDir() [2/4]

gce_MakeDir::gce_MakeDir

(

const gp_XYZ &

Coord

)

Creates a direction from a coordinate vector.

Note

Construction fails with gce_NullVector if Coord.Modulus() <= gp::Resolution().

Parameters

[in]

Coord

coordinate vector

gce_MakeDir() [3/4]

gce_MakeDir::gce_MakeDir	(	const double	Xv,
		const double	Yv,
		const double	Zv )

Creates a direction with its 3 cartesian coordinates.

Note

Construction fails with gce_NullVector if Xv*Xv + Yv*Yv + Zv*Zv <= gp::Resolution().

Parameters

[in]	Xv	X coordinate value
[in]	Yv	Y coordinate value
[in]	Zv	Z coordinate value

gce_MakeDir() [4/4]

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

Creates a direction from two points.

Note

Construction fails with gce_ConfusedPoints if points are coincident.

Parameters

[in]	P1	first point
[in]	P2	second point

Member Function Documentation

Operator()

gp_Dir gce_MakeDir::Operator ( ) const

inline

Alias for Value() returning a copy.

Returns

resulting object

operator gp_Dir()

gce_MakeDir::operator gp_Dir ( ) const

inline

Conversion operator returning the constructed object.

Returns

resulting object

Value()

const gp_Dir & gce_MakeDir::Value

(

)

const

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

Returns

resulting direction

---

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

• gce_MakeDir.hxx