lib3mf/Include/Model/Classes/NMR_ModelImplicitNode.h

/*++

Copyright (C) 2023 3MF Consortium

All rights reserved.

Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

--*/

#pragma once

#include <Common/Platform/NMR_SAL.h>
#include <Model/Classes/NMR_ModelImplicitPort.h>
#include <Model/Classes/NMR_ModelMeshObject.h>
#include <Model/Classes/NMR_ModelTypes.h>
#include <Model/Classes/NMR_ModelResource.h>
#include <lib3mf_types.hpp>

#include <memory>
#include <string>
#include <vector>

namespace NMR
{
    class CModelImplicitFunction;

    using GraphID = unsigned int;
    using TopologicalOrderIndex = unsigned int;
    class CModelImplicitNode
    {
      private:
        Lib3MF::eImplicitNodeType m_type;
        ImplicitIdentifier m_identifier;
        std::string m_displayname;
        std::string m_tag;
        
        PPorts m_inputs;
        PPorts m_outputs;

        // Optional values for constants
        double m_constant = 0.;
        std::unique_ptr<Lib3MF::sVector> m_vector;
        std::unique_ptr<Lib3MF::sMatrix4x4> m_matrix;

        // resource ID that is unique in the scope of a model to reference mesh objects, functions etc.
        ModelResourceID m_modelResourceID;
        
        // Attributes specific to new nodes
        double m_accurateRange = 0.0;  // For BeamLatticeNode
        std::string m_scalarOutputName;  // For FunctionGradient and NormalizeDistance
        std::string m_vectorInputName;   // For FunctionGradient and NormalizeDistance
        
        CModelImplicitFunction * m_parent = nullptr;

        // ID of the node in the graph, used for the topological sort
        GraphID m_graphId = 0;
        TopologicalOrderIndex m_topologicalOrderIndex = 0;

      public:
        CModelImplicitNode(Lib3MF::eImplicitNodeType type,
                           ImplicitIdentifier const & identifier,
                           std::string const & displayname,
                           std::string const & tag,
                           CModelImplicitFunction * parent);
        CModelImplicitNode(Lib3MF::eImplicitNodeType type, CModelImplicitFunction * parent);

        ImplicitIdentifier const & getIdentifier() const;
        std::string const & getDisplayName() const;
        std::string const& getTag() const;
        void setIdentifier(ImplicitIdentifier const & identifier);
        void setDisplayName(std::string const & displayname);
        void setTag(std::string const& tag);

        void setType(Lib3MF::eImplicitNodeType type);
        Lib3MF::eImplicitNodeType getNodeType() const;

        PModelImplicitPort addInput(const std::string & sIdentifier,
                                    const std::string & sDisplayName);

        PModelImplicitPort addOutput(const std::string & sIdentifier,
                                     const std::string & sDisplayName);

        PPorts getInputs() const;
        PPorts getOutputs() const;

        PModelImplicitPort findInput(const std::string & sIdentifier) const;
        PModelImplicitPort findOutput(const std::string & sIdentifier) const;

        void setConstant(double value);
        double getConstant() const;

        void setVector(const Lib3MF::sVector & value);  
        Lib3MF::sVector getVector() const;


        void setMatrix(const Lib3MF::sMatrix4x4 & value);
        Lib3MF::sMatrix4x4 getMatrix() const;

        void setModelResourceID(ModelResourceID resourceID);
        ModelResourceID getModelResourceID() const;
        PModelResource getResource() const;

        // BeamLatticeNode attribute
        void setAccurateRange(double accurateRange);
        double getAccurateRange() const;

        // FunctionGradient and NormalizeDistance attributes
        void setScalarOutputName(const std::string& name);
        std::string getScalarOutputName() const;
        void setVectorInputName(const std::string& name);
        std::string getVectorInputName() const;

        bool arePortsValid() const;

        void setGraphID(GraphID id);
        GraphID getGraphID() const;
        CModelImplicitFunction * getParent() const;
        void setParent(CModelImplicitFunction * parent);
    };

    using PModelImplicitNode = std::shared_ptr<CModelImplicitNode>;
}