CatmullRom class.
Macros:
Maximum dimension for a CapyCatmullRom
Enumerations:
None.
Typedefs:
Iteration windows for CapyCatmullRomIterator
Struct CapyCatmullRom :
Struct CapyCatmullRom's properties:
Inherits CapyMathFun
Alpha parameter defining the type of spline (default: 0.5, in [0,1], 0: uniform, 0.5: centripetal, 1: chordal)
Control points.
Knots value (automatically updated when setting the control points)
Struct CapyCatmullRom's methods:
Destructor
Get a control point.
Input argument(s):
id: the index of the control point, in [0,3]
Output and side effect(s):
Return the control point
Set the values of a control point
Input argument(s):
id: the index of the control point
vals: the value to set, array of 'that->dimOut' double
Output and side effect(s):
The control point values and the knot values are updated.
Struct CapyCatmullRomPosition :
Struct CapyCatmullRomPosition's properties:
Struct CapyCatmullRomPosition's methods:
None.
Struct CapyCatmullRomIterator :
Struct CapyCatmullRomIterator's properties:
Index of the current step in the iteration
Returned data type
List of windows
CatmullRom associated to the iteration
Epsilon for the step of iteration using euclidean distance along the CatmullRom curve (default: 0.1)
Memory pool for the windows
Struct CapyCatmullRomIterator's methods:
Destructor
Reset the iterator
Output and side effect(s):
Return the first position of the iteration
Move the iterator to the next position
Output and side effect(s):
Return the next position of the iteration
Check if the iterator is on a valid position
Output and side effect(s):
Return true if the iterator is on a valid position, else false
Get the current position of the iteration
Output and side effect(s):
Return the current position
Functions:
Create a CapyCatmullRom
Input argument(s):
dim: dimension of the control points
Output and side effect(s):
Return a CapyCatmullRom
Allocate memory for a new CapyCatmullRom and create it
Input argument(s):
dim: dimension of the control points
Output and side effect(s):
Return a CapyCatmullRom
Exception(s):
May raise CapyExc_MallocFailed.
Free the memory used by a CapyCatmullRom* and reset '*that' to NULL
Input argument(s):
that: a pointer to the CapyCatmullRom to free
Create an iterator on a CapyCatmullRom
Input argument(s):
bezier: the bezier on which to iterate
Output and side effect(s):
Return the iterator
Allocate memory and create an iterator on a CapyCatmullRom
Input argument(s):
bezier: the bezier on which to iterate
Output and side effect(s):
Return the iterator
Free the memory used by a pointer to an iterator and reset '*that' to NULL
Input argument(s):
that: a pointer to the iterator to free