Developer Documentation
Public Member Functions | Private Attributes | List of all members
SkeletonT< PointT >::AnimationIterator Class Reference

Iterator class for the animations attached to a skeleton. More...

#include <Type-Skeleton/ObjectTypes/Skeleton/SkeletonT.hh>

Public Member Functions

 AnimationIterator (std::vector< Animation * > &_animations)
 Default constructor. More...
 
 AnimationIterator (std::vector< Animation * > &_animations, size_t _animationIndex)
 Constructor - Creates an iterator for the given animation set starting at a specific position. More...
 
AnimationIterator & operator++ ()
 Increase the iterator. More...
 
AnimationHandle operator* () const
 Get an animation handle for the current animation. More...
 
AnimationIterator & operator= (const AnimationIterator &other)
 Operator =. More...
 
 operator bool () const
 boolean operator More...
 

Private Attributes

size_t currentIndex_
 
std::vector< Animation * > & animations_
 

Detailed Description

template<class PointT>
class SkeletonT< PointT >::AnimationIterator

Iterator class for the animations attached to a skeleton.

This iterator can be used to iterate over all animations that are attached to the skeleton

Definition at line 114 of file SkeletonT.hh.

Constructor & Destructor Documentation

◆ AnimationIterator() [1/2]

template<typename PointT >
SkeletonT< PointT >::AnimationIterator::AnimationIterator ( std::vector< Animation * > &  _animations)
explicit

Default constructor.

Creates an iterator pointing to the beginning of the vector of animations

Definition at line 288 of file SkeletonT_impl.hh.

◆ AnimationIterator() [2/2]

template<typename PointT >
SkeletonT< PointT >::AnimationIterator::AnimationIterator ( std::vector< Animation * > &  _animations,
size_t  _animationIndex 
)

Constructor - Creates an iterator for the given animation set starting at a specific position.

Definition at line 305 of file SkeletonT_impl.hh.

Member Function Documentation

◆ operator bool()

template<typename PointT >
SkeletonT< PointT >::AnimationIterator::operator bool

boolean operator

Returns true if the iterator is pointing to a valid handle

Definition at line 350 of file SkeletonT_impl.hh.

◆ operator*()

template<typename PointT >
AnimationHandle SkeletonT< PointT >::AnimationIterator::operator*

Get an animation handle for the current animation.

Definition at line 359 of file SkeletonT_impl.hh.

◆ operator++()

template<typename PointT >
SkeletonT< PointT >::AnimationIterator & SkeletonT< PointT >::AnimationIterator::operator++

Increase the iterator.

The iterator will be changed to the next animation in the list

Definition at line 322 of file SkeletonT_impl.hh.

◆ operator=()

template<typename PointT >
SkeletonT< PointT >::AnimationIterator & SkeletonT< PointT >::AnimationIterator::operator= ( const AnimationIterator &  other)

Operator =.

Definition at line 338 of file SkeletonT_impl.hh.

Member Data Documentation

◆ animations_

template<class PointT >
std::vector<Animation*>& SkeletonT< PointT >::AnimationIterator::animations_
private

Definition at line 128 of file SkeletonT.hh.

◆ currentIndex_

template<class PointT >
size_t SkeletonT< PointT >::AnimationIterator::currentIndex_
private

Definition at line 126 of file SkeletonT.hh.

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