Geom_Direction Class Reference

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

`#include <Geom_Direction.hxx>`

Inheritance diagram for Geom_Direction: [legend]

## Public Member Functions

Geom_Direction (const Standard_Real X, const Standard_Real Y, const Standard_Real Z)
Creates a unit vector with it 3 cartesian coordinates. More...

Geom_Direction (const gp_Dir &V)
Creates a transient copy of <me>. More...

void SetCoord (const Standard_Real X, const Standard_Real Y, const Standard_Real Z)
Sets <me> to X,Y,Z coordinates. More...

void SetDir (const gp_Dir &V)
Converts the gp_Dir unit vector V into this unit vector. More...

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

void SetZ (const Standard_Real Z)
Changes the Z coordinate of <me>. More...

gp_Dir Dir () const
Returns the non transient direction with the same coordinates as <me>. More...

Standard_Real Magnitude () const override
returns 1.0 which is the magnitude of any unit vector. More...

Standard_Real SquareMagnitude () const override
returns 1.0 which is the square magnitude of any unit vector. More...

void Cross (const Handle< Geom_Vector > &Other) override
Computes the cross product between <me> and <Other>. More...

void CrossCross (const Handle< Geom_Vector > &V1, const Handle< Geom_Vector > &V2) override
Computes the triple vector product <me> ^(V1 ^ V2). More...

Handle< Geom_VectorCrossed (const Handle< Geom_Vector > &Other) const override
Computes the cross product between <me> and <Other>. A new direction is returned. More...

Handle< Geom_VectorCrossCrossed (const Handle< Geom_Vector > &V1, const Handle< Geom_Vector > &V2) const override
Computes the triple vector product <me> ^(V1 ^ V2). More...

void Transform (const gp_Trsf &T) override
Applies the transformation T to this unit vector, then normalizes it. More...

Handle< Geom_GeometryCopy () const override
Creates a new object which is a copy of this unit vector. More... Public Member Functions inherited from Geom_Vector
void Reverse ()
Reverses the vector <me>. More...

Handle< Geom_VectorReversed () const
Returns a copy of <me> reversed. More...

Standard_Real Angle (const Handle< Geom_Vector > &Other) const
Computes the angular value, in radians, between this vector and vector Other. The result is a value between 0 and Pi. Exceptions gp_VectorWithNullMagnitude if: More...

Standard_Real AngleWithRef (const Handle< Geom_Vector > &Other, const Handle< Geom_Vector > &VRef) const
Computes the angular value, in radians, between this vector and vector Other. The result is a value between -Pi and Pi. The vector VRef defines the positive sense of rotation: the angular value is positive if the cross product this ^ Other has the same orientation as VRef (in relation to the plane defined by this vector and vector Other). Otherwise, it is negative. Exceptions Standard_DomainError if this vector, vector Other and vector VRef are coplanar, except if this vector and vector Other are parallel. gp_VectorWithNullMagnitude if the magnitude of this vector, vector Other or vector VRef is less than or equal to gp::Resolution(). More...

void Coord (Standard_Real &X, Standard_Real &Y, Standard_Real &Z) const
Returns the coordinates X, Y and Z of this vector. 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 Z () const
Returns the Z coordinate of <me>. More...

Standard_Real Dot (const Handle< Geom_Vector > &Other) const
Computes the scalar product of this vector and vector Other. More...

Standard_Real DotCross (const Handle< Geom_Vector > &V1, const Handle< Geom_Vector > &V2) const
Computes the triple scalar product. Returns me . (V1 ^ V2) More...

const gp_VecVec () const
Converts this vector into a gp_Vec vector. More... Public Member Functions inherited from Geom_Geometry
void Mirror (const gp_Pnt &P)
Performs the symmetrical transformation of a Geometry with respect to the point P which is the center of the symmetry. More...

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

void Mirror (const gp_Ax2 &A2)
Performs the symmetrical transformation of a Geometry with respect to a plane. The axis placement A2 locates the plane of the symmetry : (Location, XDirection, YDirection). More...

void Rotate (const gp_Ax1 &A1, const Standard_Real Ang)
Rotates a Geometry. A1 is the axis of the rotation. Ang is the angular value of the rotation in radians. More...

void Scale (const gp_Pnt &P, const Standard_Real S)
Scales a Geometry. S is the scaling value. More...

void Translate (const gp_Vec &V)
Translates a Geometry. V is the vector of the tanslation. More...

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

Handle< Geom_GeometryMirrored (const gp_Pnt &P) const

Handle< Geom_GeometryMirrored (const gp_Ax1 &A1) const

Handle< Geom_GeometryMirrored (const gp_Ax2 &A2) const

Handle< Geom_GeometryRotated (const gp_Ax1 &A1, const Standard_Real Ang) const

Handle< Geom_GeometryScaled (const gp_Pnt &P, const Standard_Real S) const

Handle< Geom_GeometryTransformed (const gp_Trsf &T) const

Handle< Geom_GeometryTranslated (const gp_Vec &V) const

Handle< Geom_GeometryTranslated (const gp_Pnt &P1, const gp_Pnt &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

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... Public Types inherited from Standard_Transient
typedef void base_type Static Public Member Functions inherited from Standard_Transient
static const char * get_type_name ()

static const opencascade::handle< Standard_Type > & get_type_descriptor ()
Returns type descriptor of Standard_Transient class. More... Protected Attributes inherited from Geom_Vector
gp_Vec gpVec

## Detailed Description

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

## ◆ Geom_Direction() [1/2]

 Geom_Direction::Geom_Direction ( const Standard_Real X, const Standard_Real Y, const Standard_Real Z )

Creates a unit vector with it 3 cartesian coordinates.

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

## ◆ Geom_Direction() [2/2]

 Geom_Direction::Geom_Direction ( const gp_Dir & V )

Creates a transient copy of <me>.

## ◆ Copy()

 Handle< Geom_Geometry > Geom_Direction::Copy ( ) const
overridevirtual

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

Implements Geom_Geometry.

## ◆ Cross()

 void Geom_Direction::Cross ( const Handle< Geom_Vector > & Other )
overridevirtual

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

Raised if the two vectors are parallel because it is not possible to have a direction with null length.

Implements Geom_Vector.

## ◆ CrossCross()

 void Geom_Direction::CrossCross ( const Handle< Geom_Vector > & V1, const Handle< Geom_Vector > & V2 )
overridevirtual

Computes the triple vector product <me> ^(V1 ^ V2).

Raised if V1 and V2 are parallel or <me> and (V1 ^ V2) are parallel

Implements Geom_Vector.

## ◆ CrossCrossed()

 Handle< Geom_Vector > Geom_Direction::CrossCrossed ( const Handle< Geom_Vector > & V1, const Handle< Geom_Vector > & V2 ) const
overridevirtual

Computes the triple vector product <me> ^(V1 ^ V2).

Raised if V1 and V2 are parallel or <me> and (V1 ^ V2) are parallel

Implements Geom_Vector.

## ◆ Crossed()

 Handle< Geom_Vector > Geom_Direction::Crossed ( const Handle< Geom_Vector > & Other ) const
overridevirtual

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

Raised if the two vectors are parallel because it is not possible to have a direction with null length.

Implements Geom_Vector.

## ◆ Dir()

 gp_Dir Geom_Direction::Dir ( ) const

Returns the non transient direction with the same coordinates as <me>.

## ◆ Magnitude()

 Standard_Real Geom_Direction::Magnitude ( ) const
overridevirtual

returns 1.0 which is the magnitude of any unit vector.

Implements Geom_Vector.

## ◆ SetCoord()

 void Geom_Direction::SetCoord ( const Standard_Real X, const Standard_Real Y, const Standard_Real Z )

Sets <me> to X,Y,Z coordinates.

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

## ◆ SetDir()

 void Geom_Direction::SetDir ( const gp_Dir & V )

Converts the gp_Dir unit vector V into this unit vector.

## ◆ SetX()

 void Geom_Direction::SetX ( const Standard_Real X )

Changes the X coordinate of <me>.

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

## ◆ SetY()

 void Geom_Direction::SetY ( const Standard_Real Y )

Changes the Y coordinate of <me>.

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

## ◆ SetZ()

 void Geom_Direction::SetZ ( const Standard_Real Z )

Changes the Z coordinate of <me>.

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

## ◆ SquareMagnitude()

 Standard_Real Geom_Direction::SquareMagnitude ( ) const
overridevirtual

returns 1.0 which is the square magnitude of any unit vector.

Implements Geom_Vector.

## ◆ Transform()

 void Geom_Direction::Transform ( const gp_Trsf & T )
overridevirtual

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

Implements Geom_Geometry.

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