client-game-logic/client-game-logic.h

Go to the documentation of this file.

/*
 * client-game-logic.h
 *
 * Copyright (C) 2008-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.
 *
 *
 * Declaration of the client-side game logic interfaces.
 */

#ifndef AESOP_REF_CLIENT_GAME_LOGIC_H__
#define AESOP_REF_CLIENT_GAME_LOGIC_H__

// includes --------------------------------------------------------------------
#include "glut-app/client-game-logic.h" // client library defines the interface

#include "threadsafe/smart_ptr.h"


namespace aesop {

////////////////////////////////////////////////////////////////////////////////
///
/// \ingroup aesop_client_lib
/// \defgroup client_game_logic_impl Client-Side Game Logic Implementation
///
/// \n
/// Reference implementation of a client-side game logic object.
///
/// See aesop::ClientGameLogic for the interface definition.
///
////////////////////////////////////////////////////////////////////////////////
/*@{*/


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

/// factory method to create a basic client-side game logic object
smart_ptr<ClientGameLogic> createClientGameLogic(void);


};      // aesop namespace

#endif  // AESOP_REF_GAME_LOGIC_H__