The abstract class Vector describes the common behavior of vectors in 2D space. The Geom2d package provides two concrete classes of vectors: Geom2d_Direction (unit vector) and Geom2d_VectorWithMagnitude. More...

#include <Geom2d_Vector.hxx>

Inheritance diagram for Geom2d_Vector:

[legend]

Public Member Functions
void	Reverse ()
	Reverses the vector <me>.

occ::handle< Geom2d_Vector >	Reversed () const
	Returns a copy of <me> reversed.

double	Angle (const occ::handle< Geom2d_Vector > &Other) const
	Computes the angular value, in radians, between this vector and vector Other. The result is a value between -Pi and Pi. The orientation is from this vector to vector Other. Raises VectorWithNullMagnitude if one of the two vectors is a vector with null magnitude because the angular value is indefinite.

void	Coord (double &X, double &Y) const
	Returns the coordinates of <me>.

virtual double	Magnitude () const =0
	Returns the Magnitude of <me>.

virtual double	SquareMagnitude () const =0
	Returns the square magnitude of <me>.

double	X () const
	Returns the X coordinate of <me>.

double	Y () const
	Returns the Y coordinate of <me>.

virtual double	Crossed (const occ::handle< Geom2d_Vector > &Other) const =0
	Cross product of <me> with the vector <Other>.

double	Dot (const occ::handle< Geom2d_Vector > &Other) const
	Returns the scalar product of 2 Vectors.

gp_Vec2d	Vec2d () const
	Returns a non persistent copy of <me>.

Public Member Functions inherited from Geom2d_Geometry
void	Mirror (const gp_Pnt2d &P)
	Performs the symmetrical transformation of a Geometry with respect to the point P which is the center of the symmetry and assigns the result to this geometric object.

void	Mirror (const gp_Ax2d &A)
	Performs the symmetrical transformation of a Geometry with respect to an axis placement which is the axis of the symmetry.

void	Rotate (const gp_Pnt2d &P, const double Ang)
	Rotates a Geometry. P is the center of the rotation. Ang is the angular value of the rotation in radians.

void	Scale (const gp_Pnt2d &P, const double S)
	Scales a Geometry. S is the scaling value.

void	Translate (const gp_Vec2d &V)
	Translates a Geometry. V is the vector of the translation.

void	Translate (const gp_Pnt2d &P1, const gp_Pnt2d &P2)
	Translates a Geometry from the point P1 to the point P2.

virtual void	Transform (const gp_Trsf2d &T)=0
	Transformation of a geometric object. This transformation can be a translation, a rotation, a symmetry, a scaling or a complex transformation obtained by combination of the previous elementaries transformations. (see class Transformation of the package Geom2d). The following transformations have the same properties as the previous ones but they don't modified the object itself. A copy of the object is returned.

occ::handle< Geom2d_Geometry >	Mirrored (const gp_Pnt2d &P) const

occ::handle< Geom2d_Geometry >	Mirrored (const gp_Ax2d &A) const

occ::handle< Geom2d_Geometry >	Rotated (const gp_Pnt2d &P, const double Ang) const

occ::handle< Geom2d_Geometry >	Scaled (const gp_Pnt2d &P, const double S) const

occ::handle< Geom2d_Geometry >	Transformed (const gp_Trsf2d &T) const

occ::handle< Geom2d_Geometry >	Translated (const gp_Vec2d &V) const

occ::handle< Geom2d_Geometry >	Translated (const gp_Pnt2d &P1, const gp_Pnt2d &P2) const

virtual occ::handle< Geom2d_Geometry >	Copy () const =0

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

Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor.

	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing.

Standard_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter.

virtual	~Standard_Transient ()=default
	Destructor must be virtual.

virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.

bool	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.

bool	IsInstance (const char *const theTypeName) const
	Returns a true value if this is an instance of TypeName.

bool	IsKind (const opencascade::handle< Standard_Type > &theType) const
	Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.

bool	IsKind (const char *const theTypeName) const
	Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.

Standard_Transient *	This () const
	Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.

int	GetRefCount () const noexcept
	Get the reference counter of this object.

void	IncrementRefCounter () noexcept
	Increments the reference counter of this object. Uses relaxed memory ordering since incrementing only requires atomicity, not synchronization with other memory operations.

int	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value. Uses release ordering for the decrement to ensure all writes to the object are visible before the count reaches zero. An acquire fence is added only when the count reaches zero, ensuring proper synchronization before deletion. This is more efficient than using acq_rel for every decrement.

virtual void	Delete () const
	Memory deallocator for transient classes.

Protected Attributes
gp_Vec2d	gpVec2d

Additional Inherited Members
Public Types inherited from Standard_Transient
typedef void	base_type
	Returns a type descriptor about this object.

Static Public Member Functions inherited from Standard_Transient
static constexpr const char *	get_type_name ()
	Returns a type descriptor about this object.

static const opencascade::handle< Standard_Type > &	get_type_descriptor ()
	Returns type descriptor of Standard_Transient class.

Detailed Description

The abstract class Vector describes the common behavior of vectors in 2D space. The Geom2d package provides two concrete classes of vectors: Geom2d_Direction (unit vector) and Geom2d_VectorWithMagnitude.

Member Function Documentation

◆ Angle()

double Geom2d_Vector::Angle ( const occ::handle< Geom2d_Vector > & Other ) const

Computes the angular value, in radians, between this vector and vector Other. The result is a value between -Pi and Pi. The orientation is from this vector to vector Other. Raises VectorWithNullMagnitude if one of the two vectors is a vector with null magnitude because the angular value is indefinite.

◆ Coord()

void Geom2d_Vector::Coord	(	double &	X,
		double &	Y ) const

Returns the coordinates of <me>.

◆ Crossed()

virtual double Geom2d_Vector::Crossed ( const occ::handle< Geom2d_Vector > & Other ) const

pure virtual

Cross product of <me> with the vector <Other>.

Implemented in Geom2d_Direction, and Geom2d_VectorWithMagnitude.

◆ Dot()

double Geom2d_Vector::Dot ( const occ::handle< Geom2d_Vector > & Other ) const

Returns the scalar product of 2 Vectors.

◆ Magnitude()

virtual double Geom2d_Vector::Magnitude ( ) const

pure virtual

Returns the Magnitude of <me>.

Implemented in Geom2d_Direction, and Geom2d_VectorWithMagnitude.

◆ Reverse()

void Geom2d_Vector::Reverse ( )

Reverses the vector <me>.

◆ Reversed()

occ::handle< Geom2d_Vector > Geom2d_Vector::Reversed ( ) const

Returns a copy of <me> reversed.

◆ SquareMagnitude()

virtual double Geom2d_Vector::SquareMagnitude ( ) const

pure virtual

Returns the square magnitude of <me>.

Implemented in Geom2d_Direction, and Geom2d_VectorWithMagnitude.

◆ Vec2d()

gp_Vec2d Geom2d_Vector::Vec2d ( ) const

Returns a non persistent copy of <me>.

◆ X()

double Geom2d_Vector::X ( ) const

Returns the X coordinate of <me>.

◆ Y()

double Geom2d_Vector::Y ( ) const

Returns the Y coordinate of <me>.

Field Documentation

◆ gpVec2d

gp_Vec2d Geom2d_Vector::gpVec2d

protected

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

Geom2d_Vector.hxx

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ Angle()

◆ Coord()

◆ Crossed()

◆ Dot()

◆ Magnitude()

◆ Reverse()

◆ Reversed()

◆ SquareMagnitude()

◆ Vec2d()

◆ X()

◆ Y()

Field Documentation

◆ gpVec2d