TsKeyFrameMap Class Reference

An ordered sequence of keyframes with STL-compliant API for finding, inserting, and erasing keyframes while maintaining order. More...

#include <keyFrameMap.h>

Public Types
typedef std::vector< TsKeyFrame >::iterator	iterator
typedef std::vector< TsKeyFrame >::const_iterator	const_iterator
typedef std::vector< TsKeyFrame >::reverse_iterator	reverse_iterator
typedef std::vector< TsKeyFrame >::const_reverse_iterator	const_reverse_iterator

Public Member Functions
TS_API	TsKeyFrameMap (TsKeyFrameMap const &other)
TS_API TsKeyFrameMap &	operator= (TsKeyFrameMap const &other)
TS_API iterator	begin ()
TS_API const_iterator	begin () const
TS_API iterator	end ()
TS_API const_iterator	end () const
TS_API reverse_iterator	rbegin ()
TS_API const_reverse_iterator	rbegin () const
TS_API reverse_iterator	rend ()
TS_API const_reverse_iterator	rend () const
TS_API size_t	size () const
TS_API size_t	max_size () const
TS_API bool	empty () const
TS_API void	reserve (size_t size)
TS_API void	clear ()
TS_API void	swap (TsKeyFrameMap &other)
TS_API void	swap (std::vector< TsKeyFrame > &other)
TS_API void	erase (iterator first, iterator last)
TS_API void	erase (iterator i)
TS_API bool	operator== (const TsKeyFrameMap &other) const
TS_API bool	operator!= (const TsKeyFrameMap &other) const
TS_API iterator	lower_bound (TsTime t)
TS_API const_iterator	lower_bound (TsTime t) const
TS_API iterator	upper_bound (TsTime t)
TS_API const_iterator	upper_bound (TsTime t) const
TS_API iterator	find (const TsTime &t)
TS_API const_iterator	find (const TsTime &t) const
TS_API iterator	insert (TsKeyFrame const &value)
template<class Iter >
void	insert (Iter const &first, Iter const &last)
TS_API void	erase (TsTime const &t)
TS_API TsKeyFrame &	operator[] (const TsTime &t)

Detailed Description

An ordered sequence of keyframes with STL-compliant API for finding, inserting, and erasing keyframes while maintaining order.

We use this instead of a map or set of keyframes because it allows the keyframes to be stored with fewer heap allocation and better data locality.

For the sake of efficiency, this class makes two assumptions: The keyframes are always ordered There is never more than one key frame at a given time.

The client (TsSpline) is responsible for maintaining these preconditions.

Definition at line 33 of file keyFrameMap.h.

Member Typedef Documentation

const_iterator

typedef std::vector<TsKeyFrame>::const_iterator const_iterator

Definition at line 37 of file keyFrameMap.h.

const_reverse_iterator

typedef std::vector<TsKeyFrame>::const_reverse_iterator const_reverse_iterator

Definition at line 39 of file keyFrameMap.h.

iterator

typedef std::vector<TsKeyFrame>::iterator iterator

Definition at line 36 of file keyFrameMap.h.

reverse_iterator

typedef std::vector<TsKeyFrame>::reverse_iterator reverse_iterator

Definition at line 38 of file keyFrameMap.h.

Constructor & Destructor Documentation

TsKeyFrameMap() [1/2]

TS_API TsKeyFrameMap ( )

inline

Definition at line 42 of file keyFrameMap.h.

TsKeyFrameMap() [2/2]

TS_API TsKeyFrameMap ( TsKeyFrameMap const &  other )

inline

Definition at line 46 of file keyFrameMap.h.

Member Function Documentation

begin() [1/2]

TS_API iterator begin ( )

inline

Definition at line 57 of file keyFrameMap.h.

begin() [2/2]

TS_API const_iterator begin ( ) const

inline

Definition at line 62 of file keyFrameMap.h.

clear()

TS_API void clear ( )

inline

Definition at line 117 of file keyFrameMap.h.

empty()

TS_API bool empty ( ) const

inline

Definition at line 107 of file keyFrameMap.h.

end() [1/2]

TS_API iterator end ( )

inline

Definition at line 67 of file keyFrameMap.h.

end() [2/2]

TS_API const_iterator end ( ) const

inline

Definition at line 72 of file keyFrameMap.h.

erase() [1/3]

TS_API void erase ( iterator  first, iterator  last  )

inline

Definition at line 132 of file keyFrameMap.h.

erase() [2/3]

TS_API void erase ( iterator  i )

inline

Definition at line 137 of file keyFrameMap.h.

erase() [3/3]

TS_API void erase ( TsTime const &  t )

inline

Definition at line 201 of file keyFrameMap.h.

find() [1/2]

TS_API iterator find ( const TsTime &  t )

inline

Definition at line 164 of file keyFrameMap.h.

find() [2/2]

TS_API const_iterator find ( const TsTime &  t ) const

inline

Definition at line 173 of file keyFrameMap.h.

insert() [1/2]

void insert ( Iter const &  first, Iter const &  last  )

inline

Definition at line 194 of file keyFrameMap.h.

insert() [2/2]

TS_API iterator insert ( TsKeyFrame const &  value )

inline

Definition at line 182 of file keyFrameMap.h.

max_size()

TS_API size_t max_size ( ) const

inline

Definition at line 102 of file keyFrameMap.h.

operator!=()

TS_API bool operator!= ( const TsKeyFrameMap &  other ) const

inline

Definition at line 147 of file keyFrameMap.h.

operator=()

TS_API TsKeyFrameMap & operator= ( TsKeyFrameMap const &  other )

inline

Definition at line 51 of file keyFrameMap.h.

operator==()

TS_API bool operator== ( const TsKeyFrameMap &  other ) const

inline

Definition at line 142 of file keyFrameMap.h.

operator[]()

TS_API TsKeyFrame & operator[] ( const TsTime &  t )

inline

Definition at line 209 of file keyFrameMap.h.

rbegin() [1/2]

TS_API reverse_iterator rbegin ( )

inline

Definition at line 77 of file keyFrameMap.h.

rbegin() [2/2]

TS_API const_reverse_iterator rbegin ( ) const

inline

Definition at line 82 of file keyFrameMap.h.

rend() [1/2]

TS_API reverse_iterator rend ( )

inline

Definition at line 87 of file keyFrameMap.h.

rend() [2/2]

TS_API const_reverse_iterator rend ( ) const

inline

Definition at line 92 of file keyFrameMap.h.

reserve()

TS_API void reserve ( size_t  size )

inline

Definition at line 112 of file keyFrameMap.h.

size()

TS_API size_t size ( ) const

inline

Definition at line 97 of file keyFrameMap.h.

swap() [1/2]

TS_API void swap ( std::vector< TsKeyFrame > &  other )

inline

Definition at line 127 of file keyFrameMap.h.

swap() [2/2]

TS_API void swap ( TsKeyFrameMap &  other )

inline

Definition at line 122 of file keyFrameMap.h.

---

The documentation for this class was generated from the following file:

• pxr/base/ts/keyFrameMap.h