IState.hpp

/******************************************************************************
 
  nomlib - C++11 cross-platform game engine
 
Copyright (c) 2013, 2014 Jeffrey Carpenter <i8degrees@gmail.com>
All rights reserved.
 
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
 
1. Redistributions of source code must retain the above copyright notice, this
   list of conditions and the following disclaimer.
2. 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.
 
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 OWNER 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 NOMLIB_SYSTEM_ISTATE_HPP
#define NOMLIB_SYSTEM_ISTATE_HPP
 
#include "nomlib/config.hpp"
 
namespace nom {
 
// Forward declarations
class RenderWindow;
struct Event;

class IState
{
  public:
    typedef std::unique_ptr<IState> unique_ptr;

    enum Flags
    {
      BackUpdate = 0x2,

      BackRender = 0x4
    };

    enum Type
    {
      Parent = 0,
      Child
    };

    IState( void );

    virtual ~IState( void );

    IState( uint32 id );

    IState( uint32 id, uint32 flags, IState::Type type );

    uint32 id ( void ) const;

    uint32 timestamp ( void ) const;

    uint32 flags ( void ) const;

    IState::Type type( void ) const;

    virtual bool on_event(const nom::Event& ev);

    virtual void on_update ( float );

    virtual void on_draw ( RenderWindow& );

    virtual void on_init ( void_ptr );

    virtual void on_exit ( void_ptr );

    virtual void on_pause ( void_ptr );

    virtual void on_resume ( void_ptr );
 
  private:
    uint32 id_;

    uint32 timestamp_;

    uint32 flags_;

    Type type_;
};
 
} // namespace nom
 
#endif // include guard defined