Animation.h

/*
 * Copyright (c) 2018, Stefan Osswald
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 
 * * Redistributions of source code must retain the above copyright notice, this
 *   list of conditions and the following disclaimer.
 * 
 * * Redistributions in binary form must reproduce the above copyright notice,
 *   this list of conditions and the following disclaimer in the documentation
 *   and/or other materials provided with the distribution.
 * 
 * * Neither the name of the copyright holder nor the names of its
 *   contributors may be used to endorse or promote products derived from
 *   this software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */ 

#ifndef INCLUDE_ARTICULATION_ANIMATION_H_
#define INCLUDE_ARTICULATION_ANIMATION_H_

#include <assimp/scene.h>
#include <vector>

namespace gpu_coverage {

// Forward declarations
class Scene;
class Node;
class Channel;

class Animation {
public:
    Animation(Scene * const scene, const aiAnimation * const animation, const size_t id);

    virtual ~Animation();

    typedef std::vector<Channel *> Channels;

    void toDot(FILE *dot);

    const size_t& getId() const {
        return id;
    }

    const std::string& getName() const {
        return name;
    }

    inline const size_t& getStartFrame() const {
        return startFrame;
    }

    inline const size_t& getEndFrame() const {
        return endFrame;
    }

    inline const size_t& getNumFrames() const {
        return numFrames;
    }

    inline const Channels& getChannels() const {
        return channels;
    }

    inline const double& getDuration() const {
        return duration;
    }

protected:
    const size_t id;             
    const std::string name;      
    const double duration;       
    size_t startFrame;           
    size_t endFrame;             
    size_t numFrames;            
    Channels channels;           
};

}

#endif /* INCLUDE_ARTICULATION_ANIMATION_H_ */