Geom_Vector Class Reference

The abstract class Vector describes the common behavior of vectors in 3D space. The Geom package provides two concrete classes of vectors: Geom_Direction (unit vector) and Geom_VectorWithMagnitude. More...

#include <Geom_Vector.hxx>

Inheritance diagram for Geom_Vector:

Public Member Functions
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.
virtual double	Magnitude () const =0
	Returns the Magnitude of <me>.
virtual double	SquareMagnitude () const =0
	Returns the square magnitude of <me>.
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>.
virtual void	Cross (const occ::handle< Geom_Vector > &Other)=0
	Computes the cross product between <me> and <Other>.
virtual occ::handle< Geom_Vector >	Crossed (const occ::handle< Geom_Vector > &Other) const =0
	Computes the cross product between <me> and <Other>. A new direction is returned.
virtual void	CrossCross (const occ::handle< Geom_Vector > &V1, const occ::handle< Geom_Vector > &V2)=0
	Computes the triple vector product <me> ^(V1 ^ V2).
virtual occ::handle< Geom_Vector >	CrossCrossed (const occ::handle< Geom_Vector > &V1, const occ::handle< Geom_Vector > &V2) const =0
	Computes the triple vector product <me> ^(V1 ^ V2).
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.
virtual void	Transform (const gp_Trsf &T)=0
	Transformation of a geometric object. This transformation can be a translation, a rotation, a symmetry, a scaling or a complex transformation obtained by combination of the previous elementaries transformations. (see class Transformation of the package Geom).
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 occ::handle< Geom_Geometry >	Copy () const =0
	Creates a new object which is a copy of this geometric object.
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.

Protected Attributes
gp_Vec	gpVec

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.

Detailed Description

The abstract class Vector describes the common behavior of vectors in 3D space. The Geom package provides two concrete classes of vectors: Geom_Direction (unit vector) and Geom_VectorWithMagnitude.

Member Function Documentation

Angle()

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

• the magnitude of this vector is less than or equal to gp::Resolution(), or
• the magnitude of vector Other is less than or equal to gp::Resolution().

AngleWithRef()

double Geom_Vector::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().

Coord()

void Geom_Vector::Coord	(	double &	X,
		double &	Y,
		double &	Z ) const

Returns the coordinates X, Y and Z of this vector.

Cross()

virtual void Geom_Vector::Cross ( const occ::handle< Geom_Vector > & Other )

pure virtual

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

Raised if <me> is a "Direction" and if <me> and <Other> are parallel because it is not possible to build a "Direction" with null length.

Implemented in Geom_Direction, and Geom_VectorWithMagnitude.

CrossCross()

virtual void Geom_Vector::CrossCross ( const occ::handle< Geom_Vector > & V1, const occ::handle< Geom_Vector > & V2 )

pure virtual

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

Raised if <me> is a "Direction" and if V1 and V2 are parallel or <me> and (V1 ^ V2) are parallel

Implemented in Geom_Direction, and Geom_VectorWithMagnitude.

CrossCrossed()

virtual occ::handle< Geom_Vector > Geom_Vector::CrossCrossed ( const occ::handle< Geom_Vector > & V1, const occ::handle< Geom_Vector > & V2 ) const

pure virtual

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

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

Implemented in Geom_Direction, and Geom_VectorWithMagnitude.

Crossed()

virtual occ::handle< Geom_Vector > Geom_Vector::Crossed ( const occ::handle< Geom_Vector > & Other ) const

pure virtual

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

Raised if <me> is a "Direction" and if the two vectors are parallel because it is not possible to create a "Direction" with null length.

Implemented in Geom_Direction, and Geom_VectorWithMagnitude.

Dot()

double Geom_Vector::Dot

(

const occ::handle< Geom_Vector > &

Other

)

const

Computes the scalar product of this vector and vector Other.

DotCross()

double Geom_Vector::DotCross	(	const occ::handle< Geom_Vector > &	V1,
		const occ::handle< Geom_Vector > &	V2 ) const

Computes the triple scalar product. Returns me . (V1 ^ V2).

Magnitude()

virtual double Geom_Vector::Magnitude ( ) const

pure virtual

Returns the Magnitude of <me>.

Implemented in Geom_Direction, and Geom_VectorWithMagnitude.

Reverse()

void Geom_Vector::Reverse

(

)

Reverses the vector <me>.

Reversed()

occ::handle< Geom_Vector > Geom_Vector::Reversed ( ) const

nodiscard

Returns a copy of <me> reversed.

SquareMagnitude()

virtual double Geom_Vector::SquareMagnitude ( ) const

pure virtual

Returns the square magnitude of <me>.

Implemented in Geom_Direction, and Geom_VectorWithMagnitude.

Vec()

const gp_Vec & Geom_Vector::Vec

(

)

const

Converts this vector into a gp_Vec vector.

X()

double Geom_Vector::X

(

)

const

Returns the X coordinate of <me>.

Y()

double Geom_Vector::Y

(

)

const

Returns the Y coordinate of <me>.

Z()

double Geom_Vector::Z

(

)

const

Returns the Z coordinate of <me>.

Field Documentation

gpVec

gp_Vec Geom_Vector::gpVec

protected

---

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

• Geom_Vector.hxx