Project.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: Project
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include <NDEVR/Model.h>
namespace NDEVR
{
    /**--------------------------------------------------------------------------------------------------
    \brief A Model which represents a user-project. A project is a series of Scenes grouped together within
        a software session. Typically there will only ever be one project in a software session.
    *-----------------------------------------------------------------------------------------------**/
    class NDEVR_DESIGN_API Project : public Scene
    {
    public:
        Project();
        Project(const TranslatedString& name);
        Project(const Model& model);
        void setup();
        void setIsTemp(bool is_temp);
        bool isTemp() const;
        void setToDefaultPath();
        void setToTempDefaultPath();
        UUID projectionID() const;
        void setProjectionID(UUID id);
        Angle<fltp08> magneticDeclination() const;
        void setMagneticDeclination(const Angle<fltp08>& angle);
        File defaultFile();
        File defaultTempFile();
        File currentProjectFile();
        void setProjectName(const String& name);
        bool hasBeenSaved() const;
        static String TempIdentifier();
        static File DefaultFolder();
        static File DefaultTempFolder();
        static constexpr const char* TypeName() {return "project"; }
    protected:
        
    };
    
}