trimesh.h

Go to the documentation of this file.

/*
 * trimesh.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.
 *
 *
 * Simple library for reading triangle mesh data.
 */

#ifndef WAVEPACKET_TRIMESH_H__
#define WAVEPACKET_TRIMESH_H__


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

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


namespace trimesh {

// doxygen block

/// \ingroup geometric
/*@{*/

////////////////////////////////////////////////////////////////////////////////
///
/// \defgroup trimesh Triangle Mesh Routines
///
///\n
/// Simple library for reading triangle mesh data.
///
/// This library does not know how to render anything!  That is up to other
/// libraries.
///
////////////////////////////////////////////////////////////////////////////////
/*@{*/


class Trimesh {
public:
        // virtual destructor --------------------------------------------------
        virtual ~Trimesh(void) throw();

        // trimesh::Trimesh class interface methods ----------------------------
        virtual int getVertexCount(void) const throw() = 0;
        virtual int getTriangleCount(void) const throw() = 0;
        virtual const point3d_t * getVertexArray(void) const throw() = 0;

        /// there will be 3 * getTriangleCount() integers in the array
        virtual const int * getTriangleArray(void) const throw() = 0;

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

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



};      // trimesh namespace

/*@}*/  // end of documentation block

#endif  // WAVEPACKET_TRIMESH_H__