# Visualization Library

A lightweight C++ OpenGL middleware for 2D/3D graphics

[Home] [Tutorials] [All Classes] [Grouped Classes]

- Main Page
- Related Pages
- Namespaces
- Classes
- Files

- File List
- File Members

# D:/VL/BuildSystem/VL_DISTRO/Visualization_Library_SDK/src/vlGraphics/Viewport.hpp

Go to the documentation of this file.

    00001 /**************************************************************************************/
    00002 /*                                                                                    */
    00003 /*  Visualization Library                                                             */
    00004 /*  http://www.visualizationlibrary.org                                               */
    00005 /*                                                                                    */
    00006 /*  Copyright (c) 2005-2010, Michele Bosi                                             */
    00007 /*  All rights reserved.                                                              */
    00008 /*                                                                                    */
    00009 /*  Redistribution and use in source and binary forms, with or without modification,  */
    00010 /*  are permitted provided that the following conditions are met:                     */
    00011 /*                                                                                    */
    00012 /*  - Redistributions of source code must retain the above copyright notice, this     */
    00013 /*  list of conditions and the following disclaimer.                                  */
    00014 /*                                                                                    */
    00015 /*  - Redistributions in binary form must reproduce the above copyright notice, this  */
    00016 /*  list of conditions and the following disclaimer in the documentation and/or       */
    00017 /*  other materials provided with the distribution.                                   */
    00018 /*                                                                                    */
    00019 /*  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND   */
    00020 /*  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED     */
    00021 /*  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE            */
    00022 /*  DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR  */
    00023 /*  ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES    */
    00024 /*  (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;      */
    00025 /*  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON    */
    00026 /*  ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT           */
    00027 /*  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS     */
    00028 /*  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.                      */
    00029 /*                                                                                    */
    00030 /**************************************************************************************/
    00031
    00032 #ifndef Viewport_INCLUDE_ONCE
    00033 #define Viewport_INCLUDE_ONCE
    00034
    00035 #include <vlCore/Object.hpp>
    00036 #include <vlCore/Rect.hpp>
    00037 #include <vlCore/Vector4.hpp>
    00038 #include <vlCore/vlnamespace.hpp>
    00039 #include <vlGraphics/link_config.hpp>
    00040
    00041 namespace vl
    00042 {
    00043   //-----------------------------------------------------------------------------
    00044   // Viewport
    00045   //-----------------------------------------------------------------------------
    00051   class VLGRAPHICS_EXPORT Viewport: public Object
    00052   {
    00053     VL_INSTRUMENT_CLASS(vl::Viewport, Object)
    00054
    00055   public:
    00056     Viewport();
    00057     Viewport(int x, int y, int w, int h);
    00058
    00059     void activate() const;
    00060
    00061     bool null() { return mWidth == 0 || mHeight == 0; }
    00062
    00063     void set(int x, int y, int w, int h) { mX = x; mY = y; mWidth = w; mHeight = h; }
    00064     void setX(int x) { mX = x; }
    00065     int x() const { return mX; }
    00066     void setY(int y) { mY = y; }
    00067     int y() const { return mY; }
    00068     void setWidth(int width) { mWidth = width; }
    00069     int width() const { return mWidth; }
    00070     void setHeight(int height) { mHeight = height; }
    00071     int height() const { return mHeight; }
    00072     fvec2 center() const { return fvec2(mX + mWidth / 2.0f, mY + mHeight / 2.0f); }
    00073
    00077     RectI rect() const { return RectI(x(),y(),width(),height()); }
    00078
    00079     void setClearColor(float r, float g, float b, float a) { mClearColor = fvec4(r,g,b,a); }
    00080     void setClearColor(const fvec4& color) { mClearColor = color; }
    00081     const fvec4& clearColor() const { return mClearColor; }
    00082
    00083     void setClearColorInt(int r, int g, int b, int a) { mClearColorInt = ivec4(r,g,b,a); }
    00084     void setClearColorInt(const ivec4& color) { mClearColorInt = color; }
    00085     const ivec4& clearColorInt() const { return mClearColorInt; }
    00086
    00087     void setClearColorUInt(unsigned int r, unsigned int g, unsigned int b, unsigned int a) { mClearColorUInt = uvec4(r,g,b,a); }
    00088     void setClearColorUInt(const uvec4& color) { mClearColorUInt = color; }
    00089     const uvec4& clearColorUInt() const { return mClearColorUInt; }
    00090
    00091     void setClearStencil(int stencil) { mClearStencil = stencil; }
    00092     int clearStencil() const { return mClearStencil; }
    00093
    00094     void setClearDepth(real depth) { mClearDepth = depth; }
    00095     real clearDepth() const { return mClearDepth; }
    00096
    00098     void setClearFlags(EClearFlags clear_flags) { mClearFlags = clear_flags; }
    00099     EClearFlags clearFlags() const { return mClearFlags; }
    00100
    00101     void setClearColorMode(EClearColorMode mode) { mClearColorMode = mode; }
    00102     EClearColorMode clearColorMode() const { return mClearColorMode; }
    00103
    00107     bool isPointInside(int x, int y, int framebuffer_height) const;
    00108
    00109   protected:
    00110     fvec4 mClearColor;
    00111     ivec4 mClearColorInt;
    00112     uvec4 mClearColorUInt;
    00113
    00114     real mClearDepth;
    00115     int mClearStencil;
    00116     EClearFlags mClearFlags;
    00117     EClearColorMode mClearColorMode;
    00118     int mX;
    00119     int mY;
    00120     int mWidth;
    00121     int mHeight;
    00122   };
    00123 }
    00124
    00125 #endif

Visualization Library v2011.09.1162 Reference Documentation
Copyright 2005-2011 Michele Bosi. All rights reserved.
Updated on Thu Jan 26 2012 00:43:45.
Permission is granted to use this page to write and publish articles regarding Visualization Library.