X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModelAPI%2FModelAPI_ResultConstruction.h;h=c16dce30564f3453e4229eae4cf5c8640c9e1814;hb=a4a0d955055f7d26fda227ad47211eaaef645cc7;hp=3c12f482c42dbd2ba5cbfba43dc9d2f690158d1f;hpb=82f94d044ced40be786427ddee839e3c263fe277;p=modules%2Fshaper.git diff --git a/src/ModelAPI/ModelAPI_ResultConstruction.h b/src/ModelAPI/ModelAPI_ResultConstruction.h index 3c12f482c..c16dce305 100644 --- a/src/ModelAPI/ModelAPI_ResultConstruction.h +++ b/src/ModelAPI/ModelAPI_ResultConstruction.h @@ -1,12 +1,30 @@ -// File: ModelAPI_ResultConstruction.h -// Created: 07 Jul 2014 -// Author: Mikhail PONIKAROV +// Copyright (C) 2014-2024 CEA, EDF +// +// This library is free software; you can redistribute it and/or +// modify it under the terms of the GNU Lesser General Public +// License as published by the Free Software Foundation; either +// version 2.1 of the License, or (at your option) any later version. +// +// This library is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +// Lesser General Public License for more details. +// +// You should have received a copy of the GNU Lesser General Public +// License along with this library; if not, write to the Free Software +// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +// +// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com +// -#ifndef ModelAPI_ResultConstruction_HeaderFile -#define ModelAPI_ResultConstruction_HeaderFile +#ifndef ModelAPI_ResultConstruction_H_ +#define ModelAPI_ResultConstruction_H_ #include "ModelAPI_Result.h" #include +#include + +#include /**\class ModelAPI_ResultConstruction * \ingroup DataModel @@ -17,19 +35,62 @@ */ class ModelAPI_ResultConstruction : public ModelAPI_Result { -public: + public: + /// Returns the group identifier of this result + MODELAPI_EXPORT virtual std::string groupName(); + /// Returns the group identifier of this result - virtual std::string group() - {static std::string MY_GROUP = "Construction"; return MY_GROUP;} + inline static std::string group() + { + static std::string MY_GROUP = "Construction"; + return MY_GROUP; + } + + /// default color for a result construction + inline static const std::string& DEFAULT_COLOR() + { + static const std::string RESULT_CONSTRUCTION_COLOR("120,120,120"); + return RESULT_CONSTRUCTION_COLOR; + } + + /// default color for a result construction + inline static const std::string& RESULT_COLOR_NAME() + { + static const std::string COLOR_NAME("result_construction_color"); + return COLOR_NAME; + } - /// Returns the shape-result produced by this feature - virtual boost::shared_ptr& shape() = 0; + /// default deflection for a result construction + inline static const std::string DEFAULT_DEFLECTION() + { + return "0.00001"; + } /// Sets the result - virtual void setShape(boost::shared_ptr theShape) = 0; + virtual void setShape(std::shared_ptr theShape) = 0; + + /// Updates the shape taking the current value from the data structure, returns true + /// if update has been correctly done + virtual bool updateShape() = 0; + + /// Sets the flag that it must be displayed in history (default is true) + virtual void setIsInHistory(const bool isInHistory) = 0; + + /// if the construction result may be used as faces, this method returns not zero number of faces + /// \param theUpdateNaming is false of keeping the naming structure untouched (on load) + virtual int facesNum(const bool theUpdateNaming = true) = 0; + /// if the construction result may be used as faces, this method returns face by zero based index + virtual std::shared_ptr face(const int theIndex) = 0; + /// Change the order of faces + virtual void setFacesOrder(const std::list >& theFaces) = 0; + + /// By default object is not infinite. + virtual bool isInfinite() = 0; + /// Sets the flag that it is infinite + virtual void setInfinite(const bool theInfinite) = 0; }; //! Pointer on feature object -typedef boost::shared_ptr ResultConstructionPtr; +typedef std::shared_ptr ResultConstructionPtr; #endif