#ifndef _gp_Ax1_HeaderFile
#define _gp_Ax1_HeaderFile
-#include <Standard.hxx>
-#include <Standard_DefineAlloc.hxx>
-#include <Standard_Handle.hxx>
-
#include <gp_Pnt.hxx>
#include <gp_Dir.hxx>
-#include <Standard_Boolean.hxx>
-#include <Standard_Real.hxx>
-class gp_Pnt;
-class gp_Dir;
+
class gp_Ax2;
class gp_Trsf;
class gp_Vec;
-
//! Describes an axis in 3D space.
//! An axis is defined by:
//! - its origin (also referred to as its "Location point"), and
DEFINE_STANDARD_ALLOC
-
//! Creates an axis object representing Z axis of
//! the reference coordinate system.
- gp_Ax1();
-
+ gp_Ax1()
+ : loc(0.,0.,0.), vdir(0.,0.,1.)
+ {}
//! P is the location point and V is the direction of <me>.
- gp_Ax1(const gp_Pnt& P, const gp_Dir& V);
-
+ gp_Ax1 (const gp_Pnt& theP, const gp_Dir& theV)
+ : loc(theP), vdir (theV)
+ {}
+
//! Assigns V as the "Direction" of this axis.
- void SetDirection (const gp_Dir& V);
-
+ void SetDirection (const gp_Dir& theV) { vdir = theV; }
+
//! Assigns P as the origin of this axis.
- void SetLocation (const gp_Pnt& P);
-
+ void SetLocation (const gp_Pnt& theP) { loc = theP; }
+
//! Returns the direction of <me>.
- const gp_Dir& Direction() const;
-
+ const gp_Dir& Direction() const { return vdir; }
+
//! Returns the location point of <me>.
- const gp_Pnt& Location() const;
-
+ const gp_Pnt& Location() const { return loc; }
//! Returns True if :
//! . the angle between <me> and <Other> is lower or equal
//! . the distance between <Other>.Location() and <me> is lower
//! or equal to LinearTolerance.
Standard_EXPORT Standard_Boolean IsCoaxial (const gp_Ax1& Other, const Standard_Real AngularTolerance, const Standard_Real LinearTolerance) const;
-
- //! Returns True if the direction of the <me> and <Other>
- //! are normal to each other.
+ //! Returns True if the direction of this and another axis are normal to each other.
//! That is, if the angle between the two axes is equal to Pi/2.
- //! Note: the tolerance criterion is given by AngularTolerance..
- Standard_Boolean IsNormal (const gp_Ax1& Other, const Standard_Real AngularTolerance) const;
-
-
- //! Returns True if the direction of <me> and <Other> are
- //! parallel with opposite orientation. That is, if the angle
- //! between the two axes is equal to Pi.
- //! Note: the tolerance criterion is given by AngularTolerance.
- Standard_Boolean IsOpposite (const gp_Ax1& Other, const Standard_Real AngularTolerance) const;
-
-
- //! Returns True if the direction of <me> and <Other> are
- //! parallel with same orientation or opposite orientation. That
- //! is, if the angle between the two axes is equal to 0 or Pi.
- //! Note: the tolerance criterion is given by
- //! AngularTolerance.
- Standard_Boolean IsParallel (const gp_Ax1& Other, const Standard_Real AngularTolerance) const;
-
-
- //! Computes the angular value, in radians, between <me>.Direction() and
- //! <Other>.Direction(). Returns the angle between 0 and 2*PI
- //! radians.
- Standard_Real Angle (const gp_Ax1& Other) const;
-
- //! Reverses the unit vector of this axis.
- //! and assigns the result to this axis.
- void Reverse();
-
+ //! Note: the tolerance criterion is given by theAngularTolerance.
+ Standard_Boolean IsNormal (const gp_Ax1& theOther, const Standard_Real theAngularTolerance) const
+ {
+ return vdir.IsNormal (theOther.vdir, theAngularTolerance);
+ }
+
+ //! Returns True if the direction of this and another axis are parallel with opposite orientation.
+ //! That is, if the angle between the two axes is equal to Pi.
+ //! Note: the tolerance criterion is given by theAngularTolerance.
+ Standard_Boolean IsOpposite (const gp_Ax1& theOther, const Standard_Real theAngularTolerance) const
+ {
+ return vdir.IsOpposite (theOther.vdir, theAngularTolerance);
+ }
+
+ //! Returns True if the direction of this and another axis are parallel with same orientation or opposite orientation.
+ //! That is, if the angle between the two axes is equal to 0 or Pi.
+ //! Note: the tolerance criterion is given by theAngularTolerance.
+ Standard_Boolean IsParallel (const gp_Ax1& theOther, const Standard_Real theAngularTolerance) const
+ {
+ return vdir.IsParallel(theOther.vdir, theAngularTolerance);
+ }
+
+ //! Computes the angular value, in radians, between this.Direction() and theOther.Direction().
+ //! Returns the angle between 0 and 2*PI radians.
+ Standard_Real Angle (const gp_Ax1& theOther) const { return vdir.Angle (theOther.vdir); }
+
+ //! Reverses the unit vector of this axis and assigns the result to this axis.
+ void Reverse() { vdir.Reverse(); }
+
//! Reverses the unit vector of this axis and creates a new one.
- Standard_NODISCARD gp_Ax1 Reversed() const;
-
+ Standard_NODISCARD gp_Ax1 Reversed() const
+ {
+ gp_Dir D = vdir.Reversed();
+ return gp_Ax1 (loc, D);
+ }
//! Performs the symmetrical transformation of an axis
//! placement with respect to the point P which is the
//! center of the symmetry and assigns the result to this axis.
Standard_EXPORT void Mirror (const gp_Pnt& P);
-
+
//! Performs the symmetrical transformation of an axis
//! placement with respect to the point P which is the
//! center of the symmetry and creates a new axis.
Standard_NODISCARD Standard_EXPORT gp_Ax1 Mirrored (const gp_Pnt& P) const;
-
//! Performs the symmetrical transformation of an axis
//! placement with respect to an axis placement which
//! is the axis of the symmetry and assigns the result to this axis.
Standard_EXPORT void Mirror (const gp_Ax1& A1);
-
//! Performs the symmetrical transformation of an axis
//! placement with respect to an axis placement which
//! is the axis of the symmetry and creates a new axis.
Standard_NODISCARD Standard_EXPORT gp_Ax1 Mirrored (const gp_Ax1& A1) const;
-
//! Performs the symmetrical transformation of an axis
//! placement with respect to a plane. The axis placement
//! <A2> locates the plane of the symmetry :
//! (Location, XDirection, YDirection) and assigns the result to this axis.
Standard_EXPORT void Mirror (const gp_Ax2& A2);
-
//! Performs the symmetrical transformation of an axis
//! placement with respect to a plane. The axis placement
//! <A2> locates the plane of the symmetry :
//! (Location, XDirection, YDirection) and creates a new axis.
Standard_NODISCARD Standard_EXPORT gp_Ax1 Mirrored (const gp_Ax2& A2) const;
-
- //! Rotates this axis at an angle Ang (in radians) about the axis A1
+
+ //! Rotates this axis at an angle theAngRad (in radians) about the axis theA1
//! and assigns the result to this axis.
- void Rotate (const gp_Ax1& A1, const Standard_Real Ang);
-
- //! Rotates this axis at an angle Ang (in radians) about the axis A1
+ void Rotate (const gp_Ax1& theA1, const Standard_Real theAngRad)
+ {
+ loc .Rotate (theA1, theAngRad);
+ vdir.Rotate (theA1, theAngRad);
+ }
+
+ //! Rotates this axis at an angle theAngRad (in radians) about the axis theA1
//! and creates a new one.
- Standard_NODISCARD gp_Ax1 Rotated (const gp_Ax1& A1, const Standard_Real Ang) const;
-
+ Standard_NODISCARD gp_Ax1 Rotated (const gp_Ax1& theA1, const Standard_Real theAngRad) const
+ {
+ gp_Ax1 A = *this;
+ A.Rotate (theA1, theAngRad);
+ return A;
+ }
//! Applies a scaling transformation to this axis with:
- //! - scale factor S, and
- //! - center P and assigns the result to this axis.
- void Scale (const gp_Pnt& P, const Standard_Real S);
-
+ //! - scale factor theS, and
+ //! - center theP and assigns the result to this axis.
+ void Scale (const gp_Pnt& theP, const Standard_Real theS)
+ {
+ loc.Scale (theP, theS);
+ if (theS < 0.0) { vdir.Reverse(); }
+ }
//! Applies a scaling transformation to this axis with:
- //! - scale factor S, and
- //! - center P and creates a new axis.
- Standard_NODISCARD gp_Ax1 Scaled (const gp_Pnt& P, const Standard_Real S) const;
-
- //! Applies the transformation T to this axis.
- //! and assigns the result to this axis.
- void Transform (const gp_Trsf& T);
-
-
- //! Applies the transformation T to this axis and creates a new one.
+ //! - scale factor theS, and
+ //! - center theP and creates a new axis.
+ Standard_NODISCARD gp_Ax1 Scaled (const gp_Pnt& theP, const Standard_Real theS) const
+ {
+ gp_Ax1 A1 = *this;
+ A1.Scale (theP, theS);
+ return A1;
+ }
+
+ //! Applies the transformation theT to this axis and assigns the result to this axis.
+ void Transform (const gp_Trsf& theT)
+ {
+ loc .Transform (theT);
+ vdir.Transform (theT);
+ }
+
+ //! Applies the transformation theT to this axis and creates a new one.
//!
- //! Translates an axis plaxement in the direction of the vector
- //! <V>. The magnitude of the translation is the vector's magnitude.
- Standard_NODISCARD gp_Ax1 Transformed (const gp_Trsf& T) const;
-
-
- //! Translates this axis by the vector V,
- //! and assigns the result to this axis.
- void Translate (const gp_Vec& V);
-
-
- //! Translates this axis by the vector V,
+ //! Translates an axis plaxement in the direction of the vector <V>.
+ //! The magnitude of the translation is the vector's magnitude.
+ Standard_NODISCARD gp_Ax1 Transformed (const gp_Trsf& theT) const
+ {
+ gp_Ax1 A1 = *this;
+ A1.Transform (theT);
+ return A1;
+ }
+
+ //! Translates this axis by the vector theV, and assigns the result to this axis.
+ void Translate (const gp_Vec& theV) { loc.Translate (theV); }
+
+ //! Translates this axis by the vector theV,
//! and creates a new one.
- Standard_NODISCARD gp_Ax1 Translated (const gp_Vec& V) const;
-
+ Standard_NODISCARD gp_Ax1 Translated (const gp_Vec& theV) const
+ {
+ gp_Ax1 A1 = *this;
+ (A1.loc).Translate (theV);
+ return A1;
+ }
//! Translates this axis by:
- //! the vector (P1, P2) defined from point P1 to point P2.
+ //! the vector (theP1, theP2) defined from point theP1 to point theP2.
//! and assigns the result to this axis.
- void Translate (const gp_Pnt& P1, const gp_Pnt& P2);
-
+ void Translate (const gp_Pnt& theP1, const gp_Pnt& theP2) { loc.Translate (theP1, theP2); }
//! Translates this axis by:
- //! the vector (P1, P2) defined from point P1 to point P2.
+ //! the vector (theP1, theP2) defined from point theP1 to point theP2.
//! and creates a new one.
- Standard_NODISCARD gp_Ax1 Translated (const gp_Pnt& P1, const gp_Pnt& P2) const;
-
+ Standard_NODISCARD gp_Ax1 Translated (const gp_Pnt& theP1, const gp_Pnt& theP2) const
+ {
+ gp_Ax1 A1 = *this;
+ (A1.loc).Translate (theP1, theP2);
+ return A1;
+ }
//! Dumps the content of me into the stream
Standard_EXPORT void DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth = -1) const;
//! Inits the content of me from the stream
Standard_EXPORT Standard_Boolean InitFromJson (const Standard_SStream& theSStream, Standard_Integer& theStreamPos);
-protected:
-
-
-
-
-
private:
-
-
gp_Pnt loc;
gp_Dir vdir;
-
};
-
-#include <gp_Ax1.lxx>
-
-
-
-
-
#endif // _gp_Ax1_HeaderFile