RockWorksFactory.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: E57Factory
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include <NDEVR/IOFactory.h>
#include <NDEVR/FileFormat.h>
#include <NDEVR/BaseValues.h>
#include <NDEVR/Buffer.h>
namespace NDEVR
{
    /**--------------------------------------------------------------------------------------------------
    \brief Setup parameters for RockWorks.
    Used to setup types of solid making algorithms used by RockWorks
    **/
    struct RockWorksSetup
    {
        enum SolidAlgorithm
        {
              e_closest_point = 12
            , e_distance_to_point = 4
            , e_isotrophic = 9
            , e_anisotrophic = 10
        };
        RockWorksSetup()
        {}
        SolidAlgorithm soliding_algorithm = SolidAlgorithm::e_anisotrophic;
        File rcl_file;
        File rockwell_project_folder;
        File mod_file;
        File import_file;
        File slicer_out;
        uint04 horizontal_density = Constant<uint04>::Invalid;
        uint04 vertical_density = Constant<uint04>::Invalid;
        bool show_statistics = false;
        bool close_when_finished = true;
    };
    /**--------------------------------------------------------------------------------------------------
    \brief Stores cell information for Rockworks Block Models
    Used to setup types of solid making algorithms used by RockWorks
    **/
    struct RockworksSolidModInfo
    {
        File file;
        Bounds<3, fltp08> bounds;
        Vector<3, fltp08> cell_size;
        Vector<3, uint04> cell_count;
        Buffer<fltp08> values;
        fltp08 multiplier = 1.0;
        ConstPointer<Unit> unit;
    };
    /**--------------------------------------------------------------------------------------------------
    \brief Simple in and out files used for Slicer
    Used with slicer IO operations.
    **/
    struct SlicerOutputOptions
    {
        File gm_file;
        File out_file;
        bool ascii = true;
    };
    /**--------------------------------------------------------------------------------------------------
    \brief writes and reads a Rockworks file
    Adds support for reading and writing BlockModel enteties to RockWorks.
    **/
    class NDEVR_FACTORY_API RockWorksFactory final : public IOFactory
    {
    public:
        RockWorksFactory();
        static RockworksSolidModInfo ReadSolidModFile(File file); 
        static void WriteGenerateSolidScript(const RockWorksSetup& setup);
        static void OutputForSlicerDicer(const SlicerOutputOptions& setup, const RockworksSolidModInfo& info);
        static void UpdateModel(Model& model, const RockworksSolidModInfo& info);
        FactoryFeatures factoryFeatures(const FactoryParameters& file, bool is_import) const override;
    private:
        void getSupportedFormats(Buffer<FileFormat>& formats, bool is_read) override;
        Buffer<UUID> filterModelsToExport(Buffer<UUID> models_to_check, const DesignObjectLookup* lookup, const FileFormat& export_format) const override;
        bool readFile(FactoryParameters& file) override;
        bool writeFile(FactoryParameters& file) override;
        static String CreateDescription(const RockworksSolidModInfo& info);
 
    };
};