Open CASCADE Technology  7.6.0.dev
Public Member Functions

gp_Ax2d Class Reference

Describes an axis in the plane (2D space). An axis is defined by: More...

#include <gp_Ax2d.hxx>

Public Member Functions

 gp_Ax2d ()
 Creates an axis object representing X axis of the reference co-ordinate system. More...
 
 gp_Ax2d (const gp_Pnt2d &theP, const gp_Dir2d &theV)
 Creates an Ax2d. <theP> is the "Location" point of the axis placement and theV is the "Direction" of the axis placement. More...
 
void SetLocation (const gp_Pnt2d &theP)
 Changes the "Location" point (origin) of <me>. More...
 
void SetDirection (const gp_Dir2d &theV)
 Changes the direction of <me>. More...
 
const gp_Pnt2dLocation () const
 Returns the origin of <me>. More...
 
const gp_Dir2dDirection () const
 Returns the direction of <me>. More...
 
Standard_Boolean IsCoaxial (const gp_Ax2d &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_Ax2d &theOther, const Standard_Real theAngularTolerance) const
 Returns true if this axis and the axis theOther are normal to each other. That is, if the angle between the two axes is equal to Pi/2 or -Pi/2. Note: the tolerance criterion is given by theAngularTolerance. More...
 
Standard_Boolean IsOpposite (const gp_Ax2d &theOther, const Standard_Real theAngularTolerance) const
 Returns true if this axis and the axis theOther are parallel, and have opposite orientations. That is, if the angle between the two axes is equal to Pi or -Pi. Note: the tolerance criterion is given by theAngularTolerance. More...
 
Standard_Boolean IsParallel (const gp_Ax2d &theOther, const Standard_Real theAngularTolerance) const
 Returns true if this axis and the axis theOther are parallel, and have either the same or opposite orientations. That is, if the angle between the two axes is equal to 0, Pi or -Pi. Note: the tolerance criterion is given by theAngularTolerance. More...
 
Standard_Real Angle (const gp_Ax2d &theOther) const
 Computes the angle, in radians, between this axis and the axis theOther. The value of the angle is between -Pi and Pi. More...
 
void Reverse ()
 Reverses the direction of <me> and assigns the result to this axis. More...
 
gp_Ax2d Reversed () const
 Computes a new axis placement with a direction opposite to the direction of <me>. More...
 
void Mirror (const gp_Pnt2d &P)
 
gp_Ax2d Mirrored (const gp_Pnt2d &P) const
 Performs the symmetrical transformation of an axis placement with respect to the point P which is the center of the symmetry. More...
 
void Mirror (const gp_Ax2d &A)
 
gp_Ax2d Mirrored (const gp_Ax2d &A) const
 Performs the symmetrical transformation of an axis placement with respect to an axis placement which is the axis of the symmetry. More...
 
void Rotate (const gp_Pnt2d &theP, const Standard_Real theAng)
 
gp_Ax2d Rotated (const gp_Pnt2d &theP, const Standard_Real theAng) const
 Rotates an axis placement. <theP> is the center of the rotation. theAng is the angular value of the rotation in radians. More...
 
void Scale (const gp_Pnt2d &P, const Standard_Real S)
 
gp_Ax2d Scaled (const gp_Pnt2d &theP, const Standard_Real theS) const
 Applies a scaling transformation on the axis placement. The "Location" point of the axisplacement is modified. The "Direction" is reversed if the scale is negative. More...
 
void Transform (const gp_Trsf2d &theT)
 
gp_Ax2d Transformed (const gp_Trsf2d &theT) const
 Transforms an axis placement with a Trsf. More...
 
void Translate (const gp_Vec2d &theV)
 
gp_Ax2d Translated (const gp_Vec2d &theV) const
 Translates an axis placement in the direction of the vector theV. The magnitude of the translation is the vector's magnitude. More...
 
void Translate (const gp_Pnt2d &theP1, const gp_Pnt2d &theP2)
 
gp_Ax2d Translated (const gp_Pnt2d &theP1, const gp_Pnt2d &theP2) const
 Translates an axis placement from the point theP1 to the point theP2. More...
 
void DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const
 Dumps the content of me into the stream. More...
 

Detailed Description

Describes an axis in the plane (2D space). An axis is defined by:

Constructor & Destructor Documentation

◆ gp_Ax2d() [1/2]

gp_Ax2d::gp_Ax2d ( )
inline

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

◆ gp_Ax2d() [2/2]

gp_Ax2d::gp_Ax2d ( const gp_Pnt2d theP,
const gp_Dir2d theV 
)
inline

Creates an Ax2d. <theP> is the "Location" point of the axis placement and theV is the "Direction" of the axis placement.

Member Function Documentation

◆ Angle()

Standard_Real gp_Ax2d::Angle ( const gp_Ax2d theOther) const
inline

Computes the angle, in radians, between this axis and the axis theOther. The value of the angle is between -Pi and Pi.

◆ Direction()

const gp_Dir2d& gp_Ax2d::Direction ( ) const
inline

Returns the direction of <me>.

◆ DumpJson()

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

Dumps the content of me into the stream.

◆ IsCoaxial()

Standard_Boolean gp_Ax2d::IsCoaxial ( const gp_Ax2d 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_Ax2d::IsNormal ( const gp_Ax2d theOther,
const Standard_Real  theAngularTolerance 
) const
inline

Returns true if this axis and the axis theOther are normal to each other. That is, if the angle between the two axes is equal to Pi/2 or -Pi/2. Note: the tolerance criterion is given by theAngularTolerance.

◆ IsOpposite()

Standard_Boolean gp_Ax2d::IsOpposite ( const gp_Ax2d theOther,
const Standard_Real  theAngularTolerance 
) const
inline

Returns true if this axis and the axis theOther are parallel, and have opposite orientations. That is, if the angle between the two axes is equal to Pi or -Pi. Note: the tolerance criterion is given by theAngularTolerance.

◆ IsParallel()

Standard_Boolean gp_Ax2d::IsParallel ( const gp_Ax2d theOther,
const Standard_Real  theAngularTolerance 
) const
inline

Returns true if this axis and the axis theOther are parallel, and have either the same or opposite orientations. That is, if the angle between the two axes is equal to 0, Pi or -Pi. Note: the tolerance criterion is given by theAngularTolerance.

◆ Location()

const gp_Pnt2d& gp_Ax2d::Location ( ) const
inline

Returns the origin of <me>.

◆ Mirror() [1/2]

void gp_Ax2d::Mirror ( const gp_Ax2d A)

◆ Mirror() [2/2]

void gp_Ax2d::Mirror ( const gp_Pnt2d P)

◆ Mirrored() [1/2]

gp_Ax2d gp_Ax2d::Mirrored ( const gp_Ax2d A) const

Performs the symmetrical transformation of an axis placement with respect to an axis placement which is the axis of the symmetry.

◆ Mirrored() [2/2]

gp_Ax2d gp_Ax2d::Mirrored ( const gp_Pnt2d P) const

Performs the symmetrical transformation of an axis placement with respect to the point P which is the center of the symmetry.

◆ Reverse()

void gp_Ax2d::Reverse ( )
inline

Reverses the direction of <me> and assigns the result to this axis.

◆ Reversed()

gp_Ax2d gp_Ax2d::Reversed ( ) const
inline

Computes a new axis placement with a direction opposite to the direction of <me>.

◆ Rotate()

void gp_Ax2d::Rotate ( const gp_Pnt2d theP,
const Standard_Real  theAng 
)
inline

◆ Rotated()

gp_Ax2d gp_Ax2d::Rotated ( const gp_Pnt2d theP,
const Standard_Real  theAng 
) const
inline

Rotates an axis placement. <theP> is the center of the rotation. theAng is the angular value of the rotation in radians.

◆ Scale()

void gp_Ax2d::Scale ( const gp_Pnt2d P,
const Standard_Real  S 
)

◆ Scaled()

gp_Ax2d gp_Ax2d::Scaled ( const gp_Pnt2d theP,
const Standard_Real  theS 
) const
inline

Applies a scaling transformation on the axis placement. The "Location" point of the axisplacement is modified. The "Direction" is reversed if the scale is negative.

◆ SetDirection()

void gp_Ax2d::SetDirection ( const gp_Dir2d theV)
inline

Changes the direction of <me>.

◆ SetLocation()

void gp_Ax2d::SetLocation ( const gp_Pnt2d theP)
inline

Changes the "Location" point (origin) of <me>.

◆ Transform()

void gp_Ax2d::Transform ( const gp_Trsf2d theT)
inline

◆ Transformed()

gp_Ax2d gp_Ax2d::Transformed ( const gp_Trsf2d theT) const
inline

Transforms an axis placement with a Trsf.

◆ Translate() [1/2]

void gp_Ax2d::Translate ( const gp_Pnt2d theP1,
const gp_Pnt2d theP2 
)
inline

◆ Translate() [2/2]

void gp_Ax2d::Translate ( const gp_Vec2d theV)
inline

◆ Translated() [1/2]

gp_Ax2d gp_Ax2d::Translated ( const gp_Pnt2d theP1,
const gp_Pnt2d theP2 
) const
inline

Translates an axis placement from the point theP1 to the point theP2.

◆ Translated() [2/2]

gp_Ax2d gp_Ax2d::Translated ( const gp_Vec2d theV) const
inline

Translates an axis placement in the direction of the vector theV. The magnitude of the translation is the vector's magnitude.


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