Frame.hxx

// 
// Copyright (C) 2006 James M. Lawrence.  All rights reserved.
// 
// software: esve-1.0.3
// file: esve/engine/dim3/Frame.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_engine_dim3_Frame_hxx
#define esve_engine_dim3_Frame_hxx

#include <esve/engine/dim3/Transform_Stowed.hxx>
#include <esve/message/Update_Receiver.hxx>

namespace esve { namespace engine { namespace dim3 {

namespace impl { class Frame ; }


class Frame
    : virtual public Transform_Stowed,
      virtual public message::Update_Receiver
{
public:
    virtual
    const engine::dim3::Transform &
    world_transform() const = 0 ;

    virtual void add( Frame & ) = 0 ;
    virtual void remove( Frame & ) = 0 ;
    virtual void remove_all() = 0 ;

    // not encouraged; leave out of doxygen.
    virtual void remove_parent() = 0 ;

    // mandatory implementation
    virtual impl::Frame & frame() = 0 ;
    virtual const impl::Frame & frame() const = 0 ;

    virtual ~Frame() = 0 ;

protected:
    Frame() ;

private:
    Frame( const Frame & ) ;
    Frame & operator=( const Frame & ) ;
} ;

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

#endif

---