#include <customgui_splinecontrol.h>
|
Bool | GetRange (Float *xmin, Float *xmax, Float *xsteps, Float *ymin, Float *ymax, Float *ysteps) const |
|
void | SetRange (Float xmin, Float xmax, Float xsteps, Float ymin, Float ymax, Float ysteps) |
|
void | AdaptRange (Float xmin, Float xmax, Float xsteps, Float ymin, Float ymax, Float ysteps) |
|
Spline data type (CUSTOMDATATYPE_SPLINE).
- Note
- Has to be created with Alloc() and destroyed with Free().
◆ SplineData()
◆ ~SplineData()
◆ Alloc()
Allocates a spline data. Destroy the allocated spline data with Free().
- Returns
- The allocated spline data, or nullptr if the allocation failed.
◆ Free()
Destructs spline data allocated with Alloc().
- Parameters
-
[in,out] | pData | The spline data to destruct. If the pointer is nullptr nothing happens. The pointer is assigned nullptr afterwards. |
◆ GetKnotCount()
Int32 GetKnotCount |
( |
| ) |
const |
Gets the number of knots.
- Returns
- The knot count.
◆ GetKnot()
Gets the spline knot at position l.
- Parameters
-
- Returns
- The spline knot.
◆ SetKnot()
Sets the spline knot at position l.
- Parameters
-
- Returns
- true if the spline knot was successfully set, otherwise false.
◆ InsertKnot()
Inserts a knot.
- Parameters
-
[in] | x | The X coordinate. |
[in] | y | The Y coordinate. |
[in] | lFlagsSettings | The knot flags: FLAG_KNOT. |
- Returns
- The index of the inserted knot.
◆ DeleteKnot()
Deletes a knot.
- Parameters
-
- Returns
- true if successful, otherwise false.
◆ SortKnots()
void SortKnots |
( |
Int32 & |
lActiveKnot | ) |
|
Sorts the knots.
- Parameters
-
[out] | lActiveKnot | Assigned the new index of the active knot. |
◆ GetSelectCount()
Int32 GetSelectCount |
( |
| ) |
const |
Gets the number of selected knots.
- Returns
- The selected knot count.
◆ DeleteAllPoints()
◆ MakePointBuffer()
Makes an uninitialized spline with lPoints points.
- Parameters
-
[in] | lPoints | The number of points, or -1 to get the default value. |
- Returns
- true if successful, otherwise false.
◆ MakeLinearSplineLinear()
Bool MakeLinearSplineLinear |
( |
Int32 |
lPoints = -1 | ) |
|
Makes a linear spline with lPoints points. The spline knots' is linear.
- Parameters
-
[in] | lPoints | The number of points, or -1 to get the default value. |
- Returns
- true if successful, otherwise false.
◆ MakeLinearSplineBezier()
Bool MakeLinearSplineBezier |
( |
Int32 |
lPoints = -1 | ) |
|
Makes a linear spline with lPoints points. The spline knots' interpolation is Bezier.
- Parameters
-
[in] | lPoints | The number of points, or -1 to get the default value. |
- Returns
- true if successful, otherwise false.
◆ MakeSquareSpline()
Makes a square spline with lPoints points.
- Parameters
-
[in] | lPoints | The number of points, or -1 to get the default value. |
- Returns
- true if successful, otherwise false.
◆ MakeCubicSpline()
Makes a cubic spline with lPoints points.
- Parameters
-
[in] | lPoints | The number of points, or -1 to get the default value. |
- Returns
- true if successful, otherwise false.
◆ MakeRootSpline()
Makes a root spline with lPoints points.
- Parameters
-
[in] | lPoints | The number of points, or -1 to get the default value. |
- Returns
- true if successful, otherwise false.
◆ MakeInversSpline()
Makes an inverse spline with lPoints points.
- Parameters
-
[in] | lPoints | The number of points, or -1 to get the default value. |
- Returns
- true if successful, otherwise false.
◆ MakeSinSpline()
Makes a sinus spline with lPoints points.
- Parameters
-
[in] | lPoints | The number of points, or -1 to get the default value. |
- Returns
- true if successful, otherwise false.
◆ MakeAbsCosSpline()
Makes an absolute cosinus spline with lPoints points.
- Parameters
-
[in] | lPoints | The number of points, or -1 to get the default value. |
- Returns
- true if successful, otherwise false.
◆ SelectAll()
◆ Flip()
◆ Mirror()
◆ Maximum()
Makes all Y coordinates less than or equal to 1.
◆ Minimum()
Makes all Y coordinates greater than or equal to 0.
◆ SetType()
Sets the interpolation type of the selected knots.
- Parameters
-
- Returns
- true if successful, otherwise false.
◆ SetZero()
Sets the tangents of the selected knots to zero.
- Parameters
-
[in] | bY | true to set the tangents' Y coordinate to zero, false to set the X coordinate. |
[in] | bAll | true to set all tangents, false to set the tangents of selected knots only. |
- Returns
- true if successful, otherwise false.
◆ GetRange()
Gets the range of the spline.
- Parameters
-
[out] | xmin | The minimum X value. |
[out] | xmax | The maximum X value. |
[out] | xsteps | The X steps value. |
[out] | ymin | The minimum Y value. |
[out] | ymax | The maximum Y value. |
[out] | ysteps | The Y steps value. |
- Returns
- true if the range of the spline data was successfully retrieved, otherwise false.
◆ SetRange()
Sets the range of the spline.
- Parameters
-
[in] | xmin | The minimum X value. |
[in] | xmax | The maximum X value. |
[in] | xsteps | The X steps value. |
[in] | ymin | The minimum Y value. |
[in] | ymax | The maximum Y value. |
[in] | ysteps | The Y steps value. |
◆ AdaptRange()
Adapts the internal [0, 1] range of the old spline GUI to the range set by [xmin, xmax, ymin, ymax].
- Parameters
-
[in] | xmin | The minimum X value. |
[in] | xmax | The maximum X value. |
[in] | xsteps | The X steps value. |
[in] | ymin | The minimum Y value. |
[in] | ymax | The maximum Y value. |
[in] | ysteps | The Y steps value. |
◆ CopyTo()
Copies the SplineData values into the destination spline data pDest.
- Parameters
-
[in] | pDest | The destination spline data. The caller owns the pointed spline data. |
- Returns
- true if the spline data was successfully copied to pDest, otherwise false.