2D Curve. More...
Public Member Functions | |
Constructors | |
| Curve2D | new () |
| Create 2d curve. More... | |
Management | |
| int | getPointCount () |
| Nnumber of points. More... | |
| Vector2 | getPointAt (int position) |
| Point at positon. More... | |
| int | indexOfPointClosestTo (float coordinate) |
| Index of the point closest to an x coordinate. More... | |
| int | indexOfPointBefore (float coordinate) |
| Index of the point with matching x coordinates or point right before. More... | |
| int | addPoint (Vector2 point) |
| Add point returning index where it has been added. More... | |
| int | addPoint (float x, float y) |
| Add point returning index where it has been added. More... | |
| void | removePointFrom (int position) |
| Remove point from position. More... | |
| void | removeAllPoints () |
| Remove all points. More... | |
| void | setDefaultCurve () |
| Clear curve to a straight line from (0,0) to (1,1). More... | |
| void | offsetPointsBy (float offset) |
| Offset Y coordinate of all curve points. More... | |
| void | scalePointsBy (float scale) |
| Scale Y coordinate of all curve points. More... | |
| float | evaluateConstant (float coordinate) |
| Evaluate curve at coordinate using constant interpolation. More... | |
| float | evaluateLinear (float coordinate) |
| Evaluate curve at coordinate using linear interpolation. More... | |
Detailed Description
2D Curve.
This is a native class.
Member Function Documentation
◆ addPoint() [1/2]
| int Dragengine.Scenery.Curve2D.addPoint | ( | float | x, |
| float | y | ||
| ) |
Add point returning index where it has been added.
◆ addPoint() [2/2]
| int Dragengine.Scenery.Curve2D.addPoint | ( | Vector2 | point | ) |
Add point returning index where it has been added.
◆ evaluateConstant()
| float Dragengine.Scenery.Curve2D.evaluateConstant | ( | float | coordinate | ) |
Evaluate curve at coordinate using constant interpolation.
◆ evaluateLinear()
| float Dragengine.Scenery.Curve2D.evaluateLinear | ( | float | coordinate | ) |
Evaluate curve at coordinate using linear interpolation.
◆ getPointAt()
| Vector2 Dragengine.Scenery.Curve2D.getPointAt | ( | int | position | ) |
Point at positon.
- Exceptions
-
EOutOfBoundary position is less than 0 or larger than or equal to getPointCount().
◆ getPointCount()
| int Dragengine.Scenery.Curve2D.getPointCount | ( | ) |
Nnumber of points.
◆ indexOfPointBefore()
| int Dragengine.Scenery.Curve2D.indexOfPointBefore | ( | float | coordinate | ) |
Index of the point with matching x coordinates or point right before.
This method can be used to find the interval a point is located in by returning the most prior point. Returns -1 if there are no points satisfying this criteria.
◆ indexOfPointClosestTo()
| int Dragengine.Scenery.Curve2D.indexOfPointClosestTo | ( | float | coordinate | ) |
Index of the point closest to an x coordinate.
If no such point can be found -1 is returned.
◆ new()
| Curve2D Dragengine.Scenery.Curve2D.new | ( | ) |
Create 2d curve.
◆ offsetPointsBy()
| void Dragengine.Scenery.Curve2D.offsetPointsBy | ( | float | offset | ) |
Offset Y coordinate of all curve points.
◆ removeAllPoints()
| void Dragengine.Scenery.Curve2D.removeAllPoints | ( | ) |
Remove all points.
◆ removePointFrom()
| void Dragengine.Scenery.Curve2D.removePointFrom | ( | int | position | ) |
Remove point from position.
- Exceptions
-
EOutOfBoundary position is less than 0 or larger than or equal to getPointCount().
◆ scalePointsBy()
| void Dragengine.Scenery.Curve2D.scalePointsBy | ( | float | scale | ) |
Scale Y coordinate of all curve points.
◆ setDefaultCurve()
| void Dragengine.Scenery.Curve2D.setDefaultCurve | ( | ) |
Clear curve to a straight line from (0,0) to (1,1).
The documentation for this class was generated from the following file:
