RAS_FramingManager.h

Go to the documentation of this file.

/*
 * $Id: RAS_FramingManager.h 35072 2011-02-22 12:42:55Z jesterking $
 *
 * ***** BEGIN GPL LICENSE BLOCK *****
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
 * All rights reserved.
 *
 * The Original Code is: all of this file.
 *
 * Contributor(s): none yet.
 *
 * ***** END GPL LICENSE BLOCK *****
 */

#ifndef RAS_FRAMINGMANAGER_H
#define RAS_FRAMINGMANAGER_H

#ifdef WITH_CXX_GUARDEDALLOC
#include "MEM_guardedalloc.h"
#endif

class RAS_Rect;

class RAS_FrameSettings 
{
public :
        enum RAS_FrameType {
                e_frame_scale,
                e_frame_extend,
                e_frame_bars
        };
        
        RAS_FrameSettings(
                RAS_FrameType frame_type,
                float bar_r,
                float bar_g,
                float bar_b,
                unsigned int design_aspect_width,
                unsigned int design_aspect_height 
        ):
                m_frame_type(frame_type),
                m_bar_r(bar_r),
                m_bar_g(bar_g),
                m_bar_b(bar_b),
                m_design_aspect_width(design_aspect_width),
                m_design_aspect_height(design_aspect_height)
        {
        };

        RAS_FrameSettings(
        ):
                m_frame_type(e_frame_scale),
                m_bar_r(0),
                m_bar_g(0),
                m_bar_b(0),
                m_design_aspect_width(1),
                m_design_aspect_height(1)
        {
        };

        const
                RAS_FrameType &         
        FrameType(
        ) const {
                return m_frame_type;
        };

                void
        SetFrameType(
                RAS_FrameType type
        ) {
                m_frame_type = type;
        };
        
                float
        BarRed(
        ) const {
                return m_bar_r;
        };
                
                float
        BarGreen(
        ) const {
                return m_bar_g;
        };

                float
        BarBlue(
        ) const {
                return m_bar_b;
        };

                unsigned int
        DesignAspectWidth(
        ) const {
                return m_design_aspect_width;   
        };

                unsigned int
        DesignAspectHeight(
        ) const {
                return m_design_aspect_height;  
        };

private :

        RAS_FrameType m_frame_type;
        float m_bar_r;
        float m_bar_g;
        float m_bar_b;
        unsigned int m_design_aspect_width;
        unsigned int m_design_aspect_height;


#ifdef WITH_CXX_GUARDEDALLOC
public:
        void *operator new(size_t num_bytes) { return MEM_mallocN(num_bytes, "GE:RAS_FrameSettings"); }
        void operator delete( void *mem ) { MEM_freeN(mem); }
#endif
}; 

struct RAS_FrameFrustum
{
        float camnear,camfar;
        float x1,y1;
        float x2,y2;
};      

/* must match R_CULLING_... from DNA_scene_types.h */
enum RAS_CullingMode
{
        RAS_CULLING_DBVT = 0,
        RAS_CULLING_NORMAL,
        RAS_CULLING_NONE
};

class RAS_FramingManager
{
public :

        static
                void
        ComputeViewport(
                const RAS_FrameSettings &settings,
                const RAS_Rect &availableViewport,
                RAS_Rect &viewport
        );

        
        static
                void
        ComputeOrtho(
                const RAS_FrameSettings &settings,
                const RAS_Rect &availableViewport,
                const RAS_Rect &viewport,
                const float scale,
                const float camnear,
                const float camfar,
                RAS_FrameFrustum &frustum
        );

        static
                void
        ComputeFrustum(
                const RAS_FrameSettings &settings,
                const RAS_Rect &availableViewport,
                const RAS_Rect &viewport,
                const float lens,
                const float camnear,
                const float camfar,
                RAS_FrameFrustum &frustum
        );

        static
                void
        ComputeDefaultFrustum(
                const float camnear,
                const float camfar,
                const float lens,
                const float design_aspect_ratio,
                RAS_FrameFrustum & frustum
        );      

        static
                void
        ComputeDefaultOrtho(
                const float camnear,
                const float camfar,
                const float scale,
                const float design_aspect_ratio,
                RAS_FrameFrustum & frustum
        );

private :

        static
                void
        ComputeBestFitViewRect(
                const RAS_Rect &availableViewport,
                const float design_aspect_ratio,
                RAS_Rect &viewport
        );



        RAS_FramingManager(
        );

        RAS_FramingManager(
                const RAS_FramingManager &
        );
        

#ifdef WITH_CXX_GUARDEDALLOC
public:
        void *operator new(size_t num_bytes) { return MEM_mallocN(num_bytes, "GE:RAS_FramingManager"); }
        void operator delete( void *mem ) { MEM_freeN(mem); }
#endif
};              
                
#endif