Skybox.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------------
Copyright (c) 2019, NDEVR LLC
tyler.parke@ndevr.org
  __    __   ____     _____ __     __  _______
 |  \  |  | |  __ \  |  ___|\ \   / / |   __  \
 |   \ |  | | |  \ \ | |___  \ \ / /  |  |__)  |
 |  . \|  | | |__/ / | |___   \ V /   |   _   /
 |  |\    |_|_____/__|_____|___\_/____|  | \  \
 |__| \__________________________________|  \__\
 
Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants 
Licensee a limited, non-exclusive, non-transferable, royalty-free license 
(without the right to sublicense) to use the API solely for the purpose of 
Licensee's internal development efforts to develop applications for which 
the API was provided.
 
The above copyright notice and this permission notice shall be included in all 
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
 
Library: Design
File: Skybox
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include <NDEVR/Model.h>
#if NDEVR_VIEWPORT
namespace NDEVR
{
    /**--------------------------------------------------------------------------------------------------
    \brief Contains a 3D box used to render complicated backgrounds for a CameraBackground object.
    *-----------------------------------------------------------------------------------------------**/
    class NDEVR_DESIGN_API Skybox : public Model
    {
    public:
        static Buffer<Triangle<3, fltp04>> getCube();
        static Buffer<Triangle<3, fltp04>> getPlane();
    public:
        Skybox(const Model& model)
            : Model(model)
            , m_grid_visible(false)
        {}
 
        void hideGrid();
        void setToColor(const RGBColor& color);
        void setToGradient(const RGBColor& top_a, const RGBColor& top_b, const RGBColor& bottom_a, const RGBColor& bottom_b);
        void setToGradient(const RGBColor& top, const RGBColor& bottom);
        void setToSky();
        void showGrid(fltp08 grid_spacing, fltp04 thickness);
        void setupSkybox();
        bool gridVisible() { return m_grid_visible; }
    protected:
        bool m_grid_visible;
    };
}
#endif