Open CASCADE Technology  7.7.0.dev
Public Member Functions

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:
Inheritance graph
[legend]

Public Member Functions

 Geom2d_VectorWithMagnitude (const gp_Vec2d &V)
 Creates a persistent copy of V. More...
 
 Geom2d_VectorWithMagnitude (const Standard_Real X, const Standard_Real Y)
 Creates a vector with two cartesian coordinates. More...
 
 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. More...
 
void SetCoord (const Standard_Real X, const Standard_Real Y)
 Set <me> to X, Y coordinates. More...
 
void SetVec2d (const gp_Vec2d &V)
 
void SetX (const Standard_Real X)
 Changes the X coordinate of <me>. More...
 
void SetY (const Standard_Real Y)
 Changes the Y coordinate of <me> More...
 
Standard_Real Magnitude () const override
 Returns the magnitude of <me>. More...
 
Standard_Real SquareMagnitude () const override
 Returns the square magnitude of <me>. More...
 
void Add (const Handle< Geom2d_Vector > &Other)
 Adds the Vector Other to <me>. More...
 
void operator+= (const Handle< Geom2d_Vector > &Other)
 
Handle< Geom2d_VectorWithMagnitudeAdded (const Handle< Geom2d_Vector > &Other) const
 Adds the vector Other to <me>. More...
 
Handle< Geom2d_VectorWithMagnitudeoperator+ (const Handle< Geom2d_Vector > &Other) const
 
Standard_Real Crossed (const Handle< Geom2d_Vector > &Other) const override
 Computes the cross product between <me> and Other <me> ^ Other. A new vector is returned. More...
 
Standard_Real operator^ (const Handle< Geom2d_Vector > &Other) const
 
void Divide (const Standard_Real Scalar)
 Divides <me> by a scalar. More...
 
void operator/= (const Standard_Real Scalar)
 
Handle< Geom2d_VectorWithMagnitudeDivided (const Standard_Real Scalar) const
 Divides <me> by a scalar. A new vector is returned. More...
 
Handle< Geom2d_VectorWithMagnitudeoperator/ (const Standard_Real Scalar) const
 
Handle< Geom2d_VectorWithMagnitudeMultiplied (const Standard_Real Scalar) const
 Computes the product of the vector <me> by a scalar. A new vector is returned. More...
 
void Multiply (const Standard_Real Scalar)
 Computes the product of the vector <me> by a scalar. More...
 
void operator*= (const Standard_Real Scalar)
 
void Normalize ()
 Normalizes <me>. More...
 
Handle< Geom2d_VectorWithMagnitudeNormalized () const
 Returns a copy of <me> Normalized. More...
 
void Subtract (const Handle< Geom2d_Vector > &Other)
 Subtracts the Vector Other to <me>. More...
 
void operator-= (const Handle< Geom2d_Vector > &Other)
 
Handle< Geom2d_VectorWithMagnitudeSubtracted (const Handle< Geom2d_Vector > &Other) const
 Subtracts the vector Other to <me>. A new vector is returned. More...
 
Handle< Geom2d_VectorWithMagnitudeoperator- (const Handle< Geom2d_Vector > &Other) const
 
void Transform (const gp_Trsf2d &T) override
 Applies the transformation T to this vector. More...
 
Handle< Geom2d_GeometryCopy () const override
 Creates a new object which is a copy of this vector. More...
 
- Public Member Functions inherited from Geom2d_Vector
void Reverse ()
 Reverses the vector <me>. More...
 
Handle< Geom2d_VectorReversed () const
 Returns a copy of <me> reversed. More...
 
Standard_Real Angle (const 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. More...
 
void Coord (Standard_Real &X, Standard_Real &Y) const
 Returns the coordinates of <me>. More...
 
Standard_Real X () const
 Returns the X coordinate of <me>. More...
 
Standard_Real Y () const
 Returns the Y coordinate of <me>. More...
 
Standard_Real Dot (const Handle< Geom2d_Vector > &Other) const
 Returns the scalar product of 2 Vectors. More...
 
gp_Vec2d Vec2d () const
 Returns a non persistent copy of <me>. More...
 
- 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. More...
 
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. More...
 
void Rotate (const gp_Pnt2d &P, const Standard_Real Ang)
 Rotates a Geometry. P is the center of the rotation. Ang is the angular value of the rotation in radians. More...
 
void Scale (const gp_Pnt2d &P, const Standard_Real S)
 Scales a Geometry. S is the scaling value. More...
 
void Translate (const gp_Vec2d &V)
 Translates a Geometry. V is the vector of the translation. More...
 
void Translate (const gp_Pnt2d &P1, const gp_Pnt2d &P2)
 Translates a Geometry from the point P1 to the point P2. More...
 
Handle< Geom2d_GeometryMirrored (const gp_Pnt2d &P) const
 
Handle< Geom2d_GeometryMirrored (const gp_Ax2d &A) const
 
Handle< Geom2d_GeometryRotated (const gp_Pnt2d &P, const Standard_Real Ang) const
 
Handle< Geom2d_GeometryScaled (const gp_Pnt2d &P, const Standard_Real S) const
 
Handle< Geom2d_GeometryTransformed (const gp_Trsf2d &T) const
 
Handle< Geom2d_GeometryTranslated (const gp_Vec2d &V) const
 
Handle< Geom2d_GeometryTranslated (const gp_Pnt2d &P1, const gp_Pnt2d &P2) const
 
virtual void DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const
 Dumps the content of me into the stream. More...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual void Delete () const
 Memory deallocator for transient classes. More...
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object. More...
 
Standard_Boolean IsInstance (const opencascade::handle< Standard_Type > &theType) const
 Returns a true value if this is an instance of Type. More...
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName. More...
 
Standard_Boolean 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. More...
 
Standard_Boolean IsKind (const Standard_CString 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. More...
 
Standard_TransientThis () 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. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 
void IncrementRefCounter () const
 Increments the reference counter of this object. More...
 
Standard_Integer DecrementRefCounter () const
 Decrements the reference counter of this object; returns the decremented value. More...
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 
- Static Public Member Functions inherited from Standard_Transient
static const char * get_type_name ()
 Returns a type descriptor about this object. More...
 
static const opencascade::handle< Standard_Type > & get_type_descriptor ()
 Returns type descriptor of Standard_Transient class. More...
 
- 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 Standard_Real  X,
const Standard_Real  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 Handle< Geom2d_Vector > &  Other)

Adds the Vector Other to <me>.

◆ Added()

Handle< Geom2d_VectorWithMagnitude > Geom2d_VectorWithMagnitude::Added ( const Handle< Geom2d_Vector > &  Other) const

Adds the vector Other to <me>.

◆ Copy()

Handle< Geom2d_Geometry > Geom2d_VectorWithMagnitude::Copy ( ) const
overridevirtual

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

Implements Geom2d_Geometry.

◆ Crossed()

Standard_Real Geom2d_VectorWithMagnitude::Crossed ( const 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 Standard_Real  Scalar)

Divides <me> by a scalar.

◆ Divided()

Handle< Geom2d_VectorWithMagnitude > Geom2d_VectorWithMagnitude::Divided ( const Standard_Real  Scalar) const

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

◆ Magnitude()

Standard_Real Geom2d_VectorWithMagnitude::Magnitude ( ) const
overridevirtual

Returns the magnitude of <me>.

Implements Geom2d_Vector.

◆ Multiplied()

Handle< Geom2d_VectorWithMagnitude > Geom2d_VectorWithMagnitude::Multiplied ( const Standard_Real  Scalar) const

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

Handle< Geom2d_VectorWithMagnitude > Geom2d_VectorWithMagnitude::Normalized ( ) const

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 Standard_Real  Scalar)
inline

◆ operator+()

Handle< Geom2d_VectorWithMagnitude > Geom2d_VectorWithMagnitude::operator+ ( const Handle< Geom2d_Vector > &  Other) const
inline

◆ operator+=()

void Geom2d_VectorWithMagnitude::operator+= ( const Handle< Geom2d_Vector > &  Other)
inline

◆ operator-()

Handle< Geom2d_VectorWithMagnitude > Geom2d_VectorWithMagnitude::operator- ( const Handle< Geom2d_Vector > &  Other) const
inline

◆ operator-=()

void Geom2d_VectorWithMagnitude::operator-= ( const Handle< Geom2d_Vector > &  Other)
inline

◆ operator/()

Handle< Geom2d_VectorWithMagnitude > Geom2d_VectorWithMagnitude::operator/ ( const Standard_Real  Scalar) const
inline

◆ operator/=()

void Geom2d_VectorWithMagnitude::operator/= ( const Standard_Real  Scalar)
inline

◆ operator^()

Standard_Real Geom2d_VectorWithMagnitude::operator^ ( const Handle< Geom2d_Vector > &  Other) const
inline

◆ SetCoord()

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

Set <me> to X, Y coordinates.

◆ SetVec2d()

void Geom2d_VectorWithMagnitude::SetVec2d ( const gp_Vec2d V)

◆ SetX()

void Geom2d_VectorWithMagnitude::SetX ( const Standard_Real  X)

Changes the X coordinate of <me>.

◆ SetY()

void Geom2d_VectorWithMagnitude::SetY ( const Standard_Real  Y)

Changes the Y coordinate of <me>

◆ SquareMagnitude()

Standard_Real Geom2d_VectorWithMagnitude::SquareMagnitude ( ) const
overridevirtual

Returns the square magnitude of <me>.

Implements Geom2d_Vector.

◆ Subtract()

void Geom2d_VectorWithMagnitude::Subtract ( const Handle< Geom2d_Vector > &  Other)

Subtracts the Vector Other to <me>.

◆ Subtracted()

Handle< Geom2d_VectorWithMagnitude > Geom2d_VectorWithMagnitude::Subtracted ( const Handle< Geom2d_Vector > &  Other) const

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: