Open CASCADE Technology  7.7.0.dev
Public Member Functions

Geom2d_Direction Class Reference

The class Direction specifies a vector that is never null. It is a unit vector. More...

#include <Geom2d_Direction.hxx>

Inheritance diagram for Geom2d_Direction:
Inheritance graph
[legend]

Public Member Functions

 Geom2d_Direction (const Standard_Real X, const Standard_Real Y)
 Creates a unit vector with it 2 cartesian coordinates. More...
 
 Geom2d_Direction (const gp_Dir2d &V)
 Creates a persistent copy of <me>. More...
 
void SetCoord (const Standard_Real X, const Standard_Real Y)
 Assigns the coordinates X and Y to this unit vector, then normalizes it. Exceptions Standard_ConstructionError if Sqrt(X*X + Y*Y) is less than or equal to gp::Resolution(). More...
 
void SetDir2d (const gp_Dir2d &V)
 Converts the gp_Dir2d unit vector V into this unit vector. More...
 
void SetX (const Standard_Real X)
 Assigns a value to the X coordinate of this unit vector, then normalizes it. Exceptions Standard_ConstructionError if the value assigned causes the magnitude of the vector to become less than or equal to gp::Resolution(). More...
 
void SetY (const Standard_Real Y)
 Assigns a value to the Y coordinate of this unit vector, then normalizes it. Exceptions Standard_ConstructionError if the value assigned causes the magnitude of the vector to become less than or equal to gp::Resolution(). More...
 
gp_Dir2d Dir2d () const
 Converts this unit vector into a gp_Dir2d unit vector. More...
 
Standard_Real Magnitude () const override
 returns 1.0 More...
 
Standard_Real SquareMagnitude () const override
 returns 1.0 More...
 
Standard_Real Crossed (const Handle< Geom2d_Vector > &Other) const override
 Computes the cross product between <me> and <Other>. More...
 
Standard_Real operator^ (const Handle< Geom2d_Vector > &Other) const
 
void Transform (const gp_Trsf2d &T) override
 Applies the transformation T to this unit vector, then normalizes it. More...
 
Handle< Geom2d_GeometryCopy () const override
 Creates a new object which is a copy of this unit 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

The class Direction specifies a vector that is never null. It is a unit vector.

Constructor & Destructor Documentation

◆ Geom2d_Direction() [1/2]

Geom2d_Direction::Geom2d_Direction ( const Standard_Real  X,
const Standard_Real  Y 
)

Creates a unit vector with it 2 cartesian coordinates.

Raised if Sqrt( X*X + Y*Y) <= Resolution from gp.

◆ Geom2d_Direction() [2/2]

Geom2d_Direction::Geom2d_Direction ( const gp_Dir2d V)

Creates a persistent copy of <me>.

Member Function Documentation

◆ Copy()

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

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

Implements Geom2d_Geometry.

◆ Crossed()

Standard_Real Geom2d_Direction::Crossed ( const Handle< Geom2d_Vector > &  Other) const
overridevirtual

Computes the cross product between <me> and <Other>.

Implements Geom2d_Vector.

◆ Dir2d()

gp_Dir2d Geom2d_Direction::Dir2d ( ) const

Converts this unit vector into a gp_Dir2d unit vector.

◆ Magnitude()

Standard_Real Geom2d_Direction::Magnitude ( ) const
overridevirtual

returns 1.0

Implements Geom2d_Vector.

◆ operator^()

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

◆ SetCoord()

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

Assigns the coordinates X and Y to this unit vector, then normalizes it. Exceptions Standard_ConstructionError if Sqrt(X*X + Y*Y) is less than or equal to gp::Resolution().

◆ SetDir2d()

void Geom2d_Direction::SetDir2d ( const gp_Dir2d V)

Converts the gp_Dir2d unit vector V into this unit vector.

◆ SetX()

void Geom2d_Direction::SetX ( const Standard_Real  X)

Assigns a value to the X coordinate of this unit vector, then normalizes it. Exceptions Standard_ConstructionError if the value assigned causes the magnitude of the vector to become less than or equal to gp::Resolution().

◆ SetY()

void Geom2d_Direction::SetY ( const Standard_Real  Y)

Assigns a value to the Y coordinate of this unit vector, then normalizes it. Exceptions Standard_ConstructionError if the value assigned causes the magnitude of the vector to become less than or equal to gp::Resolution().

◆ SquareMagnitude()

Standard_Real Geom2d_Direction::SquareMagnitude ( ) const
overridevirtual

returns 1.0

Implements Geom2d_Vector.

◆ Transform()

void Geom2d_Direction::Transform ( const gp_Trsf2d T)
overridevirtual

Applies the transformation T to this unit vector, then normalizes it.

Implements Geom2d_Geometry.


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