Open CASCADE Technology  7.5.0
Public Member Functions

gp_Ax1 Class Reference

Describes an axis in 3D space. An axis is defined by: More...

#include <gp_Ax1.hxx>

Public Member Functions

 gp_Ax1 ()
 Creates an axis object representing Z axis of the reference co-ordinate system. More...
 
 gp_Ax1 (const gp_Pnt &P, const gp_Dir &V)
 P is the location point and V is the direction of <me>. More...
 
void SetDirection (const gp_Dir &V)
 Assigns V as the "Direction" of this axis. More...
 
void SetLocation (const gp_Pnt &P)
 Assigns P as the origin of this axis. More...
 
const gp_DirDirection () const
 Returns the direction of <me>. More...
 
const gp_PntLocation () const
 Returns the location point of <me>. More...
 
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. More...
 
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.. More...
 
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. More...
 
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. More...
 
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. More...
 
void Reverse ()
 Reverses the unit vector of this axis. and assigns the result to this axis. More...
 
gp_Ax1 Reversed () const
 Reverses the unit vector of this axis and creates a new one. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
void Scale (const gp_Pnt &P, const Standard_Real S)
 Applies a scaling transformation to this axis with: More...
 
gp_Ax1 Scaled (const gp_Pnt &P, const Standard_Real S) const
 Applies a scaling transformation to this axis with: More...
 
void Transform (const gp_Trsf &T)
 Applies the transformation T to this axis. and assigns the result to this axis. More...
 
gp_Ax1 Transformed (const gp_Trsf &T) const
 Applies the transformation T to this axis and creates a new one. More...
 
void Translate (const gp_Vec &V)
 Translates this axis by the vector V, and assigns the result to this axis. More...
 
gp_Ax1 Translated (const gp_Vec &V) const
 Translates this axis by the vector V, and creates a new one. More...
 
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. More...
 
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. More...
 
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

Describes an axis in 3D space. An axis is defined by:

Constructor & Destructor Documentation

◆ gp_Ax1() [1/2]

gp_Ax1::gp_Ax1 ( )

Creates an axis object representing Z axis of the reference co-ordinate system.

◆ gp_Ax1() [2/2]

gp_Ax1::gp_Ax1 ( const gp_Pnt P,
const gp_Dir V 
)

P is the location point and V is the direction of <me>.

Member Function Documentation

◆ Angle()

Standard_Real gp_Ax1::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.

◆ Direction()

const gp_Dir& gp_Ax1::Direction ( ) const

Returns the direction of <me>.

◆ DumpJson()

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

Dumps the content of me into the stream.

◆ InitFromJson()

Standard_Boolean gp_Ax1::InitFromJson ( const Standard_SStream theSStream,
Standard_Integer theStreamPos 
)

Inits the content of me from the stream.

◆ IsCoaxial()

Standard_Boolean gp_Ax1::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.

◆ IsNormal()

Standard_Boolean gp_Ax1::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..

◆ IsOpposite()

Standard_Boolean gp_Ax1::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.

◆ IsParallel()

Standard_Boolean gp_Ax1::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.

◆ Location()

const gp_Pnt& gp_Ax1::Location ( ) const

Returns the location point of <me>.

◆ Mirror() [1/3]

void gp_Ax1::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.

◆ Mirror() [2/3]

void gp_Ax1::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.

◆ Mirror() [3/3]

void gp_Ax1::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.

◆ Mirrored() [1/3]

gp_Ax1 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.

◆ Mirrored() [2/3]

gp_Ax1 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.

◆ Mirrored() [3/3]

gp_Ax1 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.

◆ Reverse()

void gp_Ax1::Reverse ( )

Reverses the unit vector of this axis. and assigns the result to this axis.

◆ Reversed()

gp_Ax1 gp_Ax1::Reversed ( ) const

Reverses the unit vector of this axis and creates a new one.

◆ Rotate()

void gp_Ax1::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.

◆ Rotated()

gp_Ax1 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.

◆ Scale()

void gp_Ax1::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.

◆ Scaled()

gp_Ax1 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.

◆ SetDirection()

void gp_Ax1::SetDirection ( const gp_Dir V)

Assigns V as the "Direction" of this axis.

◆ SetLocation()

void gp_Ax1::SetLocation ( const gp_Pnt P)

Assigns P as the origin of this axis.

◆ Transform()

void gp_Ax1::Transform ( const gp_Trsf T)

Applies the transformation T to this axis. and assigns the result to this axis.

◆ Transformed()

gp_Ax1 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.

◆ Translate() [1/2]

void gp_Ax1::Translate ( const gp_Vec V)

Translates this axis by the vector V, and assigns the result to this axis.

◆ Translate() [2/2]

void gp_Ax1::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.

◆ Translated() [1/2]

gp_Ax1 gp_Ax1::Translated ( const gp_Vec V) const

Translates this axis by the vector V, and creates a new one.

◆ Translated() [2/2]

gp_Ax1 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.


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