FactoryOptions.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: IOFactory
File: FactoryOptions
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "DLLInfo.h"
#include <NDEVR/DesignObjectBase.h>
#include <NDEVR/AsciiOptions.h>
 
#include <NDEVR/INIInterface.h>
#include <NDEVR/UnitManager.h>
#include <NDEVR/GenericOption.h>
#include <NDEVR/ApplicationOptions.h>
namespace NDEVR
{
    class Model;
    class Material;
    /**--------------------------------------------------------------------------------------------------
    \brief User-defined options that define preferences for importing and exporting using IOFactory objects
    *-----------------------------------------------------------------------------------------------**/
    class NDEVR_FACTORY_API FactoryOptions : public INIInterface
    {
    public:
        FactoryOptions();
        ~FactoryOptions();
        enum NormalGenerationModel
        {
              e_flat
            , e_smooth
        };
        
        enum class IncludeProperties : uint01
        {
              e_ignore                     = 0 //Ignores the field even if it exists
            , e_include_default_precision  = 1 //Includes the field if it exists, but ignores it otherwise : May reduce precision of include
            , e_include_high_precision     = 2 //Includes the field if it exists, but ignores it otherwise : Will not reduce precision of include
            , e_generate_default_precision = 3 //generates the field, if possible
            , e_generate_high_precision    = 4 //generates the field, if possible
            , e_not_supported
        };
 
        enum class ImportMergeProperties
        {
              e_duplicate//Will always import, creating duplicates if they exist
            , e_ignore_import//ignores any duplicate data from file
            , e_replace//replaces any duplicate data with file data
            , e_remap_imported//will remap (ie: rename, change value etc) any imported data
            , e_merge_and_replace_from_file//merges data when possible, then replaces data otherwise
            , e_merge_and_ignore_from_file//merges data when possible, then ignores_otherwise
        };
        enum class GeoReferenceProperties
        {
              e_data_geo_referenced
            , e_user_place_with_cursor
            , e_user_geo_reference_dialog
            , e_prompt_user_all
            , e_prompt_user_no_existing_reference
        };
 
        void prepareForINI(INIFactory& factory) override;
        virtual void getINI(INIFactory& factory) override;
        void finishReadingINI(INIFactory& factory) override;
        void setToDefaultUnits();
        bool useHighPrecision(VertexProperty property) const;
        bool useValue(VertexProperty property) const
        {
            return (vector_properties[cast<uint01>(property)] != IncludeProperties::e_ignore);
        }
        bool generateValue(VertexProperty property) const
        {
            return (vector_properties[cast<uint01>(property)] >= IncludeProperties::e_generate_default_precision);
        }
 
        bool useHighPrecision(GeometryType property) const;
        bool useValue(GeometryType property) const
        {
            if (property >= GeometryType::e_geometry_type_size)
                return false;
            return (geometry_properties[cast<uint01>(property)] != IncludeProperties::e_ignore);
        }
        bool generateValue(GeometryType property) const;
        
        bool operator==(const FactoryOptions& options) const;
        bool operator!=(const FactoryOptions& options) const
        {
            return !(*this == options);
        }
        void setupDefaultMaterial(GeometryType type, Material& mat) const;
        void postProcess(Model& model, ProgressInfo* progress, const void* lock) const;
    protected:
        bool canPostProcessVertices() const;
    public:
        AsciiOptions ascii;
        Buffer<String> exclusion_model_types = {
              "scanner"
            , "bounding_box"
            , "grips_model"
            , "camera"
            , "boretrak_model"
            , "deployment_models"
            , "calibration_ring"
            , "text"
            , "void_scanner"
            , "cals_scanner"
            , "qt_bounding_box"
            , "station_decoration"
            , "image_model"
        };
        Dictionary<String, GenericOptionGroup> custom_options;
        Matrix<fltp08> transform;
        String name;
        String icon;
        String user_password;
        String owner_password;
        UnitManager units;
        NormalGenerationModel normal_generation_mode = e_smooth;
        Angle<fltp08> normal_smooth_angle = Angle<fltp08>(DEGREES, 30.0);
        WindingMode wind_triangles = WindingMode::e_no_winding;
        RGBColor default_color;
        UUID default_coord_projection = Constant<UUID>::Invalid;
        fltp04 default_point_size = 20.0;
        fltp04 default_line_thickness = 1.0;
        fltp04 default_mesh_thickness = 1.0;
        CompressionMode compression_mode = CompressionMode::e_default_compression;
        ImportMergeProperties duplicate_name_behavior;
        ImportMergeProperties duplicate_uuid_behavior;
        GeoReferenceProperties geo_reference_behavior;
        bool flatten_model = false;
        bool center_model = false;
        bool multithread = true;
        bool tree_is_visible = true;
        bool application_locked = false;
        bool convert_degenerates = false;
        bool optimize_meshes = false;
        bool combine_mesh_instances = false;
        bool optimize_model_heirarchy = false;
        bool find_invalid_data = false;
        bool join_identical_vertices = false;
        bool fix_inward_normals = false;
        bool generate_UV_mappings = false;
        bool generate_trees = true;
        bool flip_UV_coordinates = false;
        bool ignore_invisible = false;
        bool two_sided = false;
        bool wireframe = false;
        bool triangulate = false;
        bool validitate_geometry = false;
        bool preserve_high_precision_values = false;
        bool use_cameras = true;
        bool is_auto_save = false;
        Vector<cast<uint01>(VertexProperty::Vertex_Property_Size), IncludeProperties> vector_properties;
        Vector<cast<uint01>(GeometryType::e_geometry_type_size), IncludeProperties> geometry_properties;
        static ApplicationOption<bool> DefaultExportOnlyVisible;
    private:
        String m_selected_ascii_options_all;//Used for ini
    };
    NDEVR_FACTORY_T_API template class NDEVR_FACTORY_API StringStream<FactoryOptions::NormalGenerationModel>;
    NDEVR_FACTORY_T_API template class NDEVR_FACTORY_API StringStream<FactoryOptions::IncludeProperties>;
}