frustum.h

/* Copyright (c) 2009-2011, 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 EQFABRIC_FRUSTUM_H
#define EQFABRIC_FRUSTUM_H

#include <eq/fabric/projection.h> // member
#include <eq/fabric/wall.h>       // member
#include <eq/fabric/api.h>       // decl

namespace co
{
    class DataOStream;
    class DataIStream;
}

namespace eq
{
namespace fabric
{
    class Frustum
    {
    public:
        EQFABRIC_API Frustum();
        
        EQFABRIC_API virtual ~Frustum();

        enum Type
        {
            TYPE_NONE,        
            TYPE_WALL,        
            TYPE_PROJECTION   
        };

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

        const Wall& getWall() const { return _data.wall; }

        const Projection& getProjection() const { return _data.projection; }

        Type getCurrentType() const { return _data.current; }

        EQFABRIC_API virtual void unsetFrustum();

        EQFABRIC_API void serialize( co::DataOStream& os ); 
        EQFABRIC_API void deserialize( co::DataIStream& is ); 

        EQFABRIC_API virtual void backup(); 
        EQFABRIC_API virtual void restore(); 

    protected:
        virtual void updateFrustum() {}

    private:
        struct BackupData
        {
            BackupData() : current( TYPE_NONE ) {}

            Wall wall;

            Projection projection;

            Type current;
        }
            _data, _backup; 

        struct Private;
        Private* _private; // placeholder for binary-compatible changes
    };
    EQFABRIC_API std::ostream& operator << ( std::ostream& os, const Frustum& );
}
}
#endif // EQFABRIC_FRUSTUM_H