Basic_Viewer.hxx

// 
// Copyright (C) 2006 James M. Lawrence.  All rights reserved.
// 
// software: esve-1.0.3
// file: esve/viewers/dim3/Basic_Viewer.hxx
// 
// 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. The origin of this software must not be misrepresented; you must
//    not claim that you wrote the original software.  If you use this
//    software in a product, an acknowledgment in the product 
//    documentation would be appreciated but is not required.
// 
// 3. Altered source versions must be plainly marked as such, and must
//    not be misrepresented as being the original software.
// 
// 4. The name of the author may not be used to endorse or promote
//    products derived from this software without specific prior written
//    permission.
// 
// THIS SOFTWARE IS PROVIDED "AS IS" WITHOUT EXPRESS OR IMPLIED WARRANTY,
// AND WITH NO CLAIM AS TO ITS SUITABILITY FOR ANY PURPOSE.  IN NO EVENT
// SHALL THE AUTHOR BE LIABLE FOR ANY CLAIM WHATSOEVER MADE IN CONNECTION
// TO THIS SOFTWARE.
// 

#ifndef esve_viewers_dim3_Basic_Viewer_hxx
#define esve_viewers_dim3_Basic_Viewer_hxx

#include <esve/viewers/dim3/Camera.hxx>
#include <esve/viewers/dim3/Minimal_Viewer.hxx>
#include <esve/kernel/Simple_Kernel_Stowed.hxx>
#include <esve/message/Compute_Sender_Stowed.hxx>
#include <esve/message/Draw_Sender_Stowed.hxx>
#include <string>
#include <memory>

namespace esve { namespace engine { namespace dim3 {

class Frame ;
class Geom ;

}}} // namespace esve::engine::dim3

namespace esve { namespace components { namespace dimn  {

class Motion_Handler ;

}}} // namespace esve::engine::dimn

namespace esve { namespace viewers { namespace dim3 {

class Light ;


class Basic_Viewer
    : virtual protected kernel::Simple_Kernel_Stowed,
      virtual protected message::Draw_Sender_Stowed,
      virtual protected message::Compute_Sender_Stowed,
      virtual public Minimal_Viewer
{
public:
    Basic_Viewer() ;

    virtual int takeover() ;

    virtual
    Camera &
    create_camera( const std::string & = default_camera_label,
                   const Camera::Rectangle & = default_camera_rectangle ) ;

    virtual Light & create_light() ;

    virtual void add_geom( engine::dim3::Geom & ) ;

    virtual void remove_geom( engine::dim3::Geom & ) ;

    virtual void add_handler( components::dimn::Motion_Handler & ) ;

    virtual void remove_handler( components::dimn::Motion_Handler & ) ;

    virtual void add_handler( kernel::Handler & ) ;
    virtual void remove_handler( kernel::Handler & ) ;


    virtual void add_frame( engine::dim3::Frame & ) ;

    virtual void remove_frame( engine::dim3::Frame & ) ;


    ~Basic_Viewer() ;

    static const std::string default_camera_label ;
    static const Camera::Rectangle default_camera_rectangle ;

protected:
    void remove_all_handlers() ;

    message::Draw_Sender & peek_draw_sender() ;

    message::Draw_Sender & peek_unlit_draw_sender() ;

    message::Draw_Sender & peek_draw_initializer() ;

    message::Compute_Sender & peek_compute_sender() ;

    kernel::Simple_Kernel & peek_kernel() ;

    //
    // This is the base camera which will sit inside the delegate
    // returned by create_camera().
    //
    // Override to adjust methods like send_draw() which do not
    // propagate to delegates.
    //
    virtual
    std::auto_ptr<Camera>
    new_camera( const std::string & label,
                const Camera::Rectangle & ) ;

    //
    // This is the base light which will sit inside the delegate
    // returned by create_light().
    //
    // Override to adjust methods like send_draw() which do not
    // propagate to delegates.
    //
    virtual std::auto_ptr<Light> new_light() ;

private:
    Basic_Viewer( const Basic_Viewer & ) ;
    Basic_Viewer & operator=( const Basic_Viewer & ) ;

    class Private ;
    const std::auto_ptr<Private> m ;
} ;

}}} // namespace esve::viewers::dim3

#endif

---