1 // Copyright (C) 2014-2017 CEA/DEN, EDF R&D
3 // This library is free software; you can redistribute it and/or
4 // modify it under the terms of the GNU Lesser General Public
5 // License as published by the Free Software Foundation; either
6 // version 2.1 of the License, or (at your option) any later version.
8 // This library is distributed in the hope that it will be useful,
9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 // Lesser General Public License for more details.
13 // You should have received a copy of the GNU Lesser General Public
14 // License along with this library; if not, write to the Free Software
15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 // See http://www.salome-platform.org/ or
18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
21 #ifndef ModelAPI_ResultConstruction_H_
22 #define ModelAPI_ResultConstruction_H_
24 #include "ModelAPI_Result.h"
25 #include <GeomAPI_Shape.h>
26 #include <GeomAPI_Face.h>
30 /**\class ModelAPI_ResultConstruction
32 * \brief The construction element result of a feature.
34 * Provides a shape that may be displayed in the viewer.
35 * Intermediate, light result that in many cases produces a result on the fly.
37 class ModelAPI_ResultConstruction : public ModelAPI_Result
40 /// Returns the group identifier of this result
41 MODELAPI_EXPORT virtual std::string groupName();
43 /// Returns the group identifier of this result
44 inline static std::string group()
46 static std::string MY_GROUP = "Construction";
50 /// default color for a result construction
51 inline static const std::string& DEFAULT_COLOR()
53 static const std::string RESULT_CONSTRUCTION_COLOR("120,120,120");
54 return RESULT_CONSTRUCTION_COLOR;
57 /// default deflection for a result construction
58 inline static const std::string DEFAULT_DEFLECTION()
64 virtual void setShape(std::shared_ptr<GeomAPI_Shape> theShape) = 0;
66 /// Updates the shape taking the current value from the data structure, returns true
67 /// if update has been correctly done
68 virtual bool updateShape() = 0;
70 /// Sets the flag that it must be displayed in history (default is true)
71 virtual void setIsInHistory(const bool isInHistory) = 0;
73 /// if the construction result may be used as faces, this method returns not zero number of faces
74 /// \param theUpdateNaming is false of keeping the naming structure untouched (on load)
75 virtual int facesNum(const bool theUpdateNaming = true) = 0;
76 /// if the construction result may be used as faces, this method returns face by zero based index
77 virtual std::shared_ptr<GeomAPI_Face> face(const int theIndex) = 0;
79 /// By default object is not infinite.
80 virtual bool isInfinite() = 0;
81 /// Sets the flag that it is infinite
82 virtual void setInfinite(const bool theInfinite) = 0;
85 //! Pointer on feature object
86 typedef std::shared_ptr<ModelAPI_ResultConstruction> ResultConstructionPtr;