Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Changeset 3853 in orxonox.OLD for orxonox/trunk/src/animation.cc


Ignore:
Timestamp:
Apr 17, 2005, 1:56:03 PM (19 years ago)
Author:
bensch
Message:

orxonox/trunk: doxygen-comments

File:
1 edited

Legend:

Unmodified
Added
Removed
  • orxonox/trunk/src/animation.cc

    r3847 r3853  
    1919#include "animation_player.h"
    2020
    21 
     21/**
     22   \brief creates a new Animation
     23   
     24   This also adds the Animation automatically to the AnimationPlayer's list
     25*/
    2226Animation::Animation(void)
    2327
     
    3438}
    3539
     40/**
     41   \brief destructs the Animation
     42   
     43   this also takes the animation out of the AnimationPlayer's list (if it is there)
     44*/
    3645Animation::~Animation(void)
    3746{
     
    3948}
    4049
     50/**
     51   \brief tells the AnimationPlayer, that we do not wish to  handle this animation
     52   automatically.
     53   
     54   This means that it will not be ticked, and not be deleted with the AnimationPlayer
     55*/
    4156void Animation::doNotHandle(void)
    4257{
     
    4560}
    4661
    47 
     62/**
     63   \brief Sets the infinitymode
     64   \param postInfinity How the Animation should advance after the last Keyframe
     65*/
    4866void Animation::setInfinity(ANIM_INFINITY postInfinity)
    4967{
     
    5169}
    5270
    53 
     71/**
     72   \brief plays the animation back from the current Time forward
     73*/
    5474void Animation::play()
    5575{
     
    5777}
    5878
    59 
     79/**
     80   \brief Stops the animation. eg. pause(); rewind();
     81*/
    6082void Animation::stop()
    6183{
     
    6587  this->bRunning = false;
    6688}
     89
     90/**
     91   \brief Pauses the animation. Stays at the current Time
     92*/
    6793void Animation::pause()
    6894{
    6995  this->bRunning = false;
    7096}
     97
     98/**
     99   \brief replays the animation, eg. rewind();play();
     100*/
    71101void Animation::replay()
    72102{
Note: See TracChangeset for help on using the changeset viewer.