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 double X, const double Y, const double Z)
	Creates a unit vector with it 3 cartesian coordinates.

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

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

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

void	SetX (const double X)
	Changes the X coordinate of <me>.

void	SetY (const double Y)
	Changes the Y coordinate of <me>.

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

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

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

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

void	Cross (const occ::handle< Geom_Vector > &Other) override
	Computes the cross product between <me> and <Other>.

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

occ::handle< Geom_Vector >	Crossed (const occ::handle< Geom_Vector > &Other) const override
	Computes the cross product between <me> and <Other>. A new direction is returned.

occ::handle< Geom_Vector >	CrossCrossed (const occ::handle< Geom_Vector > &V1, const occ::handle< Geom_Vector > &V2) const override
	Computes the triple vector product <me> ^(V1 ^ V2).

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

occ::handle< Geom_Geometry >	Copy () const override
	Creates a new object which is a copy of this unit vector.

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

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

double	Angle (const occ::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:

double	AngleWithRef (const occ::handle< Geom_Vector > &Other, const occ::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().

void	Coord (double &X, double &Y, double &Z) const
	Returns the coordinates X, Y and Z of this vector.

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

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

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

double	Dot (const occ::handle< Geom_Vector > &Other) const
	Computes the scalar product of this vector and vector Other.

double	DotCross (const occ::handle< Geom_Vector > &V1, const occ::handle< Geom_Vector > &V2) const
	Computes the triple scalar product. Returns me . (V1 ^ V2)

const gp_Vec &	Vec () const
	Converts this vector into a gp_Vec vector.

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.

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.

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

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

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

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

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

occ::handle< Geom_Geometry >	Mirrored (const gp_Pnt &P) const

occ::handle< Geom_Geometry >	Mirrored (const gp_Ax1 &A1) const

occ::handle< Geom_Geometry >	Mirrored (const gp_Ax2 &A2) const

occ::handle< Geom_Geometry >	Rotated (const gp_Ax1 &A1, const double Ang) const

occ::handle< Geom_Geometry >	Scaled (const gp_Pnt &P, const double S) const

occ::handle< Geom_Geometry >	Transformed (const gp_Trsf &T) const

occ::handle< Geom_Geometry >	Translated (const gp_Vec &V) const

occ::handle< Geom_Geometry >	Translated (const gp_Pnt &P1, const gp_Pnt &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
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.

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.

Constructor & Destructor Documentation

◆ Geom_Direction() [1/2]

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

Creates a unit vector with it 3 cartesian coordinates.

Raised if std::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>.

Member Function Documentation

◆ Copy()

occ::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 occ::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 occ::handle< Geom_Vector > &	V1,
		const occ::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()

occ::handle< Geom_Vector > Geom_Direction::CrossCrossed	(	const occ::handle< Geom_Vector > &	V1,
		const occ::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()

occ::handle< Geom_Vector > Geom_Direction::Crossed ( const occ::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()

double 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 double	X,
		const double	Y,
		const double	Z )

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

Raised if std::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 double X )

Changes the X coordinate of <me>.

Raised if std::sqrt( X*X + Y*Y + Z*Z) <= Resolution from gp.

◆ SetY()

void Geom_Direction::SetY ( const double Y )

Changes the Y coordinate of <me>.

Raised if std::sqrt( X*X + Y*Y + Z*Z) <= Resolution from gp.

◆ SetZ()

void Geom_Direction::SetZ ( const double Z )

Changes the Z coordinate of <me>.

Raised if std::sqrt( X*X + Y*Y + Z*Z) <= Resolution from gp.

◆ SquareMagnitude()

double 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:

Geom_Direction.hxx

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Geom_Direction() [1/2]

◆ Geom_Direction() [2/2]

Member Function Documentation

◆ Copy()

◆ Cross()

◆ CrossCross()

◆ CrossCrossed()

◆ Crossed()

◆ Dir()

◆ Magnitude()

◆ SetCoord()

◆ SetDir()

◆ SetX()

◆ SetY()

◆ SetZ()

◆ SquareMagnitude()

◆ Transform()