bvh.h

Go to the documentation of this file.

/*
 * bvh.h
 *
 * Copyright (C) 2009  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.
 *
 *
 * Basic support for skeletal animations (the BVH format)
 */

#ifndef WAVE_GLUT_BVH_H__
#define WAVE_GLUT_BVH_H__

// includes --------------------------------------------------------------------
#include "common/common.h"

#include "geometry/matrix_4.h"
#include "threadsafe/smart_ptr.h"


namespace bvh {


////////////////////////////////////////////////////////////////////////////////
///
/// \ingroup models
/// \defgroup bvh The BVH Format - Motion Capture (Animation)
///
/// Simple reference implementation for the BioVision Hierarchical data file
/// format.  See http://en.wikipedia.org/wiki/Biovision_Hierarchy
///
///
////////////////////////////////////////////////////////////////////////////////
/*@{*/


struct node_position_t {
        // public enums
        enum eConstants {
                eMaxNameSize            = 32
        };

        // constructor, manipulators
        node_position_t(void) throw() { this->clear(); }
        void clear(void) throw() {
                        parent = NULL;
                        name[0] = 0;
                }

        // data fields
        char                    name[eMaxNameSize];
        point3d_t               pos;
        node_position_t *       parent;
        matrix4_t               T;      // total transform
};



/// basic class containing a skeleton and a single animation
class Skeleton {
public:
        // virtual destructor --------------------------------------------------
        virtual ~Skeleton(void) throw();

        // bvh::Skeleton class interface methods -------------------------------

        /// number of objects (root skeleton nodes)
        virtual int getObjectCount(void) const throw() = 0;

        /// get count of nodes (vertices) for this object
        virtual int getNodeCount(IN int objIndex) const throw() = 0;

        /// Get the positions of all nodes for this object at the given time.
        /// \b NOTE: the caller must provide a pre-allocated array of
        ///  node_position_t objects, of size getNodeCount(objIndex).
        virtual void getNodePositions(IN int objIndex,
                                IN float time,
                                OUT node_position_t * p) const throw() = 0;

        /// helper method for debugging
        virtual void dump(IN const char * title) const throw() = 0;

        // static factory methods ----------------------------------------------
        static smart_ptr<Skeleton> load(IN const char * filename);      
};



////////////////////////////////////////////////////////////////////////////////
//
//      public API
//
////////////////////////////////////////////////////////////////////////////////


};      // bvh namespace


#endif  // WAVE_GLUT_BVH_H__