# FoundationClasses
TKMath
gp

# gp_Ax2d Class Reference

Describes an axis in the plane (2D space).
An axis is defined by:
- its origin (also referred to as its "Location point"), and
- its unit vector (referred to as its "Direction").
An axis implicitly defines a direct, right-handed
coordinate system in 2D space by:
- its origin,
- its "Direction" (giving the "X Direction" of the coordinate system), and
- the unit vector normal to "Direction" (positive angle
measured in the trigonometric sense).
An axis is used:
- to describe 2D geometric entities (for example, the
axis which defines angular coordinates on a circle).
It serves for 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).
Note: to define a left-handed 2D coordinate system, use gp_Ax22d.
.

`#include <gp_Ax2d.hxx>`

## Public Member Functions

void * | operator new (size_t, void *anAddress)
void * | operator new (size_t size)
void | operator delete (void *anAddress)
| gp_Ax2d ()
| Creates an indefinite Ax2d .
| gp_Ax2d (const gp_Pnt2d &P, const gp_Dir2d &V)
| Creates an Ax2d. is the "Location" point of the axis placement and V is the "Direction" of the axis placement. .
void | SetLocation (const gp_Pnt2d &Locat)
| Changes the "Location" point (origin) of <me>. .
void | SetDirection (const gp_Dir2d &V)
| Changes the direction of <me>. .
const gp_Pnt2d & | Location () const
| Returns the origin of <me>. .
const gp_Dir2d & | Direction () const
| Returns the direction of <me>. .
Standard_EXPORT 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. .
Standard_Boolean | IsNormal (const gp_Ax2d &Other, const Standard_Real AngularTolerance) const
| Returns true if this axis and the axis Other 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 AngularTolerance. .
Standard_Boolean | IsOpposite (const gp_Ax2d &Other, const Standard_Real AngularTolerance) const
| Returns true if this axis and the axis Other 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 AngularTolerance. .
Standard_Boolean | IsParallel (const gp_Ax2d &Other, const Standard_Real AngularTolerance) const
| Returns true if this axis and the axis Other 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 AngularTolerance. .
Standard_Real | Angle (const gp_Ax2d &Other) const
| Computes the angle, in radians, between this axis and the axis Other. The value of the angle is between -Pi and Pi. .
void | Reverse ()
| Reverses the direction of <me> and assigns the result to this axis. .
gp_Ax2d | Reversed () const
| Computes a new axis placement with a direction opposite to the direction of <me>. .
Standard_EXPORT void | Mirror (const gp_Pnt2d &P)
Standard_EXPORT 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. .
Standard_EXPORT void | Mirror (const gp_Ax2d &A)
Standard_EXPORT 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. .
void | Rotate (const gp_Pnt2d &P, const Standard_Real Ang)
gp_Ax2d | Rotated (const gp_Pnt2d &P, const Standard_Real Ang) const
| Rotates an axis placement. is the center of the rotation . Ang is the angular value of the rotation in radians. .
Standard_EXPORT void | Scale (const gp_Pnt2d &P, const Standard_Real S)
gp_Ax2d | Scaled (const gp_Pnt2d &P, const Standard_Real S) 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. .
void | Transform (const gp_Trsf2d &T)
gp_Ax2d | Transformed (const gp_Trsf2d &T) const
| Transforms an axis placement with a Trsf. .
void | Translate (const gp_Vec2d &V)
gp_Ax2d | Translated (const gp_Vec2d &V) const
| Translates an axis placement in the direction of the vector <v>. The magnitude of the translation is the vector's magnitude. .
void | Translate (const gp_Pnt2d &P1, const gp_Pnt2d &P2)
gp_Ax2d | Translated (const gp_Pnt2d &P1, const gp_Pnt2d &P2) const
| Translates an axis placement from the point <p1> to the point <p2>. .
const gp_Pnt2d & | _CSFDB_Getgp_Ax2dloc () const
const gp_Dir2d & | _CSFDB_Getgp_Ax2dvdir () const

## Private Attributes

gp_Pnt2d | loc
gp_Dir2d | vdir

## Friends

Standard_EXPORT friend Handle_Standard_Type & | gp_Ax2d_Type_ ()

## Constructor & Destructor Documentation

gp_Ax2d::gp_Ax2d | ( |  | ) | `[inline]`

gp_Ax2d::gp_Ax2d | ( | const gp_Pnt2d & | P,
|  | const gp_Dir2d & | V
| ) | `[inline]`

## Member Function Documentation

const gp_Pnt2d& gp_Ax2d::_CSFDB_Getgp_Ax2dloc | ( |  | ) | const`[inline]`

const gp_Dir2d& gp_Ax2d::_CSFDB_Getgp_Ax2dvdir | ( |  | ) | const`[inline]`

Standard_Real gp_Ax2d::Angle | ( | const gp_Ax2d & | Other | ) | const`[inline]`

const gp_Dir2d & gp_Ax2d::Direction | ( |  | ) | const`[inline]`

Standard_EXPORT Standard_Boolean gp_Ax2d::IsCoaxial | ( | const gp_Ax2d & | Other,
|  | const Standard_Real | AngularTolerance,
|  | const Standard_Real | LinearTolerance
| ) | const

Standard_Boolean gp_Ax2d::IsNormal | ( | const gp_Ax2d & | Other,
|  | const Standard_Real | AngularTolerance
| ) | const`[inline]`

Standard_Boolean gp_Ax2d::IsOpposite | ( | const gp_Ax2d & | Other,
|  | const Standard_Real | AngularTolerance
| ) | const`[inline]`

Standard_Boolean gp_Ax2d::IsParallel | ( | const gp_Ax2d & | Other,
|  | const Standard_Real | AngularTolerance
| ) | const`[inline]`

const gp_Pnt2d & gp_Ax2d::Location | ( |  | ) | const`[inline]`

Standard_EXPORT void gp_Ax2d::Mirror | ( | const gp_Ax2d & | A | ) |

Standard_EXPORT void gp_Ax2d::Mirror | ( | const gp_Pnt2d & | P | ) |

Standard_EXPORT gp_Ax2d gp_Ax2d::Mirrored | ( | const gp_Ax2d & | A | ) | const

Standard_EXPORT gp_Ax2d gp_Ax2d::Mirrored | ( | const gp_Pnt2d & | P | ) | const

void gp_Ax2d::operator delete | ( | void * | anAddress | ) | `[inline]`

void* gp_Ax2d::operator new | ( | size_t | size | ) | `[inline]`

void* gp_Ax2d::operator new | ( | size_t | ,
|  | void * | anAddress
| ) | `[inline]`

void gp_Ax2d::Reverse | ( |  | ) | `[inline]`

gp_Ax2d gp_Ax2d::Reversed | ( |  | ) | const`[inline]`

void gp_Ax2d::Rotate | ( | const gp_Pnt2d & | P,
|  | const Standard_Real | Ang
| ) | `[inline]`

gp_Ax2d gp_Ax2d::Rotated | ( | const gp_Pnt2d & | P,
|  | const Standard_Real | Ang
| ) | const`[inline]`

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

gp_Ax2d gp_Ax2d::Scaled | ( | const gp_Pnt2d & | P,
|  | const Standard_Real | S
| ) | const`[inline]`

void gp_Ax2d::SetDirection | ( | const gp_Dir2d & | V | ) | `[inline]`

void gp_Ax2d::SetLocation | ( | const gp_Pnt2d & | Locat | ) | `[inline]`

void gp_Ax2d::Transform | ( | const gp_Trsf2d & | T | ) | `[inline]`

gp_Ax2d gp_Ax2d::Transformed | ( | const gp_Trsf2d & | T | ) | const`[inline]`

void gp_Ax2d::Translate | ( | const gp_Pnt2d & | P1,
|  | const gp_Pnt2d & | P2
| ) | `[inline]`

void gp_Ax2d::Translate | ( | const gp_Vec2d & | V | ) | `[inline]`

gp_Ax2d gp_Ax2d::Translated | ( | const gp_Pnt2d & | P1,
|  | const gp_Pnt2d & | P2
| ) | const`[inline]`

gp_Ax2d gp_Ax2d::Translated | ( | const gp_Vec2d & | V | ) | const`[inline]`

## Friends And Related Function Documentation

Standard_EXPORT friend Handle_Standard_Type& gp_Ax2d_Type_ | ( |  | ) | `[friend]`

## Field Documentation

gp_Pnt2d gp_Ax2d::loc `[private]`

gp_Dir2d gp_Ax2d::vdir `[private]`

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

- gp_Ax2d.hxx
- gp_Ax2d.lxx