Smooth floating point value. More...
Public Member Functions | |
Constructors | |
| SmoothFloat | new () |
| Create smooth float. | |
| SmoothFloat | new (SmoothFloat copy) |
| Create copy of smooth float. | |
Management | |
| float | getValue () |
| Current value. | |
| void | setValue (float value) |
| Set current value. | |
| float | getGoal () |
| Goal value. | |
| void | setGoal (float goal) |
| Set goal value. | |
| float | getAdjustTime () |
| Adjustment time in seconds. | |
| void | setAdjustTime (float adjustTime) |
| Adjustment time in seconds clamped to 0 or larger. | |
| float | getAdjustRange () |
| Adjustment range in units. | |
| void | setAdjustRange (float limit) |
| Set adjustment range in units clamped to 0 or larger. | |
| float | getChangeSpeed () |
| Change speed of the value in units per second. | |
| void | setChangeSpeed (float changeSpeed) |
| Set change speed of the value in units per second. | |
| void | reset () |
| Reset value, goal and change speed to 0. | |
| void | update (float elapsed) |
| Update value with goal using current smoothing parameters. | |
File Handling | |
| void | writeToFile (FileWriter writer) |
| Write to file writer. | |
| static SmoothFloat | readFromFile (FileReader reader) |
| Read from file reader. | |
Detailed Description
Smooth floating point value.
Smooth dynamic changing floating point value across time.
Member Function Documentation
◆ getAdjustRange()
| float Dragengine.Scenery.SmoothFloat.getAdjustRange | ( | ) |
Adjustment range in units.
◆ getAdjustTime()
| float Dragengine.Scenery.SmoothFloat.getAdjustTime | ( | ) |
Adjustment time in seconds.
◆ getChangeSpeed()
| float Dragengine.Scenery.SmoothFloat.getChangeSpeed | ( | ) |
Change speed of the value in units per second.
◆ getGoal()
| float Dragengine.Scenery.SmoothFloat.getGoal | ( | ) |
Goal value.
◆ getValue()
| float Dragengine.Scenery.SmoothFloat.getValue | ( | ) |
Current value.
◆ new() [1/2]
| SmoothFloat Dragengine.Scenery.SmoothFloat.new | ( | ) |
Create smooth float.
Value, goal and change speed are set to 0. Adjust time is set to 1s. Change speed limit is set to 1 unit per second.
◆ new() [2/2]
| SmoothFloat Dragengine.Scenery.SmoothFloat.new | ( | SmoothFloat | copy | ) |
Create copy of smooth float.
◆ readFromFile()
|
static |
Read from file reader.
◆ reset()
| void Dragengine.Scenery.SmoothFloat.reset | ( | ) |
Reset value, goal and change speed to 0.
◆ setAdjustRange()
| void Dragengine.Scenery.SmoothFloat.setAdjustRange | ( | float | limit | ) |
Set adjustment range in units clamped to 0 or larger.
◆ setAdjustTime()
| void Dragengine.Scenery.SmoothFloat.setAdjustTime | ( | float | adjustTime | ) |
Adjustment time in seconds clamped to 0 or larger.
◆ setChangeSpeed()
| void Dragengine.Scenery.SmoothFloat.setChangeSpeed | ( | float | changeSpeed | ) |
Set change speed of the value in units per second.
◆ setGoal()
| void Dragengine.Scenery.SmoothFloat.setGoal | ( | float | goal | ) |
Set goal value.
◆ setValue()
| void Dragengine.Scenery.SmoothFloat.setValue | ( | float | value | ) |
Set current value.
◆ update()
| void Dragengine.Scenery.SmoothFloat.update | ( | float | elapsed | ) |
Update value with goal using current smoothing parameters.
Goal is not modified.
- Parameters
-
[in] elapsed Elapsed time in seconds. If less than 0.001s update is skipped.
◆ writeToFile()
| void Dragengine.Scenery.SmoothFloat.writeToFile | ( | FileWriter | writer | ) |
Write to file writer.
The documentation for this class was generated from the following file:
