OCC Main Page | ModelingData | Toolkits | Packages | Class Hierarchy | Data Structures | File List | Data Fields | Globals

ModelingData
TKG3d
Geom


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

#include <Geom_Vector.hxx>

Inheritance diagram for Geom_Vector:

Inheritance graph
[legend]

Public Member Functions

Standard_EXPORT void Reverse ()
 Reverses the vector <me>.
.
Standard_EXPORT Handle_Geom_Vector Reversed () const
 Returns a copy of <me> reversed.
.
Standard_EXPORT 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:
- 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().
.
Standard_EXPORT 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().
.
Standard_EXPORT void Coord (Standard_Real &X, Standard_Real &Y, Standard_Real &Z) const
 Returns the coordinates X, Y and Z of this vector.
.
virtual Standard_EXPORT Standard_Real Magnitude () const =0
 Returns the Magnitude of <me>.
.
virtual Standard_EXPORT Standard_Real SquareMagnitude () const =0
 Returns the square magnitude of <me>.
.
Standard_EXPORT Standard_Real X () const
 Returns the X coordinate of <me>.
.
Standard_EXPORT Standard_Real Y () const
 Returns the Y coordinate of <me>.
.
Standard_EXPORT Standard_Real Z () const
 Returns the Z coordinate of <me>.
.
virtual Standard_EXPORT void Cross (const Handle(Geom_Vector)&Other)=0
 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.
.
virtual Standard_EXPORT Handle_Geom_Vector Crossed (const Handle(Geom_Vector)&Other) const =0
 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.
.
virtual Standard_EXPORT void CrossCross (const Handle(Geom_Vector)&V1, const Handle(Geom_Vector)&V2)=0
 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
.
virtual Standard_EXPORT Handle_Geom_Vector CrossCrossed (const Handle(Geom_Vector)&V1, const Handle(Geom_Vector)&V2) const =0
 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
.
Standard_EXPORT Standard_Real Dot (const Handle(Geom_Vector)&Other) const
 Computes the scalar product of this vector and vector Other.
.
Standard_EXPORT Standard_Real DotCross (const Handle(Geom_Vector)&V1, const Handle(Geom_Vector)&V2) const
 Computes the triple scalar product. Returns me . (V1 ^ V2)
.
Standard_EXPORT const gp_Vec & Vec () const
 Converts this vector into a gp_Vec vector.
.
Standard_EXPORT const Handle (Standard_Type)&DynamicType() const

Protected Attributes

gp_Vec gpVec

Member Function Documentation

Standard_EXPORT Standard_Real Geom_Vector::Angle const Handle(Geom_Vector)&  Other  )  const
 

Standard_EXPORT Standard_Real Geom_Vector::AngleWithRef const Handle(Geom_Vector)&  Other,
const Handle(Geom_Vector)&  VRef
const
 

Standard_EXPORT void Geom_Vector::Coord Standard_Real &  X,
Standard_Real &  Y,
Standard_Real &  Z
const
 

virtual Standard_EXPORT void Geom_Vector::Cross const Handle(Geom_Vector)&  Other  )  [pure virtual]
 

Implemented in Geom_Direction, and Geom_VectorWithMagnitude.

virtual Standard_EXPORT void Geom_Vector::CrossCross const Handle(Geom_Vector)&  V1,
const Handle(Geom_Vector)&  V2
[pure virtual]
 

Implemented in Geom_Direction, and Geom_VectorWithMagnitude.

virtual Standard_EXPORT Handle_Geom_Vector Geom_Vector::CrossCrossed const Handle(Geom_Vector)&  V1,
const Handle(Geom_Vector)&  V2
const [pure virtual]
 

Implemented in Geom_Direction, and Geom_VectorWithMagnitude.

virtual Standard_EXPORT Handle_Geom_Vector Geom_Vector::Crossed const Handle(Geom_Vector)&  Other  )  const [pure virtual]
 

Implemented in Geom_Direction, and Geom_VectorWithMagnitude.

Standard_EXPORT Standard_Real Geom_Vector::Dot const Handle(Geom_Vector)&  Other  )  const
 

Standard_EXPORT Standard_Real Geom_Vector::DotCross const Handle(Geom_Vector)&  V1,
const Handle(Geom_Vector)&  V2
const
 

Standard_EXPORT const Geom_Vector::Handle Standard_Type   )  const
 

Reimplemented from Geom_Geometry.

Reimplemented in Geom_Direction, and Geom_VectorWithMagnitude.

virtual Standard_EXPORT Standard_Real Geom_Vector::Magnitude  )  const [pure virtual]
 

Implemented in Geom_Direction, and Geom_VectorWithMagnitude.

Standard_EXPORT void Geom_Vector::Reverse  ) 
 

Standard_EXPORT Handle_Geom_Vector Geom_Vector::Reversed  )  const
 

virtual Standard_EXPORT Standard_Real Geom_Vector::SquareMagnitude  )  const [pure virtual]
 

Implemented in Geom_Direction, and Geom_VectorWithMagnitude.

Standard_EXPORT const gp_Vec& Geom_Vector::Vec  )  const
 

Standard_EXPORT Standard_Real Geom_Vector::X  )  const
 

Standard_EXPORT Standard_Real Geom_Vector::Y  )  const
 

Standard_EXPORT Standard_Real Geom_Vector::Z  )  const
 


Field Documentation

gp_Vec Geom_Vector::gpVec [protected]
 


The documentation for this class was generated from the following file:
Generated on Mon Aug 25 13:22:59 2008 for OpenCASCADE by  doxygen 1.4.1