OCC Main Page | FoundationClasses | Toolkits | Packages | Class Hierarchy | Data Structures | File List | Data Fields | Globals

FoundationClasses
TKMath
gp


gp_Ax1 Class Reference

Describes an axis in 3D space.
An axis is defined by:
- its origin (also referred to as its "Location point"), and
- its unit vector (referred to as its "Direction" or "main Direction").
An axis is used:
- to describe 3D geometric entities (for example, the
axis of a revolution entity). It serves the same purpose
as the STEP function "axis placement one axis", or
- to define geometric transformations (axis of
symmetry, axis of rotation, and so on).
For example, this entity can be used to locate a geometric entity
or to define a symmetry axis.
.

#include <gp_Ax1.hxx>


Public Member Functions

void * operator new (size_t, void *anAddress)
void * operator new (size_t size)
void operator delete (void *anAddress)
 gp_Ax1 ()
 Creates a indefined Ax1.
.
 gp_Ax1 (const gp_Pnt &P, const gp_Dir &V)
 P is the location point and V is the direction of <me>.
.
void SetDirection (const gp_Dir &V)
 Assigns V as the "Direction" of this axis.
.
void SetLocation (const gp_Pnt &P)
 Assigns P as the origin of this axis.
.
const gp_DirDirection () const
 Returns the direction of <me>.
.
const gp_PntLocation () const
 Returns the location point of <me>.
.
Standard_EXPORT Standard_Boolean IsCoaxial (const gp_Ax1 &Other, const Standard_Real AngularTolerance, const Standard_Real LinearTolerance) const
 Returns True if :
. the angle between <me> and <other> is lower or equal
to <angulartolerance> and
. the distance between <me>.Location() and <other> is lower
or equal to <lineartolerance> and
. the distance between <other>.Location() and <me> is lower
or equal to LinearTolerance.
.
Standard_Boolean IsNormal (const gp_Ax1 &Other, const Standard_Real AngularTolerance) const
 Returns True if the direction of the <me> and <other>
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 IsOpposite (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 IsParallel (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_Real Angle (const gp_Ax1 &Other) const
 Computes the angular value, in radians, between <me>.Direction() and
<other>.Direction(). Returns the angle between 0 and 2*PI
radians.
.
void Reverse ()
 Reverses the unit vector of this axis.
and assigns the result to this axis.
.
gp_Ax1 Reversed () const
 Reverses the unit vector of this axis and creates a new one.
.
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 assigns the result to this axis.
.
Standard_EXPORT gp_Ax1 Mirrored (const gp_Pnt &P) const
 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_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 assigns the result to this axis.
.
Standard_EXPORT gp_Ax1 Mirrored (const gp_Ax1 &A1) const
 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_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 assigns the result to this axis.
.
Standard_EXPORT gp_Ax1 Mirrored (const gp_Ax2 &A2) 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 creates a new axis.
.
void Rotate (const gp_Ax1 &A1, const Standard_Real Ang)
 Rotates this axis at an angle Ang (in radians) about the axis A1
and assigns the result to this axis.
.
gp_Ax1 Rotated (const gp_Ax1 &A1, const Standard_Real Ang) const
 Rotates this axis at an angle Ang (in radians) about the axis A1
and creates a new one.
.
void Scale (const gp_Pnt &P, const Standard_Real S)
 Applies a scaling transformation to this axis with:
- scale factor S, and
- center P and assigns the result to this axis.
.
gp_Ax1 Scaled (const gp_Pnt &P, const Standard_Real S) const
 Applies a scaling transformation to this axis with:
- scale factor S, and
- center P and creates a new axis.
.
void Transform (const gp_Trsf &T)
 Applies the transformation T to this axis.
and assigns the result to this axis.
.
gp_Ax1 Transformed (const gp_Trsf &T) const
 Applies the transformation T 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.
.
void Translate (const gp_Vec &V)
 Translates this axis by the vector V,
and assigns the result to this axis.
.
gp_Ax1 Translated (const gp_Vec &V) const
 Translates this axis by the vector V,
and creates a new one.
.
void Translate (const gp_Pnt &P1, const gp_Pnt &P2)
 Translates this axis by:
the vector (P1, P2) defined from point P1 to point P2.
and assigns the result to this axis.
.
gp_Ax1 Translated (const gp_Pnt &P1, const gp_Pnt &P2) const
 Translates this axis by:
the vector (P1, P2) defined from point P1 to point P2.
and creates a new one.
.
const gp_Pnt_CSFDB_Getgp_Ax1loc () const
const gp_Dir_CSFDB_Getgp_Ax1vdir () const

Private Attributes

gp_Pnt loc
gp_Dir vdir

Friends

Standard_EXPORT friend Handle_Standard_Type & gp_Ax1_Type_ ()


Constructor & Destructor Documentation

gp_Ax1::gp_Ax1  )  [inline]
 

gp_Ax1::gp_Ax1 const gp_Pnt P,
const gp_Dir V
[inline]
 


Member Function Documentation

const gp_Pnt& gp_Ax1::_CSFDB_Getgp_Ax1loc  )  const [inline]
 

const gp_Dir& gp_Ax1::_CSFDB_Getgp_Ax1vdir  )  const [inline]
 

Standard_Real gp_Ax1::Angle const gp_Ax1 Other  )  const [inline]
 

const gp_Dir & gp_Ax1::Direction  )  const [inline]
 

Standard_EXPORT Standard_Boolean gp_Ax1::IsCoaxial const gp_Ax1 Other,
const Standard_Real  AngularTolerance,
const Standard_Real  LinearTolerance
const
 

Standard_Boolean gp_Ax1::IsNormal const gp_Ax1 Other,
const Standard_Real  AngularTolerance
const [inline]
 

Standard_Boolean gp_Ax1::IsOpposite const gp_Ax1 Other,
const Standard_Real  AngularTolerance
const [inline]
 

Standard_Boolean gp_Ax1::IsParallel const gp_Ax1 Other,
const Standard_Real  AngularTolerance
const [inline]
 

const gp_Pnt & gp_Ax1::Location  )  const [inline]
 

Standard_EXPORT void gp_Ax1::Mirror const gp_Ax2 A2  ) 
 

Standard_EXPORT void gp_Ax1::Mirror const gp_Ax1 A1  ) 
 

Standard_EXPORT void gp_Ax1::Mirror const gp_Pnt P  ) 
 

Standard_EXPORT gp_Ax1 gp_Ax1::Mirrored const gp_Ax2 A2  )  const
 

Standard_EXPORT gp_Ax1 gp_Ax1::Mirrored const gp_Ax1 A1  )  const
 

Standard_EXPORT gp_Ax1 gp_Ax1::Mirrored const gp_Pnt P  )  const
 

void gp_Ax1::operator delete void *  anAddress  )  [inline]
 

void* gp_Ax1::operator new size_t  size  )  [inline]
 

void* gp_Ax1::operator new size_t  ,
void *  anAddress
[inline]
 

void gp_Ax1::Reverse  )  [inline]
 

gp_Ax1 gp_Ax1::Reversed  )  const [inline]
 

void gp_Ax1::Rotate const gp_Ax1 A1,
const Standard_Real  Ang
[inline]
 

gp_Ax1 gp_Ax1::Rotated const gp_Ax1 A1,
const Standard_Real  Ang
const [inline]
 

void gp_Ax1::Scale const gp_Pnt P,
const Standard_Real  S
[inline]
 

gp_Ax1 gp_Ax1::Scaled const gp_Pnt P,
const Standard_Real  S
const [inline]
 

void gp_Ax1::SetDirection const gp_Dir V  )  [inline]
 

void gp_Ax1::SetLocation const gp_Pnt P  )  [inline]
 

void gp_Ax1::Transform const gp_Trsf T  )  [inline]
 

gp_Ax1 gp_Ax1::Transformed const gp_Trsf T  )  const [inline]
 

void gp_Ax1::Translate const gp_Pnt P1,
const gp_Pnt P2
[inline]
 

void gp_Ax1::Translate const gp_Vec V  )  [inline]
 

gp_Ax1 gp_Ax1::Translated const gp_Pnt P1,
const gp_Pnt P2
const [inline]
 

gp_Ax1 gp_Ax1::Translated const gp_Vec V  )  const [inline]
 


Friends And Related Function Documentation

Standard_EXPORT friend Handle_Standard_Type& gp_Ax1_Type_  )  [friend]
 


Field Documentation

gp_Pnt gp_Ax1::loc [private]
 

gp_Dir gp_Ax1::vdir [private]
 


The documentation for this class was generated from the following files:
Generated on Mon Aug 25 13:12:40 2008 for OpenCASCADE by  doxygen 1.4.1