Packagecom.degrafa.utilities.math
Classpublic class CatmullRom
ImplementsIPlottableSpline
SubclassesCardSpline, CatmullRomUtility



Public Properties
 PropertyDefined by
  closed : Boolean
[write-only]
CatmullRom
  knots : Array
[read-only]
CatmullRom
  tangent : String
[write-only]
CatmullRom
  type : String
[read-only]
CatmullRom
Protected Properties
 PropertyDefined by
  __coef : Array
CatmullRom
  __index : Number
CatmullRom
  __invalidate : Boolean
CatmullRom
  __isClosed : Boolean
CatmullRom
  __knots : Number
CatmullRom
  __localParam : Number
CatmullRom
  __prevIndex : Number
CatmullRom
  __s : Number
CatmullRom
  __t : Number
CatmullRom
  __tangent : String
CatmullRom
  __theKnots : Array
CatmullRom
  __x : Array
CatmullRom
  __xHold : Number
CatmullRom
  __y : Array
CatmullRom
  __yHold : Number
CatmullRom
Public Methods
 MethodDefined by
  
CatmullRom() - Construct a new Catmull-Rom spline
CatmullRom
  
addControlPoint(_xCoord:Number, _yCoord:Number):void
addControlPoint - Add a control point
CatmullRom
  
derivative(_x:Number):Number
CatmullRom
  
eval(_x:Number):Number
CatmullRom
  
getCoef(_segment:uint):Object
CatmullRom
  
getControlPoint(_i:uint):Object
CatmullRom
  
getX(_t:Number):Number
getX - Return x-coordinate for a given t
CatmullRom
  
getXPrime(_t:Number):Number
getXPrime - Return dx/dt for a given t
CatmullRom
  
getY(_t:Number):Number
getY - Return y-coordinate for a given t
CatmullRom
  
getYPrime(_t:Number):Number
getYPrime - Return dy/dt for a given t
CatmullRom
  
reset():void
reset - Remove all control points and initialize spline for new control point entry
CatmullRom
  
setOuterPoint(_flag:String, _xCoord:Number, _yCoord:Number):void
setOuterPoint - Add control point outside the knot range
CatmullRom
  
tAtKnot(_k:Number):Number
tAtKnot - Return t-value at a particular knot index
CatmullRom
Protected Methods
 MethodDefined by
  
CatmullRom
  
CatmullRom
  
CatmullRom
  
CatmullRom
  
__segment():void
CatmullRom
  
__setParam(_t:Number):void
CatmullRom
Public Constants
 ConstantDefined by
  ARC_LENGTH : String = "arclength"
[static]
CatmullRom
  AUTO : String = "auto"
[static]
CatmullRom
  EXPLICIT : String = "explicit"
[static]
CatmullRom
  FIRST : String = "first"
[static]
CatmullRom
  LAST : String = "last"
[static]
CatmullRom
  UNIFORM : String = "uniform"
[static]
CatmullRom
Property detail
closedproperty
closed:Boolean  [write-only]Implementation
    public function set closed(value:Boolean):void
__coefproperty 
protected var __coef:Array
__indexproperty 
protected var __index:Number
__invalidateproperty 
protected var __invalidate:Boolean
__isClosedproperty 
protected var __isClosed:Boolean
__knotsproperty 
protected var __knots:Number
knotsproperty 
knots:Array  [read-only]Implementation
    public function get knots():Array
__localParamproperty 
protected var __localParam:Number
__prevIndexproperty 
protected var __prevIndex:Number
__sproperty 
protected var __s:Number
__tproperty 
protected var __t:Number
__tangentproperty 
protected var __tangent:String
tangentproperty 
tangent:String  [write-only]Implementation
    public function set tangent(value:String):void
__theKnotsproperty 
protected var __theKnots:Array
typeproperty 
type:String  [read-only]Implementation
    public function get type():String
__xproperty 
protected var __x:Array
__xHoldproperty 
protected var __xHold:Number
__yproperty 
protected var __y:Array
__yHoldproperty 
protected var __yHold:Number
Constructor detail
CatmullRom()constructor
public function CatmullRom()

CatmullRom() - Construct a new Catmull-Rom spline

Method detail
__closedSplineEndpoints()method
protected function __closedSplineEndpoints():void
__computeCoef()method 
protected function __computeCoef():void
__computeEndpoints()method 
protected function __computeEndpoints():void
__parameterize()method 
protected function __parameterize():void
__segment()method 
protected function __segment():void
__setParam()method 
protected function __setParam(_t:Number):voidParameters
_t:Number
addControlPoint()method 
public function addControlPoint(_xCoord:Number, _yCoord:Number):void

addControlPoint - Add a control point

Parameters
_xCoord:Number — - control point, x-coordinate
 
_yCoord:Number — - control point, y-coordinate
derivative()method 
public function derivative(_x:Number):NumberParameters
_x:Number

Returns
Number
eval()method 
public function eval(_x:Number):NumberParameters
_x:Number

Returns
Number
getCoef()method 
public function getCoef(_segment:uint):ObjectParameters
_segment:uint

Returns
Object
getControlPoint()method 
public function getControlPoint(_i:uint):ObjectParameters
_i:uint

Returns
Object
getX()method 
public function getX(_t:Number):Number

getX - Return x-coordinate for a given t

Parameters
_t:Number — - parameter value in [0,1]

Returns
Number — Number Value of Catmull-Rom spline, provided input is in [0,1], C(0) or C(1). If knot count is below 2, return 0.
getXPrime()method 
public function getXPrime(_t:Number):Number

getXPrime - Return dx/dt for a given t

Parameters
_t:Number — - parameter value in [0,1]

Returns
Number — Number: Value of dx/dt, provided input is in [0,1].
getY()method 
public function getY(_t:Number):Number

getY - Return y-coordinate for a given t

Parameters
_t:Number — - parameter value in [0,1]

Returns
Number — Number: Value of Catmull-Rom spline, provided input is in [0,1], C(0) or C(1).
getYPrime()method 
public function getYPrime(_t:Number):Number

getYPrime - Return dy/dt for a given t

Parameters
_t:Number — - parameter value in [0,1]

Returns
Number — Number Value of dy/dt, provided input is in [0,1].
reset()method 
public function reset():void

reset - Remove all control points and initialize spline for new control point entry

setOuterPoint()method 
public function setOuterPoint(_flag:String, _xCoord:Number, _yCoord:Number):void

setOuterPoint - Add control point outside the knot range

Parameters
_flag:String — - indicate which extreme to place point - FIRST (modify first control point) or LAST (last control point)
 
_xCoord:Number — - control point, x-coordinate
 
_yCoord:Number — - control point, y-coordinate
tAtKnot()method 
public function tAtKnot(_k:Number):Number

tAtKnot - Return t-value at a particular knot index

Parameters
_k:Number — - Knot index, starting at zero

Returns
Number — Number: t-value corresponding to knot at index _k, provided k is in-range. Returns -1 otherwise. Currently works only for uniform parameterization.
Constant detail
ARC_LENGTHconstant
public static const ARC_LENGTH:String = "arclength"
AUTOconstant 
public static const AUTO:String = "auto"
EXPLICITconstant 
public static const EXPLICIT:String = "explicit"
FIRSTconstant 
public static const FIRST:String = "first"
LASTconstant 
public static const LAST:String = "last"
UNIFORMconstant 
public static const UNIFORM:String = "uniform"