 |
|
|
|
The knots in a spline. More...
#include <knotMap.h>
Public Types | |
| using | KnotVec = std::vector< TsKnot > |
| using | iterator = KnotVec::iterator |
| using | const_iterator = KnotVec::const_iterator |
| using | reverse_iterator = KnotVec::reverse_iterator |
| using | const_reverse_iterator = KnotVec::const_reverse_iterator |
Public Member Functions | |
Construction and value semantics | |
| TS_API | TsKnotMap () |
| TS_API | TsKnotMap (std::initializer_list< TsKnot > knots) |
| TS_API bool | operator== (const TsKnotMap &other) const |
| TS_API bool | operator!= (const TsKnotMap &other) const |
Iteration | |
These methods are | |
| TS_API iterator | begin () |
| TS_API const_iterator | begin () const |
| TS_API const_iterator | cbegin () const |
| TS_API iterator | end () |
| TS_API const_iterator | end () const |
| TS_API const_iterator | cend () const |
| TS_API reverse_iterator | rbegin () |
| TS_API const_reverse_iterator | rbegin () const |
| TS_API const_reverse_iterator | crbegin () const |
| TS_API reverse_iterator | rend () |
| TS_API const_reverse_iterator | rend () const |
| TS_API const_reverse_iterator | crend () const |
Size | |
These methods are | |
| TS_API size_t | size () const |
| TS_API bool | empty () const |
| TS_API void | reserve (size_t size) |
Modification | |
These methods are | |
| TS_API void | clear () |
| TS_API void | swap (TsKnotMap &other) |
| TS_API std::pair< iterator, bool > | insert (const TsKnot &knot) |
| Inserts a knot. | |
| TS_API size_t | erase (TsTime time) |
| Removes the knot at the specified time, if it exists. | |
| TS_API iterator | erase (iterator i) |
| Removes a knot. Returns the iterator after it. | |
| TS_API iterator | erase (iterator first, iterator last) |
| Removes a range of knots. Returns the iterator after the last removed. | |
Searching | |
These methods are | |
| TS_API iterator | find (TsTime time) |
| Exact matches only; returns end() if not found. | |
| TS_API const_iterator | find (TsTime time) const |
| Const version of find(). | |
| TS_API iterator | lower_bound (TsTime time) |
| If there is a knot at the specified time, returns that. | |
| TS_API const_iterator | lower_bound (TsTime time) const |
| Const version of lower_bound(). | |
Non-STL Methods | |
| TS_API iterator | FindClosest (TsTime time) |
| Returns the knot whose time most closely (or exactly) matches the specified time. | |
| TS_API const_iterator | FindClosest (TsTime time) const |
| Const version of FindClosest(). | |
| TS_API TfType | GetValueType () const |
| Returns the value type of the knots, or Unknown if empty. | |
| TS_API GfInterval | GetTimeSpan () const |
| Returns the time interval containing the first and last knot. | |
| TS_API bool | HasCurveSegments () const |
| Returns whether there are any segments with curve interpolation. | |
Friends | |
| class | TsSpline |
The knots in a spline.
Stored as a vector, but unique and sorted like a map. A knot's time is stored within the knot itself, but is also sometimes used as a key. Some methods are vector-like, some are map-like, and some are set-like.
Separate from TsSpline in order to provide identical operations on different collections of knots. The most straightforward collection is the authored knots, provided by GetKnots, but collections included baked loop knots can also be obtained.
| using const_reverse_iterator = KnotVec::const_reverse_iterator |
| TS_API iterator erase | ( | iterator | first, |
| iterator | last | ||
| ) |
Removes a range of knots. Returns the iterator after the last removed.
| TS_API iterator erase | ( | iterator | i | ) |
Removes a knot. Returns the iterator after it.
| TS_API size_t erase | ( | TsTime | time | ) |
Removes the knot at the specified time, if it exists.
Returns the number of knots erased (0 or 1).
| TS_API iterator find | ( | TsTime | time | ) |
Exact matches only; returns end() if not found.
| TS_API const_iterator find | ( | TsTime | time | ) | const |
Const version of find().
| TS_API iterator FindClosest | ( | TsTime | time | ) |
Returns the knot whose time most closely (or exactly) matches the specified time.
In case of ties, returns the later knot. If there are no knots, returns end().
| TS_API const_iterator FindClosest | ( | TsTime | time | ) | const |
Const version of FindClosest().
| TS_API GfInterval GetTimeSpan | ( | ) | const |
Returns the time interval containing the first and last knot.
Returns an empty interval if there are no knots.
| TS_API TfType GetValueType | ( | ) | const |
Returns the value type of the knots, or Unknown if empty.
| TS_API bool HasCurveSegments | ( | ) | const |
Returns whether there are any segments with curve interpolation.
| TS_API std::pair< iterator, bool > insert | ( | const TsKnot & | knot | ) |
Inserts a knot.
If there is already a knot at the same time, nothing is changed. Returns an iterator to the newly inserted knot, or the existing one at the same time. The second member of the returned pair indicates whether an insertion took place.
| TS_API iterator lower_bound | ( | TsTime | time | ) |
If there is a knot at the specified time, returns that.
Otherwise, if there is a knot after the specified time, returns the first such knot. Otherwise returns end().
| TS_API const_iterator lower_bound | ( | TsTime | time | ) | const |
Const version of lower_bound().
1.9.6