action.h

Go to the documentation of this file.

#ifndef VART_ACTION_H
#define VART_ACTION_H

#include "vart/time.h"
#include "vart/scenenode.h"
#include <list>
#include <string>

namespace VART {
    class JointMover;
    class Joint;
    class Interpolator;
    class CallBack;
    class NoisyDofMover;
    class DMModifier;
    class Action {
        friend std::ostream& operator<<(std::ostream& output, const Action& action);
        public:
        // PUBLIC METHODS
            Action();

            ~Action();

            VART::Action& operator=(const VART::Action& action);

            JointMover* AddJointMover(Joint* jointPtr,
                                      float newDuration, const Interpolator& interpolator);

            JointMover* AddJointMover(Joint* jointPtr, JointMover* jointMover);

            void SetPriority(unsigned int newPriority) { priority = newPriority; }

            void SetSpeed(float newSpeed) { speed = newSpeed; }

            void SetCyclic(bool value) { cycle = value; }

            bool IsCyclic() { return cycle; }

            void Set(float newSpeed, unsigned int newPriority, bool cyclic);

            void Activate();

            void Deactivate();

            void Deactivate(float seconds);

            bool IsActive() const { return active; }

            void GetFinalTimes(std::list<float>* resultPtr);

            VART::Action* Copy(VART::SceneNode& targetNode);

            void ModifyDofMovers(DMModifier& mod);
        // STATIC PUBLIC METHODS
            static unsigned int MoveAllActive();
        // STATIC PUBLIC ATTRIBUTES
            static float frameFrequency;
        // PUBLIC ATTRIBUTES
            std::string description;
            CallBack* callbackPtr;
        protected:
        // PROTECTED METHODS
            void Move();
            void DeactivateDofMovers();
        // PROTECTED ATTRIBUTES
            bool cycle;
            bool active;
            // FixMe: Speeds greater than 1 make a cyclic action stop between cycles!
            // FixMe: Speeds less than 1 make a cyclic action jump between cycles!
            float speed;
            float duration;
            float timeToLive; 
            unsigned int priority;
            std::list<JointMover*> jointMoverList;
            Time initialTime;
        // STATIC PROTECTED ATTRIBUTES
            static std::list<Action*> activeInstances;
        private:
            // keep programmers from creating copies of actions
            Action(const Action& action) {}
            float timeDiff; // how many seconds have passed since activation
    }; // end class declaration
} // end namespace

#endif