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 email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
20 #ifndef ModelAPI_ResultConstruction_H_
21 #define ModelAPI_ResultConstruction_H_
23 #include "ModelAPI_Result.h"
24 #include <GeomAPI_Shape.h>
25 #include <GeomAPI_Face.h>
29 /**\class ModelAPI_ResultConstruction
31 * \brief The construction element result of a feature.
33 * Provides a shape that may be displayed in the viewer.
34 * Intermediate, light result that in many cases produces a result on the fly.
36 class ModelAPI_ResultConstruction : public ModelAPI_Result
39 /// Returns the group identifier of this result
40 MODELAPI_EXPORT virtual std::string groupName();
42 /// Returns the group identifier of this result
43 inline static std::string group()
45 static std::string MY_GROUP = "Construction";
49 /// default color for a result construction
50 inline static const std::string& DEFAULT_COLOR()
52 static const std::string RESULT_CONSTRUCTION_COLOR("120,120,120");
53 return RESULT_CONSTRUCTION_COLOR;
56 /// default deflection for a result construction
57 inline static const std::string DEFAULT_DEFLECTION()
63 virtual void setShape(std::shared_ptr<GeomAPI_Shape> theShape) = 0;
65 /// Sets the flag that it must be displayed in history (default is true)
66 virtual void setIsInHistory(const bool isInHistory) = 0;
68 /// if the construction result may be used as faces, this method returns not zero number of faces
69 virtual int facesNum() = 0;
70 /// if the construction result may be used as faces, this method returns face by zero based index
71 virtual std::shared_ptr<GeomAPI_Face> face(const int theIndex) = 0;
73 /// By default object is not infinite.
74 virtual bool isInfinite() = 0;
75 /// Sets the flag that it is infinite
76 virtual void setInfinite(const bool theInfinite) = 0;
79 //! Pointer on feature object
80 typedef std::shared_ptr<ModelAPI_ResultConstruction> ResultConstructionPtr;