Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Changeset 4836 in orxonox.OLD for orxonox/trunk/src/util/animation


Ignore:
Timestamp:
Jul 12, 2005, 12:33:16 AM (20 years ago)
Author:
bensch
Message:

orxonox/trunk: renamed all the \param → @param and so on in Doxygen tags.
Thanks a lot to the kDevelop team. this took since the last commit :)

Location:
orxonox/trunk/src/util/animation
Files:
6 edited

Legend:

Unmodified
Added
Removed

  • orxonox/trunk/src/util/animation/animation.cc

    r4746 r4836  
    2121
    2222/**
    23    \brief creates a new Animation
     23 * creates a new Animation
    2424
    2525   This also adds the Animation automatically to the AnimationPlayer's list
    … …  
    4444
    4545/**
    46    \brief destructs the Animation
     46 * destructs the Animation
    4747
    4848   this also takes the animation out of the AnimationPlayer's list (if it is there)
    … …  
    5454
    5555/**
    56    \brief tells the AnimationPlayer, that we do not wish to  handle this animation
     56 * tells the AnimationPlayer, that we do not wish to  handle this animation
    5757   automatically.
    5858
    … …  
    6666
    6767/**
    68    \brief Sets the infinitymode
    69    \param postInfinity How the Animation should advance after the last Keyframe
     68 * Sets the infinitymode
     69 * @param postInfinity How the Animation should advance after the last Keyframe
    7070*/
    7171void Animation::setInfinity(ANIM_INFINITY postInfinity)
    … …  
    7575
    7676/**
    77    \brief handles the Animation if it gets out of boundraries eg. if animation is finished.
     77 * handles the Animation if it gets out of boundraries eg. if animation is finished.
    7878*/
    7979void Animation::handleInfinity()
    … …  
    9999
    100100/**
    101    \brief plays the animation back from the current Time forward
     101 * plays the animation back from the current Time forward
    102102*/
    103103void Animation::play()
    … …  
    108108
    109109/**
    110    \brief plays the Next n keyframes
    111    \param n the Count of keyFrames to play.
     110 * plays the Next n keyframes
     111 * @param n the Count of keyFrames to play.
    112112*/
    113113void Animation::playNextKeyframes(int n)
    … …  
    118118
    119119/**
    120    \brief Stops the animation. eg. pause(); rewind();
     120 * Stops the animation. eg. pause(); rewind();
    121121*/
    122122void Animation::stop()
    … …  
    130130
    131131/**
    132    \brief Pauses the animation. Stays at the current Time
     132 * Pauses the animation. Stays at the current Time
    133133*/
    134134void Animation::pause()
    … …  
    138138
    139139/**
    140    \brief replays the animation, eg. rewind();play();
     140 * replays the animation, eg. rewind();play();
    141141*/
    142142void Animation::replay()

  • orxonox/trunk/src/util/animation/animation.h

    r4746 r4836  
    1616//! An enumerator of Functions to describe the flow of the Animation
    1717/**
    18    \todo check with Patrick it of
     18   @todo check with Patrick it of
    1919
    2020   description in speed to the next keyframe:
    … …  
    8888  virtual void rewind() = 0;
    8989
    90   /** \brief A virtual function that ticks the animation \param dt the time passed */
     90  /** \brief A virtual function that ticks the animation @param dt the time passed */
    9191  virtual void tick(float dt) = 0;
    9292
    93   /** \returns the BaseObject, this animation operates on */
     93  /** @returns the BaseObject, this animation operates on */
    9494  BaseObject* getBaseObject() const { return this->baseObject; };
    9595
    96   /** \returns if the Animation should be deleted */
     96  /** @returns if the Animation should be deleted */
    9797  inline bool ifDelete() { return bDelete; };
    9898
    … …  
    124124 public:
    125125  inline aTest() { last = 0.0;}
    126   /** \brief a little debug information to show the results of this class \param f new value */
     126  /** \brief a little debug information to show the results of this class @param f new value */
    127127  inline void littleDebug(float f) {  diff = f - last; printf("f=%f, diff=%f\n", f,diff); last = f;}
    128128 private:

  • orxonox/trunk/src/util/animation/animation3d.cc

    r4746 r4836  
    2828
    2929/**
    30    \brief standard constructor
     30 * standard constructor
    3131*/
    3232Animation3D::Animation3D(PNode* object)
    … …  
    5050
    5151/**
    52    \brief standard deconstructor
     52 * standard deconstructor
    5353
    5454   deletes all the Keyframes
    … …  
    6969
    7070/**
    71    \brief rewinds the Animation to the beginning (first KeyFrame and time == 0)
     71 * rewinds the Animation to the beginning (first KeyFrame and time == 0)
    7272*/
    7373void Animation3D::rewind()
    … …  
    8181
    8282/**
    83    \brief Appends a new Keyframe
    84    \param position The position of the new Keyframe
    85    \param direction The direction of the new Keyframe.
    86    \param duration The duration from the new KeyFrame to the next one
    87    \param animFuncMov The function to animate position between this keyFrame and the next one
    88    \param animFuncRot The function to animate rotation between this keyFrame and the next one
     83 * Appends a new Keyframe
     84 * @param position The position of the new Keyframe
     85 * @param direction The direction of the new Keyframe.
     86 * @param duration The duration from the new KeyFrame to the next one
     87 * @param animFuncMov The function to animate position between this keyFrame and the next one
     88 * @param animFuncRot The function to animate rotation between this keyFrame and the next one
    8989*/
    9090void Animation3D::addKeyFrame(Vector position, Quaternion direction, float duration,
    … …  
    130130
    131131/**
    132    \brief ticks the Animation
    133    \param dt how much time to tick
     132 * ticks the Animation
     133 * @param dt how much time to tick
    134134*/
    135135void Animation3D::tick(float dt)
    … …  
    167167
    168168/**
    169    \brief Sets The kind of movment Animation between this keyframe and the next one
    170    \param animFuncMov: The Type of Animation to set
     169 * Sets The kind of movment Animation between this keyframe and the next one
     170 * @param animFuncMov: The Type of Animation to set
    171171*/
    172172void Animation3D::setAnimFuncMov(ANIM_FUNCTION animFuncMov)
    … …  
    216216
    217217/**
    218    \brief stays at the value of the currentKeyFrame
    219    \param timePassed The time passed since this Keyframe began
     218 * stays at the value of the currentKeyFrame
     219 * @param timePassed The time passed since this Keyframe began
    220220*/
    221221void Animation3D::mConstant(float timePassed) const
    … …  
    232232
    233233/**
    234    \brief linear interpolation between this keyframe and the next one
    235    \param timePassed The time passed since this Keyframe began
    236 
    237    \todo implement also do this for direction
     234 * linear interpolation between this keyframe and the next one
     235 * @param timePassed The time passed since this Keyframe began
     236
     237   @todo implement also do this for direction
    238238*/
    239239void Animation3D::mLinear(float timePassed) const
    … …  
    245245
    246246/**
    247    \brief a Sinusodial Interpolation between this keyframe and the next one
    248    \param timePassed The time passed since this Keyframe began
    249 
    250    \todo implement
     247 * a Sinusodial Interpolation between this keyframe and the next one
     248 * @param timePassed The time passed since this Keyframe began
     249
     250   @todo implement
    251251*/
    252252void Animation3D::mSine(float timePassed) const
    … …  
    264264
    265265/**
    266    \brief a cosine interpolation between this keyframe and the next one
    267    \param timePassed The time passed since this Keyframe began
    268 
    269    \todo implement
     266 * a cosine interpolation between this keyframe and the next one
     267 * @param timePassed The time passed since this Keyframe began
     268
     269   @todo implement
    270270*/
    271271void Animation3D::mCosine(float timePassed) const
    … …  
    287287
    288288/**
    289    \brief an exponential interpolation between this keyframe and the next one
    290    \param timePassed The time passed since this Keyframe began
     289 * an exponential interpolation between this keyframe and the next one
     290 * @param timePassed The time passed since this Keyframe began
    291291*/
    292292void Animation3D::mExp(float timePassed) const
    … …  
    297297
    298298/**
    299    \brief a negative exponential interpolation between this keyframe and the next one
    300    \param timePassed The time passed since this Keyframe began
     299 * a negative exponential interpolation between this keyframe and the next one
     300 * @param timePassed The time passed since this Keyframe began
    301301*/
    302302void Animation3D::mNegExp(float timePassed) const
    … …  
    316316
    317317/**
    318    \brief a quadratic interpolation between this keyframe and the next one
    319    \param timePassed The time passed since this Keyframe began
    320 
    321    \todo implement
     318 * a quadratic interpolation between this keyframe and the next one
     319 * @param timePassed The time passed since this Keyframe began
     320
     321   @todo implement
    322322*/
    323323void Animation3D::mQuadratic(float timePassed) const
    … …  
    328328
    329329/**
    330    \brief some random animation (fluctuating)
    331    \param timePassed The time passed since this Keyframe began
     330 * some random animation (fluctuating)
     331 * @param timePassed The time passed since this Keyframe began
    332332*/
    333333void Animation3D::mRandom(float timePassed) const
    … …  
    346346
    347347/**
    348    \brief Sets The kind of rotation Animation between this keyframe and the next one
    349    \param animFuncRot: The Type of Animation to set
     348 * Sets The kind of rotation Animation between this keyframe and the next one
     349 * @param animFuncRot: The Type of Animation to set
    350350*/
    351351void Animation3D::setAnimFuncRot(ANIM_FUNCTION animFuncRot)
    … …  
    385385
    386386/**
    387    \brief stays at the value of the currentKeyFrame
    388    \param timePassed The time passed since this Keyframe began
     387 * stays at the value of the currentKeyFrame
     388 * @param timePassed The time passed since this Keyframe began
    389389*/
    390390void Animation3D::rConstant(float timePassed) const
    … …  
    394394
    395395/**
    396    \brief linear interpolation between this keyframe and the next one
    397    \param timePassed The time passed since this Keyframe began
    398 
    399    \todo implement also do this for direction
     396 * linear interpolation between this keyframe and the next one
     397 * @param timePassed The time passed since this Keyframe began
     398
     399   @todo implement also do this for direction
    400400*/
    401401void Animation3D::rLinear(float timePassed) const
    … …  
    407407
    408408/**
    409    \brief a Sinusodial Interpolation between this keyframe and the next one
    410    \param timePassed The time passed since this Keyframe began
    411 
    412    \todo implement
     409 * a Sinusodial Interpolation between this keyframe and the next one
     410 * @param timePassed The time passed since this Keyframe began
     411
     412   @todo implement
    413413*/
    414414void Animation3D::rSine(float timePassed) const
    … …  
    427427
    428428/**
    429    \brief a cosine interpolation between this keyframe and the next one
    430    \param timePassed The time passed since this Keyframe began
    431 
    432    \todo implement
     429 * a cosine interpolation between this keyframe and the next one
     430 * @param timePassed The time passed since this Keyframe began
     431
     432   @todo implement
    433433*/
    434434void Animation3D::rCosine(float timePassed) const
    … …  
    443443
    444444/**
    445    \brief an exponential interpolation between this keyframe and the next one
    446    \param timePassed The time passed since this Keyframe began
     445 * an exponential interpolation between this keyframe and the next one
     446 * @param timePassed The time passed since this Keyframe began
    447447*/
    448448void Animation3D::rExp(float timePassed) const
    … …  
    452452
    453453/**
    454    \brief a negative exponential interpolation between this keyframe and the next one
    455    \param timePassed The time passed since this Keyframe began
     454 * a negative exponential interpolation between this keyframe and the next one
     455 * @param timePassed The time passed since this Keyframe began
    456456*/
    457457void Animation3D::rNegExp(float timePassed) const
    … …  
    465465
    466466/**
    467    \brief a quadratic interpolation between this keyframe and the next one
    468    \param timePassed The time passed since this Keyframe began
    469 
    470    \todo implement
     467 * a quadratic interpolation between this keyframe and the next one
     468 * @param timePassed The time passed since this Keyframe began
     469
     470   @todo implement
    471471*/
    472472void Animation3D::rQuadratic(float timePassed) const
    … …  
    476476
    477477/**
    478    \brief some random animation (fluctuating)
    479    \param timePassed The time passed since this Keyframe began
     478 * some random animation (fluctuating)
     479 * @param timePassed The time passed since this Keyframe began
    480480*/
    481481void Animation3D::rRandom(float timePassed) const

  • orxonox/trunk/src/util/animation/animation_player.cc

    r4746 r4836  
    2424
    2525/**
    26    \brief standard constructor
     26 * standard constructor
    2727*/
    2828AnimationPlayer::AnimationPlayer ()
    … …  
    3636
    3737/**
    38    \brief the singleton reference to this class
     38 * the singleton reference to this class
    3939*/
    4040AnimationPlayer* AnimationPlayer::singletonRef = NULL;
    4141
    4242/**
    43    \brief standard deconstructor
     43 * standard deconstructor
    4444
    4545   !! DANGER !! when unloading the AnimationPlayer no other Function
    … …  
    5858
    5959/**
    60    \brief adds an Animation to the AnimationList.
    61    \param animation the Animation to handle
     60 * adds an Animation to the AnimationList.
     61 * @param animation the Animation to handle
    6262
    6363   when adding a Animation the Animation will too be deleted when
    … …  
    7171
    7272/**
    73    \brief removes an Animation from the Animation List, WITHOUT deleting it.
    74    \param animation the Anmination to remove from the List
     73 * removes an Animation from the Animation List, WITHOUT deleting it.
     74 * @param animation the Anmination to remove from the List
    7575*/
    7676void AnimationPlayer::removeAnimation(Animation* animation)
    … …  
    8080
    8181/**
    82    \brief empties the list AND deletes all the Animations
     82 * empties the list AND deletes all the Animations
    8383*/
    8484void AnimationPlayer::flush()
    … …  
    100100
    101101/**
    102    \brief Ticks all the animations in animationList
    103    \param timePassed the time passed since the last tick.
     102 * Ticks all the animations in animationList
     103 * @param timePassed the time passed since the last tick.
    104104*/
    105105void AnimationPlayer::tick(float timePassed)
    … …  
    124124}
    125125/**
    126    \brief starts playing the AnimationPlayer
     126 * starts playing the AnimationPlayer
    127127*/
    128128void AnimationPlayer::play()
    … …  
    132132
    133133/**
    134    \brief pauses playing of the AnimationPlayer
     134 * pauses playing of the AnimationPlayer
    135135*/
    136136void AnimationPlayer::pause()
    … …  
    140140
    141141/**
    142    \returns the animation from a certain baseobject
     142 * @returns the animation from a certain baseobject
    143143   if multiple are found, it just retruns the first one
    144144   if none is found it returns NULL
    … …  
    164164
    165165/**
    166    \brief Outputs some nice debug-information
     166 * Outputs some nice debug-information
    167167*/
    168168void AnimationPlayer::debug()

  • orxonox/trunk/src/util/animation/animation_player.h

    r4746 r4836  
    2929
    3030 public:
    31   /** \returns a Pointer to the only object of this Class */
     31  /** @returns a Pointer to the only object of this Class */
    3232  inline static AnimationPlayer* getInstance() { if (!singletonRef) singletonRef = new AnimationPlayer();  return singletonRef; };
    3333

  • orxonox/trunk/src/util/animation/t_animation.h

    r4746 r4836  
    7777
    7878/**
    79    \brief standard constructor
     79 * standard constructor
    8080*/
    8181template<class T>
    … …  
    9999
    100100/**
    101    \brief standard deconstructor
     101 * standard deconstructor
    102102
    103103   deletes all the Keyframes
    … …  
    119119
    120120/**
    121    \brief rewinds the Animation to the beginning (first KeyFrame and time == 0)
     121 * rewinds the Animation to the beginning (first KeyFrame and time == 0)
    122122*/
    123123template<class T>
    … …  
    131131
    132132/**
    133    \brief sets the Function we want to animate
    134    \param object from what object do we want to animate
    135    \param funcToAnim which function
     133 * sets the Function we want to animate
     134 * @param object from what object do we want to animate
     135 * @param funcToAnim which function
    136136*/
    137137template<class T>
    … …  
    143143
    144144/**
    145    \brief Appends a new Keyframe
    146    \param value the value of the new KeyFrame
    147    \param duration The duration from the new KeyFrame to the next one
    148    \param animFunc The function to animate between this keyFrame and the next one
     145 * Appends a new Keyframe
     146 * @param value the value of the new KeyFrame
     147 * @param duration The duration from the new KeyFrame to the next one
     148 * @param animFunc The function to animate between this keyFrame and the next one
    149149*/
    150150template<class T>
    … …  
    181181
    182182/**
    183    \brief ticks the Animation
    184    \param dt how much time to tick
     183 * ticks the Animation
     184 * @param dt how much time to tick
    185185*/
    186186template<class T>
    … …  
    217217
    218218/**
    219    \brief Sets The kind of Animation between this keyframe and the next one
    220    \param animFunc The Type of Animation to set
     219 * Sets The kind of Animation between this keyframe and the next one
     220 * @param animFunc The Type of Animation to set
    221221*/
    222222template<class T>
    … …  
    259259// animation functions
    260260/**
    261    \brief stays at the value of the currentKeyFrame
    262    \param timePassed The time passed since this Keyframe began
     261 * stays at the value of the currentKeyFrame
     262 * @param timePassed The time passed since this Keyframe began
    263263*/
    264264template<class T>
    … …  
    269269
    270270/**
    271    \brief linear interpolation between this keyframe and the next one
    272    \param timePassed The time passed since this Keyframe began
     271 * linear interpolation between this keyframe and the next one
     272 * @param timePassed The time passed since this Keyframe began
    273273*/
    274274template<class T>
    … …  
    280280
    281281/**
    282    \brief a Sinusodial Interpolation between this keyframe and the next one
    283    \param timePassed The time passed since this Keyframe began
     282 * a Sinusodial Interpolation between this keyframe and the next one
     283 * @param timePassed The time passed since this Keyframe began
    284284*/
    285285template<class T>
    … …  
    299299
    300300/**
    301    \brief a cosine interpolation between this keyframe and the next one
    302    \param timePassed The time passed since this Keyframe began
     301 * a cosine interpolation between this keyframe and the next one
     302 * @param timePassed The time passed since this Keyframe began
    303303*/
    304304template<class T>
    … …  
    311311
    312312/**
    313    \brief an exponential interpolation between this keyframe and the next one
    314    \param timePassed The time passed since this Keyframe began
     313 * an exponential interpolation between this keyframe and the next one
     314 * @param timePassed The time passed since this Keyframe began
    315315*/
    316316template<class T>
    … …  
    322322
    323323/**
    324    \brief a negative exponential interpolation between this keyframe and the next one
    325    \param timePassed The time passed since this Keyframe began
     324 * a negative exponential interpolation between this keyframe and the next one
     325 * @param timePassed The time passed since this Keyframe began
    326326*/
    327327template<class T>
    … …  
    334334
    335335/**
    336    \brief a quadratic interpolation between this keyframe and the next one
    337    \param timePassed The time passed since this Keyframe began
     336 * a quadratic interpolation between this keyframe and the next one
     337 * @param timePassed The time passed since this Keyframe began
    338338*/
    339339template<class T>
    … …  
    344344
    345345/**
    346    \brief some random animation (fluctuating)
    347    \param timePassed The time passed since this Keyframe began
     346 * some random animation (fluctuating)
     347 * @param timePassed The time passed since this Keyframe began
    348348*/
    349349template<class T>
Note: See TracChangeset for help on using the changeset viewer.