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

ModelingData
TKG2d
Geom2d


Geom2d_Line Class Reference

Describes an infinite line in the plane (2D space).
A line is defined and positioned in the plane with an
axis (gp_Ax2d object) which gives it an origin and a unit vector.
The Geom2d_Line line is parameterized as follows:
P (U) = O + U*Dir
where:
- P is the point of parameter U,
- O is the origin and Dir the unit vector of its positioning axis.
The parameter range is ] -infinite, +infinite [.
The orientation of the line is given by the unit vector
of its positioning axis.
See Also
GCE2d_MakeLine which provides functions for more
complex line constructions
gp_Ax2d
gp_Lin2d for an equivalent, non-parameterized data structure.
.

#include <Geom2d_Line.hxx>

Inheritance diagram for Geom2d_Line:

Inheritance graph
[legend]

Public Member Functions

Standard_EXPORT Geom2d_Line (const gp_Ax2d &A)
 Creates a line located in 2D space with the axis placement A.
The Location of A is the origin of the line.
.
Standard_EXPORT Geom2d_Line (const gp_Lin2d &L)
 Creates a line by conversion of the gp_Lin2d line L.
.
Standard_EXPORT Geom2d_Line (const gp_Pnt2d &P, const gp_Dir2d &V)
 Constructs a line passing through point P and parallel to
vector V (P and V are, respectively, the origin
and the unit vector of the positioning axis of the line).
.
Standard_EXPORT void SetLin2d (const gp_Lin2d &L)
 Set <me> so that <me> has the same geometric properties as L.
.
Standard_EXPORT void SetDirection (const gp_Dir2d &V)
 changes the direction of the line.

Standard_EXPORT const gp_Dir2d & Direction () const
 changes the direction of the line.

Standard_EXPORT void SetLocation (const gp_Pnt2d &P)
 Changes the "Location" point (origin) of the line.
.
Standard_EXPORT const gp_Pnt2d & Location () const
 Changes the "Location" point (origin) of the line.
.
Standard_EXPORT void SetPosition (const gp_Ax2d &A)
 Changes the "Location" and a the "Direction" of <me>.
.
Standard_EXPORT const gp_Ax2d & Position () const
Standard_EXPORT gp_Lin2d Lin2d () const
 Returns non persistent line from gp with the same geometric
properties as <me>
.
Standard_EXPORT void Reverse ()
 Changes the orientation of this line. As a result, the
unit vector of the positioning axis of this line is reversed.
.
Standard_EXPORT Standard_Real ReversedParameter (const Standard_Real U) const
 Computes the parameter on the reversed line for the
point of parameter U on this line.
For a line, the returned value is -U.
.
Standard_EXPORT Standard_Real FirstParameter () const
 Returns RealFirst from Standard.
.
Standard_EXPORT Standard_Real LastParameter () const
 Returns RealLast from Standard
.
Standard_EXPORT Standard_Boolean IsClosed () const
 Returns False
.
Standard_EXPORT Standard_Boolean IsPeriodic () const
 Returns False
.
Standard_EXPORT GeomAbs_Shape Continuity () const
 Returns GeomAbs_CN, which is the global continuity of any line.
.
Standard_EXPORT Standard_Real Distance (const gp_Pnt2d &P) const
 Computes the distance between <me> and the point P.
.
Standard_EXPORT Standard_Boolean IsCN (const Standard_Integer N) const
 Returns True.
.
Standard_EXPORT void D0 (const Standard_Real U, gp_Pnt2d &P) const
 Returns in P the point of parameter U.
P (U) = O + U * Dir where O is the "Location" point of the
line and Dir the direction of the line.
.
Standard_EXPORT void D1 (const Standard_Real U, gp_Pnt2d &P, gp_Vec2d &V1) const
 Returns the point P of parameter u and the first derivative V1.
.
Standard_EXPORT void D2 (const Standard_Real U, gp_Pnt2d &P, gp_Vec2d &V1, gp_Vec2d &V2) const
 Returns the point P of parameter U, the first and second
derivatives V1 and V2. V2 is a vector with null magnitude
for a line.
.
Standard_EXPORT void D3 (const Standard_Real U, gp_Pnt2d &P, gp_Vec2d &V1, gp_Vec2d &V2, gp_Vec2d &V3) const
 V2 and V3 are vectors with null magnitude for a line.
.
Standard_EXPORT gp_Vec2d DN (const Standard_Real U, const Standard_Integer N) const
 For the point of parameter U of this line, computes
the vector corresponding to the Nth derivative.
Note: if N is greater than or equal to 2, the result is a
vector with null magnitude.
Exceptions Standard_RangeError if N is less than 1.
.
Standard_EXPORT void Transform (const gp_Trsf2d &T)
 Applies the transformation T to this line.
.
virtual Standard_EXPORT Standard_Real TransformedParameter (const Standard_Real U, const gp_Trsf2d &T) const
 Computes the parameter on the line transformed by
T for the point of parameter U on this line.
For a line, the returned value is equal to U multiplied
by the scale factor of transformation T.
.
virtual Standard_EXPORT Standard_Real ParametricTransformation (const gp_Trsf2d &T) const
 Returns the coefficient required to compute the
parametric transformation of this line when
transformation T is applied. This coefficient is the
ratio between the parameter of a point on this line
and the parameter of the transformed point on the
new line transformed by T.
For a line, the returned value is the scale factor of the transformation T.
.
Standard_EXPORT Handle_Geom2d_Geometry Copy () const
 Creates a new object, which is a copy of this line.
.
Standard_EXPORT const Handle (Standard_Type)&DynamicType() const

Private Attributes

gp_Ax2d pos

Constructor & Destructor Documentation

Standard_EXPORT Geom2d_Line::Geom2d_Line const gp_Ax2d &  A  ) 
 

Standard_EXPORT Geom2d_Line::Geom2d_Line const gp_Lin2d &  L  ) 
 

Standard_EXPORT Geom2d_Line::Geom2d_Line const gp_Pnt2d &  P,
const gp_Dir2d &  V
 


Member Function Documentation

Standard_EXPORT GeomAbs_Shape Geom2d_Line::Continuity  )  const [virtual]
 

Implements Geom2d_Curve.

Standard_EXPORT Handle_Geom2d_Geometry Geom2d_Line::Copy  )  const [virtual]
 

Implements Geom2d_Geometry.

Standard_EXPORT void Geom2d_Line::D0 const Standard_Real  U,
gp_Pnt2d &  P
const [virtual]
 

Implements Geom2d_Curve.

Standard_EXPORT void Geom2d_Line::D1 const Standard_Real  U,
gp_Pnt2d &  P,
gp_Vec2d &  V1
const [virtual]
 

Implements Geom2d_Curve.

Standard_EXPORT void Geom2d_Line::D2 const Standard_Real  U,
gp_Pnt2d &  P,
gp_Vec2d &  V1,
gp_Vec2d &  V2
const [virtual]
 

Implements Geom2d_Curve.

Standard_EXPORT void Geom2d_Line::D3 const Standard_Real  U,
gp_Pnt2d &  P,
gp_Vec2d &  V1,
gp_Vec2d &  V2,
gp_Vec2d &  V3
const [virtual]
 

Implements Geom2d_Curve.

Standard_EXPORT const gp_Dir2d& Geom2d_Line::Direction  )  const
 

Standard_EXPORT Standard_Real Geom2d_Line::Distance const gp_Pnt2d &  P  )  const
 

Standard_EXPORT gp_Vec2d Geom2d_Line::DN const Standard_Real  U,
const Standard_Integer  N
const [virtual]
 

Implements Geom2d_Curve.

Standard_EXPORT Standard_Real Geom2d_Line::FirstParameter  )  const [virtual]
 

Implements Geom2d_Curve.

Standard_EXPORT const Geom2d_Line::Handle Standard_Type   )  const
 

Reimplemented from Geom2d_Curve.

Standard_EXPORT Standard_Boolean Geom2d_Line::IsClosed  )  const [virtual]
 

Implements Geom2d_Curve.

Standard_EXPORT Standard_Boolean Geom2d_Line::IsCN const Standard_Integer  N  )  const [virtual]
 

Implements Geom2d_Curve.

Standard_EXPORT Standard_Boolean Geom2d_Line::IsPeriodic  )  const [virtual]
 

Implements Geom2d_Curve.

Standard_EXPORT Standard_Real Geom2d_Line::LastParameter  )  const [virtual]
 

Implements Geom2d_Curve.

Standard_EXPORT gp_Lin2d Geom2d_Line::Lin2d  )  const
 

Standard_EXPORT const gp_Pnt2d& Geom2d_Line::Location  )  const
 

virtual Standard_EXPORT Standard_Real Geom2d_Line::ParametricTransformation const gp_Trsf2d &  T  )  const [virtual]
 

Reimplemented from Geom2d_Curve.

Standard_EXPORT const gp_Ax2d& Geom2d_Line::Position  )  const
 

Standard_EXPORT void Geom2d_Line::Reverse  )  [virtual]
 

Implements Geom2d_Curve.

Standard_EXPORT Standard_Real Geom2d_Line::ReversedParameter const Standard_Real  U  )  const [virtual]
 

Implements Geom2d_Curve.

Standard_EXPORT void Geom2d_Line::SetDirection const gp_Dir2d &  V  ) 
 

Standard_EXPORT void Geom2d_Line::SetLin2d const gp_Lin2d &  L  ) 
 

Standard_EXPORT void Geom2d_Line::SetLocation const gp_Pnt2d &  P  ) 
 

Standard_EXPORT void Geom2d_Line::SetPosition const gp_Ax2d &  A  ) 
 

Standard_EXPORT void Geom2d_Line::Transform const gp_Trsf2d &  T  )  [virtual]
 

Implements Geom2d_Geometry.

virtual Standard_EXPORT Standard_Real Geom2d_Line::TransformedParameter const Standard_Real  U,
const gp_Trsf2d &  T
const [virtual]
 

Reimplemented from Geom2d_Curve.


Field Documentation

gp_Ax2d Geom2d_Line::pos [private]
 


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