Geom2d_VectorWithMagnitude Class Reference

Defines a vector with magnitude. A vector with magnitude can have a zero length. More...

#include <Geom2d_VectorWithMagnitude.hxx>

Inheritance diagram for Geom2d_VectorWithMagnitude:

Public Member Functions
	Geom2d_VectorWithMagnitude (const gp_Vec2d &V)
	Creates a persistent copy of V.
	Geom2d_VectorWithMagnitude (const double X, const double Y)
	Creates a vector with two cartesian coordinates.
	Geom2d_VectorWithMagnitude (const gp_Pnt2d &P1, const gp_Pnt2d &P2)
	Creates a vector from the point P1 to the point P2. The magnitude of the vector is the distance between P1 and P2.
void	SetCoord (const double X, const double Y)
	Set <me> to X, Y coordinates.
void	SetVec2d (const gp_Vec2d &V)
void	SetX (const double X)
	Changes the X coordinate of <me>.
void	SetY (const double Y)
	Changes the Y coordinate of <me>.
double	Magnitude () const override
	Returns the magnitude of <me>.
double	SquareMagnitude () const override
	Returns the square magnitude of <me>.
void	Add (const occ::handle< Geom2d_Vector > &Other)
	Adds the Vector Other to <me>.
void	operator+= (const occ::handle< Geom2d_Vector > &Other)
occ::handle< Geom2d_VectorWithMagnitude >	Added (const occ::handle< Geom2d_Vector > &Other) const
	Adds the vector Other to <me>.
occ::handle< Geom2d_VectorWithMagnitude >	operator+ (const occ::handle< Geom2d_Vector > &Other) const
double	Crossed (const occ::handle< Geom2d_Vector > &Other) const override
	Computes the cross product between <me> and Other <me> ^ Other. A new vector is returned.
double	operator^ (const occ::handle< Geom2d_Vector > &Other) const
void	Divide (const double Scalar)
	Divides <me> by a scalar.
void	operator/= (const double Scalar)
occ::handle< Geom2d_VectorWithMagnitude >	Divided (const double Scalar) const
	Divides <me> by a scalar. A new vector is returned.
occ::handle< Geom2d_VectorWithMagnitude >	operator/ (const double Scalar) const
occ::handle< Geom2d_VectorWithMagnitude >	Multiplied (const double Scalar) const
	Computes the product of the vector <me> by a scalar. A new vector is returned.
void	Multiply (const double Scalar)
	Computes the product of the vector <me> by a scalar.
void	operator*= (const double Scalar)
void	Normalize ()
	Normalizes <me>.
occ::handle< Geom2d_VectorWithMagnitude >	Normalized () const
	Returns a copy of <me> Normalized.
void	Subtract (const occ::handle< Geom2d_Vector > &Other)
	Subtracts the Vector Other to <me>.
void	operator-= (const occ::handle< Geom2d_Vector > &Other)
occ::handle< Geom2d_VectorWithMagnitude >	Subtracted (const occ::handle< Geom2d_Vector > &Other) const
	Subtracts the vector Other to <me>. A new vector is returned.
occ::handle< Geom2d_VectorWithMagnitude >	operator- (const occ::handle< Geom2d_Vector > &Other) const
void	Transform (const gp_Trsf2d &T) override
	Applies the transformation T to this vector.
occ::handle< Geom2d_Geometry >	Copy () const override
	Creates a new object which is a copy of this vector.
Public Member Functions inherited from Geom2d_Vector
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>.
double	X () const
	Returns the X coordinate of <me>.
double	Y () const
	Returns the Y coordinate of <me>.
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.
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 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.

Additional Inherited Members
typedef void	base_type
	Returns a type descriptor about this object.
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.
Protected Attributes inherited from Geom2d_Vector
gp_Vec2d	gpVec2d

Detailed Description

Defines a vector with magnitude. A vector with magnitude can have a zero length.

Constructor & Destructor Documentation

Geom2d_VectorWithMagnitude() [1/3]

Geom2d_VectorWithMagnitude::Geom2d_VectorWithMagnitude

(

const gp_Vec2d &

V

)

Creates a persistent copy of V.

Geom2d_VectorWithMagnitude() [2/3]

Geom2d_VectorWithMagnitude::Geom2d_VectorWithMagnitude	(	const double	X,
		const double	Y )

Creates a vector with two cartesian coordinates.

Geom2d_VectorWithMagnitude() [3/3]

Geom2d_VectorWithMagnitude::Geom2d_VectorWithMagnitude	(	const gp_Pnt2d &	P1,
		const gp_Pnt2d &	P2 )

Creates a vector from the point P1 to the point P2. The magnitude of the vector is the distance between P1 and P2.

Member Function Documentation

Add()

void Geom2d_VectorWithMagnitude::Add

(

const occ::handle< Geom2d_Vector > &

Other

)

Adds the Vector Other to <me>.

Added()

occ::handle< Geom2d_VectorWithMagnitude > Geom2d_VectorWithMagnitude::Added ( const occ::handle< Geom2d_Vector > & Other ) const

nodiscard

Adds the vector Other to <me>.

Copy()

occ::handle< Geom2d_Geometry > Geom2d_VectorWithMagnitude::Copy ( ) const

overridevirtual

Creates a new object which is a copy of this vector.

Implements Geom2d_Geometry.

Crossed()

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

overridevirtual

Computes the cross product between <me> and Other <me> ^ Other. A new vector is returned.

Implements Geom2d_Vector.

Divide()

void Geom2d_VectorWithMagnitude::Divide

(

const double

Scalar

)

Divides <me> by a scalar.

Divided()

occ::handle< Geom2d_VectorWithMagnitude > Geom2d_VectorWithMagnitude::Divided ( const double Scalar ) const

nodiscard

Divides <me> by a scalar. A new vector is returned.

Magnitude()

double Geom2d_VectorWithMagnitude::Magnitude ( ) const

overridevirtual

Returns the magnitude of <me>.

Implements Geom2d_Vector.

Multiplied()

occ::handle< Geom2d_VectorWithMagnitude > Geom2d_VectorWithMagnitude::Multiplied ( const double Scalar ) const

nodiscard

Computes the product of the vector <me> by a scalar. A new vector is returned.

-C++: alias operator * Collision with same operator defined for the class Vector!

Multiply()

void Geom2d_VectorWithMagnitude::Multiply

(

const double

Scalar

)

Computes the product of the vector <me> by a scalar.

Normalize()

void Geom2d_VectorWithMagnitude::Normalize

(

)

Normalizes <me>.

Raised if the magnitude of the vector is lower or equal to Resolution from package gp.

Normalized()

occ::handle< Geom2d_VectorWithMagnitude > Geom2d_VectorWithMagnitude::Normalized ( ) const

nodiscard

Returns a copy of <me> Normalized.

Raised if the magnitude of the vector is lower or equal to Resolution from package gp.

operator*=()

void Geom2d_VectorWithMagnitude::operator*= ( const double Scalar )

inline

operator+()

occ::handle< Geom2d_VectorWithMagnitude > Geom2d_VectorWithMagnitude::operator+ ( const occ::handle< Geom2d_Vector > & Other ) const

inlinenodiscard

operator+=()

void Geom2d_VectorWithMagnitude::operator+= ( const occ::handle< Geom2d_Vector > & Other )

inline

operator-()

occ::handle< Geom2d_VectorWithMagnitude > Geom2d_VectorWithMagnitude::operator- ( const occ::handle< Geom2d_Vector > & Other ) const

inlinenodiscard

operator-=()

void Geom2d_VectorWithMagnitude::operator-= ( const occ::handle< Geom2d_Vector > & Other )

inline

operator/()

occ::handle< Geom2d_VectorWithMagnitude > Geom2d_VectorWithMagnitude::operator/ ( const double Scalar ) const

inlinenodiscard

operator/=()

void Geom2d_VectorWithMagnitude::operator/= ( const double Scalar )

inline

operator^()

double Geom2d_VectorWithMagnitude::operator^ ( const occ::handle< Geom2d_Vector > & Other ) const

inline

SetCoord()

void Geom2d_VectorWithMagnitude::SetCoord	(	const double	X,
		const double	Y )

Set <me> to X, Y coordinates.

SetVec2d()

void Geom2d_VectorWithMagnitude::SetVec2d

(

const gp_Vec2d &

V

)

SetX()

void Geom2d_VectorWithMagnitude::SetX

(

const double

X

)

Changes the X coordinate of <me>.

SetY()

void Geom2d_VectorWithMagnitude::SetY

(

const double

Y

)

Changes the Y coordinate of <me>.

SquareMagnitude()

double Geom2d_VectorWithMagnitude::SquareMagnitude ( ) const

overridevirtual

Returns the square magnitude of <me>.

Implements Geom2d_Vector.

Subtract()

void Geom2d_VectorWithMagnitude::Subtract

(

const occ::handle< Geom2d_Vector > &

Other

)

Subtracts the Vector Other to <me>.

Subtracted()

occ::handle< Geom2d_VectorWithMagnitude > Geom2d_VectorWithMagnitude::Subtracted ( const occ::handle< Geom2d_Vector > & Other ) const

nodiscard

Subtracts the vector Other to <me>. A new vector is returned.

Transform()

void Geom2d_VectorWithMagnitude::Transform ( const gp_Trsf2d & T )

overridevirtual

Applies the transformation T to this vector.

Implements Geom2d_Geometry.

---

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

• Geom2d_VectorWithMagnitude.hxx