animation-state.h

Go to the documentation of this file.

/*
 * animation-state.h
 *
 * Copyright (C) 2010  Thomas A. Vaughan
 * 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 <organization> 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 THOMAS A. VAUGHAN ''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 THOMAS A. VAUGHAN 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 WAVE_GLUT_ANIMATION_STATE_H__
#define WAVE_GLUT_ANIMATION_STATE_H__

// includes --------------------------------------------------------------------
#include "util/stack_array.h"


namespace glut {

////////////////////////////////////////////////////////////////////////////////
///
/// \ingroup glut_core
/// \defgroup anim_state Animation State
///
////////////////////////////////////////////////////////////////////////////////
/*@{*/


/// An object can have many animations going at once.  This structure tracks
///     the state of a single animation channel.
struct anim_channel_state_t {
        // constructor, manipulators
        anim_channel_state_t(void) throw() { }
        void clear(void) throw() {
                        animIndex = -1; // invalid
                        msElapsed = 0;
                }
        void dump(IN const char * title) const throw() {
                        DPRINTF("%s: index(%d) ms(%d)",
                            title, animIndex, msElapsed);
                }

        // data fields
        int16_t         animIndex;    ///< index of animation
        word_t          unused;       // for dword alignment
        int32_t         msElapsed;    ///< milliseconds since animation started
};


// class exists only to define an enum: the maximum number of active animations
// we allow at any one time (max per object).
class MaxAnimations {
public:
        enum eConstants {
                eMaxArraySize   = 8 ///< max animations at once for an object
        };
};



typedef stack_array<anim_channel_state_t, MaxAnimations> animation_list_t;



/// Simple class of fixed size to maintain per-object animation state
class AnimationState : public animation_list_t {
public:
        // constructor ---------------------------------------------------------
        AnimationState(void) throw();

        // AnimationState public class methods ---------------------------------

        /// serialize current state out to a string
        void serialize(OUT std::string& state) const;

        /// update our internal state based on passed-in animation state string.
        ///     Returns false if deserialization fails (bad input string).
        bool deserialize(IN const char * state);

private:
};



};      // glut namespace

#endif  // WAVE_GLUT_ANIMATION_STATE_H__