lib/client/frustum.h

/* Copyright (c) 2009, Stefan Eilemann <eile@equalizergraphics.com> 
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License version 2.1 as published
 * by the Free Software Foundation.
 *  
 * This library is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
 * details.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#ifndef EQ_FRUSTUM_H
#define EQ_FRUSTUM_H

#include <eq/client/object.h>     // base class
#include <eq/client/projection.h> // member
#include <eq/client/wall.h>       // member

namespace eq
{
    class Frustum : public Object
    {
    public:
        EQ_EXPORT Frustum();
        
        EQ_EXPORT virtual ~Frustum();

        enum Type
        {
            TYPE_NONE,        
            TYPE_WALL,        
            TYPE_PROJECTION   
        };

        EQ_EXPORT void setWall( const Wall& wall );
        
        EQ_EXPORT void setProjection( const Projection& projection );

        EQ_EXPORT const Wall& getWall() const { return _wall; }

        EQ_EXPORT const Projection& getProjection() const { return _projection;}

        EQ_EXPORT Type getCurrentType() const { return _current; }

        EQ_EXPORT void unsetFrustum();

    protected:
        EQ_EXPORT virtual void serialize( net::DataOStream& os,
                                          const uint64_t dirtyBits );
        EQ_EXPORT virtual void deserialize( net::DataIStream& is, 
                                            const uint64_t dirtyBits );

        enum DirtyBits
        {
            DIRTY_TYPE       = Object::DIRTY_CUSTOM << 0,
            DIRTY_WALL       = Object::DIRTY_CUSTOM << 1,
            DIRTY_PROJECTION = Object::DIRTY_CUSTOM << 2,
            DIRTY_FILL1      = Object::DIRTY_CUSTOM << 3,
            DIRTY_FILL2      = Object::DIRTY_CUSTOM << 4,
            DIRTY_CUSTOM     = Object::DIRTY_CUSTOM << 5,
        };

    private:
        Wall _wall;

        Projection _projection;

        Type _current;

        union // placeholder for binary-compatible changes
        {
            char dummy[64];
        };
    };

    EQ_EXPORT std::ostream& operator << ( std::ostream& os, const Frustum& );
}
#endif // EQ_FRUSTUM_H