TeeChartPHP
[ class tree: TeeChartPHP ] [ index: TeeChartPHP ] [ all elements ]

Class: Spline

Source Location: /functions/Spline.php

Class Overview


<p>Title: Spline class</p>


Variables

Methods



Class Details

[line 16]
<p>Title: Spline class</p>

Description: Spline smoothing.

Copyright (c) 2005-2008 by Steema Software SL. All Rights Reserved.

Company: Steema Software SL




[ Top ]


Class Variables

static $MINLIMIT =  1e-5

[line 195]


Type:   mixed


[ Top ]



Class Methods


constructor Spline [line 32]

Spline Spline( )

Spline smoothing.



Tags:

access:  public


[ Top ]

method addPoint [line 335]

void addPoint( x $x, y $y)

Adds a new source point with specified X and Y values.



Tags:

access:  public


Parameters:

x   $x   double
y   $y   double

[ Top ]

method clear [line 351]

void clear( )

Removes all source points.



Tags:

access:  public


[ Top ]

method getBuild [line 40]

boolean getBuild( )

Indicates the spline has already calculated smooth points.
Set to false to force the spline to rebuild smooth points.




Tags:

access:  public


[ Top ]

method getFragments [line 95]

int getFragments( )

The number of resulting smooth points.
Must be a multiple of source points.



Tags:

access:  public


[ Top ]

method getInterpolated [line 120]

boolean getInterpolated( )

When true, the spline calculates interpolated points that will pass

exactly over source points.
When false, the spline resulting points do not necessarily pass over source points.
Default value: false




Tags:

access:  public


[ Top ]

method getPoint [line 140]

void getPoint( $index)



Tags:

access:  public


Parameters:

   $index  

[ Top ]

method numberOfVertices [line 188]

int numberOfVertices( )

Returns the number of total source points.
For each point that is a control point ( Knuckle[ Index ] is true ), the number of vertices is incremented by 2.




Tags:

access:  public


[ Top ]

method rebuild [line 239]

void rebuild( )

Calculates new smoothed points from list of points.



Tags:

access:  public


[ Top ]

method setBuild [line 50]

void setBuild( value $value)

Indicates the spline has already calculated smooth points.
Set to false to force the spline to rebuild smooth points.




Tags:

access:  public


Parameters:

value   $value   boolean

[ Top ]

method setFragments [line 105]

void setFragments( value $value)

Sets the number of resulting smooth points.
Must be a multiple of source points.



Tags:

access:  public


Parameters:

value   $value   int

[ Top ]

method setInterpolated [line 133]

void setInterpolated( value $value)

When true, the spline calculates interpolated points that will pass

exactly over source points.
When false, the spline resulting points do not necessarily pass over source points.
Default value: false




Tags:

access:  public


Parameters:

value   $value   boolean

[ Top ]

method setKnuckle [line 176]

void setKnuckle( index $index, value $value)

Makes the Index source point a control point.

By default, TSmoothingFunction does not set any source point
as a control point.



Tags:

access:  public


Parameters:

index   $index   int
value   $value   boolean

[ Top ]

method setPoint [line 149]

void setPoint( index $index, value $value)

Use to set the source point for the Knuckle





Tags:

access:  public


Parameters:

index   $index   int
value   $value   Double

[ Top ]

method value [line 385]

Double value( parameter $parameter)

Returns an interpolated point.



Tags:

access:  public


Parameters:

parameter   $parameter   double

[ Top ]


Documentation generated on Wed, 16 Jun 2010 12:08:22 +0200 by phpDocumentor 1.4.1