Public Member Functions | List of all members
splineEdge Class Reference

A curvedEdge interface for Catmull-Rom splines. More...

Inheritance diagram for splineEdge:
Inheritance graph
[legend]
Collaboration diagram for splineEdge:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("spline")
 Runtime type information. More...
 
 splineEdge (const pointField &, const label start, const label end, const pointField &internalPoints)
 Construct from components. More...
 
 splineEdge (const pointField &, Istream &)
 Construct from Istream, setting pointsList. More...
 
virtual ~splineEdge ()
 Destructor. More...
 
virtual point position (const scalar) const
 Return the point position corresponding to the curve parameter. More...
 
virtual scalar length () const
 Return the length of the spline curve (not implemented) More...
 
- Public Member Functions inherited from curvedEdge
 TypeName ("curvedEdge")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, curvedEdge, Istream,(const pointField &points, Istream &is),(points, is))
 
 curvedEdge (const pointField &points, const label start, const label end)
 Construct from components. More...
 
 curvedEdge (const pointField &, Istream &)
 Construct from Istream setting pointsList. More...
 
 curvedEdge (const curvedEdge &)
 Copy construct. More...
 
virtual autoPtr< curvedEdgeclone () const
 Clone function. More...
 
virtual ~curvedEdge ()
 Destructor. More...
 
label start () const
 Return label of start point. More...
 
label end () const
 Return label of end point. More...
 
int compare (const curvedEdge &) const
 Compare the given start and end points with this curve. More...
 
int compare (const edge &) const
 Compare the given start and end points with this curve. More...
 
int compare (const label start, const label end) const
 Compare the given start and end points with this curve. More...
 
void operator= (const curvedEdge &)
 
- Public Member Functions inherited from CatmullRomSpline
 CatmullRomSpline (const pointField &knots, const bool notImplementedClosed=false)
 Construct from components. More...
 
point position (const scalar lambda) const
 Return the point position corresponding to the curve parameter. More...
 
point position (const label segment, const scalar lambda) const
 Return the point position corresponding to the local parameter. More...
 
scalar length () const
 Return the length of the curve. More...
 
- Public Member Functions inherited from polyLine
 polyLine (const pointField &, const bool notImplementedClosed=false)
 Construct from components. More...
 
const pointFieldpoints () const
 Return const-access to the control-points. More...
 
label nSegments () const
 Return the number of line segments. More...
 
point position (const scalar) const
 Return the point position corresponding to the curve parameter. More...
 
point position (const label segment, const scalar) const
 Return the point position corresponding to the local parameter. More...
 
scalar length () const
 Return the length of the curve. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from curvedEdge
static autoPtr< curvedEdgeNew (const pointField &, Istream &)
 New function which constructs and returns pointer to a curvedEdge. More...
 
- Protected Member Functions inherited from polyLine
void calcParam ()
 Precalculate the rational cumulative parameter value. More...
 
label localParameter (scalar &lambda) const
 Return the line segment and the local parameter [0..1]. More...
 
- Static Protected Member Functions inherited from curvedEdge
static pointField appendEndPoints (const pointField &, const label start, const label end, const pointField &otherKnots)
 Return a complete point field by appending the start/end points. More...
 
- Protected Attributes inherited from curvedEdge
const pointFieldpoints_
 
const label start_
 
const label end_
 
- Protected Attributes inherited from polyLine
pointField points_
 The control points or ends of each segments. More...
 
scalar lineLength_
 The real line length. More...
 
scalarList param_
 The rational (0-1) cumulative parameter value for each point. More...
 

Detailed Description

A curvedEdge interface for Catmull-Rom splines.

Source files

Definition at line 49 of file splineEdge.H.

Constructor & Destructor Documentation

splineEdge ( const pointField points,
const label  start,
const label  end,
const pointField internalPoints 
)

Construct from components.

Definition at line 48 of file splineEdge.C.

splineEdge ( const pointField points,
Istream is 
)

Construct from Istream, setting pointsList.

Definition at line 60 of file splineEdge.C.

References token::BEGIN_LIST, and Istream::putBack().

Here is the call graph for this function:

~splineEdge ( )
virtual

Destructor.

Definition at line 79 of file splineEdge.C.

Member Function Documentation

TypeName ( "spline"  )

Runtime type information.

Foam::point position ( const scalar  mu) const
virtual

Return the point position corresponding to the curve parameter.

0 <= lambda <= 1

Implements curvedEdge.

Definition at line 85 of file splineEdge.C.

References CatmullRomSpline::position().

Here is the call graph for this function:

Foam::scalar length ( ) const
virtual

Return the length of the spline curve (not implemented)

Implements curvedEdge.

Definition at line 91 of file splineEdge.C.

References CatmullRomSpline::length().

Here is the call graph for this function:


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