This defines a range of values to test, from start to <=end, going up by step.
More...
|
Number | start = 0 |
| Represents the start of the range. More...
|
|
Number | end = 0 |
| Represents the inclusive end of the range. More...
|
|
Number | step = 1 |
| Represents the step to move by each tick. More...
|
|
Number | here = 0 |
| Represents the current value the range is at. More...
|
|
bool | running = false |
| Determines if we are running or not (i.e. is here valid) More...
|
|
function< void(void)> | reset_chain_parent |
| This will be called when we want to reset_chain what we are chained onto. More...
|
|
function< bool(void)> | tick_chain_parent |
| This will be called when we need to tick_chain our parent. More...
|
|
template<typename Number>
struct vg::Range< Number >
This defines a range of values to test, from start to <=end, going up by step.
◆ type
template<typename Number >
◆ Range() [1/4]
template<typename Number >
◆ Range() [2/4]
template<typename Number >
Construct from a single value.
◆ Range() [3/4]
template<typename Number >
Copy, preserving destination links.
◆ Range() [4/4]
template<typename Number >
Move, preserving destination links.
◆ chain()
template<typename Number >
template<typename Other >
Chain the given range onto this one. Return the passed-in range. Neither range may be moved away!
◆ get_iterator()
template<typename Number >
function<void(const function<void(void)>&)> vg::Range< Number >::get_iterator |
( |
| ) |
|
|
inline |
Get a function that runs another function for each combination of values for this Range and all Ranges it has been chained onto.
◆ is_valid()
template<typename Number >
Check the range for usefulness.
◆ operator Number()
template<typename Number >
vg::Range< Number >::operator Number |
( |
| ) |
const |
|
inline |
Convert to Number with the current value.
◆ operator=() [1/2]
template<typename Number >
Copy assignment, preserving destination links.
◆ operator=() [2/2]
template<typename Number >
Move assignment, preserving destination links.
◆ reset()
template<typename Number >
Start at our start value.
◆ reset_chain()
template<typename Number >
Start us and all the things we are chained onto at their start values.
◆ tick()
template<typename Number >
Increment our value. Returns true if the new value needs processing, and false if we have left or would leave the range.
◆ tick_chain()
template<typename Number >
Increment our value. If it overflows, tock_chain whatever we are chained onto, and reset and succeed if that succeeds.
◆ end
template<typename Number >
Represents the inclusive end of the range.
◆ here
template<typename Number >
Represents the current value the range is at.
◆ reset_chain_parent
template<typename Number >
function<void(void)> vg::Range< Number >::reset_chain_parent |
Initial value:
This will be called when we want to reset_chain what we are chained onto.
◆ running
template<typename Number >
Determines if we are running or not (i.e. is here valid)
◆ start
template<typename Number >
Represents the start of the range.
◆ step
template<typename Number >
Represents the step to move by each tick.
◆ tick_chain_parent
template<typename Number >
function<bool(void)> vg::Range< Number >::tick_chain_parent |
Initial value:
This will be called when we need to tick_chain our parent.
The documentation for this struct was generated from the following file: