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

#include <gp_Ax2d.hxx>

Public Member Functions
constexpr	gp_Ax2d () noexcept
	Creates an axis object representing X axis of the reference coordinate system.

constexpr	gp_Ax2d (const gp_Pnt2d &theP, const gp_Dir2d &theV) noexcept
	Creates an Ax2d. <theP> is the "Location" point of the axis placement and theV is the "Direction" of the axis placement.

constexpr	gp_Ax2d (const gp_Pnt2d &theP, const gp_Dir2d::D theDir) noexcept
	Creates an axis with the given location point and standard direction.

constexpr	gp_Ax2d (const gp_Dir2d::D theDir) noexcept
	Creates an axis at the origin with the given standard direction. Replaces gp::OX2d(), gp::OY2d() static functions.

constexpr void	SetLocation (const gp_Pnt2d &theP) noexcept
	Changes the "Location" point (origin) of <me>.

constexpr void	SetDirection (const gp_Dir2d &theV) noexcept
	Changes the direction of <me>.

constexpr const gp_Pnt2d &	Location () const noexcept
	Returns the origin of <me>.

constexpr const gp_Dir2d &	Direction () const noexcept
	Returns the direction of <me>.

bool	IsCoaxial (const gp_Ax2d &Other, const double AngularTolerance, const double 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.

bool	IsNormal (const gp_Ax2d &theOther, const double 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.

bool	IsOpposite (const gp_Ax2d &theOther, const double 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.

bool	IsParallel (const gp_Ax2d &theOther, const double 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.

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

constexpr void	Reverse () noexcept
	Reverses the direction of <me> and assigns the result to this axis.

constexpr gp_Ax2d	Reversed () const noexcept
	Computes a new axis placement with a direction opposite to the direction of <me>.

void	Mirror (const gp_Pnt2d &P) noexcept

gp_Ax2d	Mirrored (const gp_Pnt2d &P) const noexcept
	Performs the symmetrical transformation of an axis placement with respect to the point P which is the center of the symmetry.

void	Mirror (const gp_Ax2d &A) noexcept

gp_Ax2d	Mirrored (const gp_Ax2d &A) const noexcept
	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 &theP, const double theAng)

gp_Ax2d	Rotated (const gp_Pnt2d &theP, const double theAng) const
	Rotates an axis placement. <theP> is the center of the rotation. theAng is the angular value of the rotation in radians.

void	Scale (const gp_Pnt2d &P, const double S)

gp_Ax2d	Scaled (const gp_Pnt2d &theP, const double 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.

void	Transform (const gp_Trsf2d &theT)

gp_Ax2d	Transformed (const gp_Trsf2d &theT) const
	Transforms an axis placement with a Trsf.

constexpr void	Translate (const gp_Vec2d &theV) noexcept

constexpr gp_Ax2d	Translated (const gp_Vec2d &theV) const noexcept
	Translates an axis placement in the direction of the vector theV. The magnitude of the translation is the vector's magnitude.

constexpr void	Translate (const gp_Pnt2d &theP1, const gp_Pnt2d &theP2) noexcept

constexpr gp_Ax2d	Translated (const gp_Pnt2d &theP1, const gp_Pnt2d &theP2) const noexcept
	Translates an axis placement from the point theP1 to the point theP2.

void	DumpJson (Standard_OStream &theOStream, int theDepth=-1) const
	Dumps the content of me into the stream.

Detailed Description

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.

Constructor & Destructor Documentation

◆ gp_Ax2d() [1/4]

constexpr gp_Ax2d::gp_Ax2d ( )

inlineconstexprnoexcept

Creates an axis object representing X axis of the reference coordinate system.

◆ gp_Ax2d() [2/4]

constexpr gp_Ax2d::gp_Ax2d	(	const gp_Pnt2d &	theP,
		const gp_Dir2d &	theV )

inlineconstexprnoexcept

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

◆ gp_Ax2d() [3/4]

constexpr gp_Ax2d::gp_Ax2d	(	const gp_Pnt2d &	theP,
		const gp_Dir2d::D	theDir )

inlineconstexprnoexcept

Creates an axis with the given location point and standard direction.

◆ gp_Ax2d() [4/4]

constexpr gp_Ax2d::gp_Ax2d ( const gp_Dir2d::D theDir )

inlineexplicitconstexprnoexcept

Creates an axis at the origin with the given standard direction. Replaces gp::OX2d(), gp::OY2d() static functions.

Member Function Documentation

◆ Angle()

double 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()

constexpr const gp_Dir2d & gp_Ax2d::Direction ( ) const

inlineconstexprnoexcept

Returns the direction of <me>.

◆ DumpJson()

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

Dumps the content of me into the stream.

◆ IsCoaxial()

bool gp_Ax2d::IsCoaxial	(	const gp_Ax2d &	Other,
		const double	AngularTolerance,
		const double	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()

bool gp_Ax2d::IsNormal	(	const gp_Ax2d &	theOther,
		const double	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()

bool gp_Ax2d::IsOpposite	(	const gp_Ax2d &	theOther,
		const double	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()

bool gp_Ax2d::IsParallel	(	const gp_Ax2d &	theOther,
		const double	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()

constexpr const gp_Pnt2d & gp_Ax2d::Location ( ) const

inlineconstexprnoexcept

Returns the origin of <me>.

◆ Mirror() [1/2]

void gp_Ax2d::Mirror ( const gp_Ax2d & A )

noexcept

◆ Mirror() [2/2]

void gp_Ax2d::Mirror ( const gp_Pnt2d & P )

noexcept

◆ Mirrored() [1/2]

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

noexcept

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

noexcept

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

◆ Reverse()

constexpr void gp_Ax2d::Reverse ( )

inlineconstexprnoexcept

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

◆ Reversed()

constexpr gp_Ax2d gp_Ax2d::Reversed ( ) const

inlineconstexprnoexcept

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

◆ Rotate()

void gp_Ax2d::Rotate	(	const gp_Pnt2d &	theP,
		const double	theAng )

inline

◆ Rotated()

gp_Ax2d gp_Ax2d::Rotated	(	const gp_Pnt2d &	theP,
		const double	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 double	S )

◆ Scaled()

gp_Ax2d gp_Ax2d::Scaled	(	const gp_Pnt2d &	theP,
		const double	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()

constexpr void gp_Ax2d::SetDirection ( const gp_Dir2d & theV )

inlineconstexprnoexcept

Changes the direction of <me>.

◆ SetLocation()

constexpr void gp_Ax2d::SetLocation ( const gp_Pnt2d & theP )

inlineconstexprnoexcept

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]

constexpr void gp_Ax2d::Translate	(	const gp_Pnt2d &	theP1,
		const gp_Pnt2d &	theP2 )

inlineconstexprnoexcept

◆ Translate() [2/2]

constexpr void gp_Ax2d::Translate ( const gp_Vec2d & theV )

inlineconstexprnoexcept

◆ Translated() [1/2]

constexpr gp_Ax2d gp_Ax2d::Translated	(	const gp_Pnt2d &	theP1,
		const gp_Pnt2d &	theP2 ) const

inlineconstexprnoexcept

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

◆ Translated() [2/2]

constexpr gp_Ax2d gp_Ax2d::Translated ( const gp_Vec2d & theV ) const

inlineconstexprnoexcept

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:

gp_Ax2d.hxx

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ gp_Ax2d() [1/4]

◆ gp_Ax2d() [2/4]

◆ gp_Ax2d() [3/4]

◆ gp_Ax2d() [4/4]

Member Function Documentation

◆ Angle()

◆ Direction()

◆ DumpJson()

◆ IsCoaxial()

◆ IsNormal()

◆ IsOpposite()

◆ IsParallel()

◆ Location()

◆ Mirror() [1/2]

◆ Mirror() [2/2]

◆ Mirrored() [1/2]

◆ Mirrored() [2/2]

◆ Reverse()

◆ Reversed()

◆ Rotate()

◆ Rotated()

◆ Scale()

◆ Scaled()

◆ SetDirection()

◆ SetLocation()

◆ Transform()

◆ Transformed()

◆ Translate() [1/2]

◆ Translate() [2/2]

◆ Translated() [1/2]

◆ Translated() [2/2]