1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
3 // File: PlaneGCSSolver_Builder.h
4 // Created: 14 Dec 2015
5 // Author: Artem ZHIDKOV
7 #ifndef PlaneGCSSolver_Builder_H_
8 #define PlaneGCSSolver_Builder_H_
10 #include <PlaneGCSSolver_Defs.h>
12 #include <SketchSolver_Builder.h>
13 #include <SketchSolver_Constraint.h>
15 #include <SketchPlugin_Constraint.h>
17 #include <ModelAPI_CompositeFeature.h>
19 /** \class PlaneGCSSolver_Builder
21 * \brief Create bridges between SketchPlugin constraints and PlaneGCS constraints
23 class PlaneGCSSolver_Builder : public SketchSolver_Builder
26 /// Default constructor
27 PlaneGCSSolver_Builder() {}
30 /// \brief Returns single instance of builder
31 static BuilderPtr getInstance();
33 /// \brief Creates a storage specific for used solver
34 virtual StoragePtr createStorage(const GroupID& theGroup) const;
35 /// \brief Creates specific solver
36 virtual SolverPtr createSolver() const;
38 /// \brief Creates new constraint(s) using given parameters
39 /// \param theConstraint [in] original constraint
40 /// \param theGroupID [in] group the constraint belongs to
41 /// \param theSketchID [in] sketch the constraint belongs to
42 /// \param theType [in] type of constraint
43 /// \param theValue [in] numeric characteristic of constraint (e.g. distance or radius) if applicable
44 /// \param theEntity1 [in] first attribute of constraint
45 /// \param theEntity2 [in] second attribute of constraint
46 /// \param theEntity3 [in] third attribute of constraint
47 /// \param theEntity4 [in] fourth attribute of constraint
48 /// \return Created list of wrappers of constraints applicable for specific solver.
49 /// Most of constraint types lead to single constraint, but there are some kind of
50 /// constraints (e.g. mirror), which may produce couple of constraints.
51 virtual std::list<ConstraintWrapperPtr>
52 createConstraint(ConstraintPtr theConstraint,
53 const GroupID& theGroupID,
54 const EntityID& theSketchID,
55 const SketchSolver_ConstraintType& theType,
56 const double& theValue,
57 const EntityWrapperPtr& theEntity1,
58 const EntityWrapperPtr& theEntity2 = EntityWrapperPtr(),
59 const EntityWrapperPtr& theEntity3 = EntityWrapperPtr(),
60 const EntityWrapperPtr& theEntity4 = EntityWrapperPtr()) const;
62 /// \brief Creates new multi-translation or multi-rotation constraint
63 /// \param theConstraint [in] original constraint
64 /// \param theGroupID [in] group the constraint belongs to
65 /// \param theSketchID [in] sketch the constraint belongs to
66 /// \param theType [in] type of constraint
67 /// \param theValue [in] numeric characteristic of constraint (angle for multi-rotation) if applicable
68 /// \param thePoint1 [in] center for multi-rotation or start point for multi-translation
69 /// \param thePoint2 [in] end point for multi-translation (empty for multi-rotation)
70 /// \param theTrsfEnt [in] list of transformed entities
71 virtual std::list<ConstraintWrapperPtr>
72 createConstraint(ConstraintPtr theConstraint,
73 const GroupID& theGroupID,
74 const EntityID& theSketchID,
75 const SketchSolver_ConstraintType& theType,
76 const double& theValue,
77 const EntityWrapperPtr& thePoint1,
78 const EntityWrapperPtr& thePoint2,
79 const std::list<EntityWrapperPtr>& theTrsfEnt) const;
81 /// \brief Update flags for several kinds of constraints
82 virtual void adjustConstraint(ConstraintWrapperPtr theConstraint) const;
84 /// \brief Creates a feature using list of already created attributes
85 /// \param theFeature [in] feature to create
86 /// \param theAttributes [in] attributes of the feature
87 /// \param theGroupID [in] group the feature belongs to
88 /// \param theSketchID [in] sketch the feature belongs to
89 /// \return Created wrapper of the feature applicable for specific solver
90 virtual EntityWrapperPtr createFeature(FeaturePtr theFeature,
91 const std::list<EntityWrapperPtr>& theAttributes,
92 const GroupID& theGroupID,
93 const EntityID& theSketchID = EID_UNKNOWN) const;
95 /// \brief Creates an attribute
96 /// \param theAttribute [in] attribute to create
97 /// \param theGroup [in] group the attribute belongs to
98 /// \param theSketchID [in] sketch the attribute belongs to
99 /// \return Created wrapper of the attribute applicable for specific solver
100 virtual EntityWrapperPtr createAttribute(AttributePtr theAttribute,
101 const GroupID& theGroup,
102 const EntityID& theSketchID = EID_UNKNOWN) const;
104 /// \brief Create a parameter
105 /// \param theGroupID [in] group the parameter belongs to
106 /// \param theValue [in] value of the parameter
107 /// \return Created wrapper for parameter
108 ParameterWrapperPtr createParameter(const GroupID& theGroupID, double theValue = 0.0) const;
111 /// \brief Create necessary constraints to make two object symmetric relatively a given line
112 std::list<ConstraintWrapperPtr> createMirror(ConstraintPtr theConstraint,
113 const GroupID& theGroupID,
114 const EntityID& theSketchID,
115 const EntityWrapperPtr& theEntity1,
116 const EntityWrapperPtr& theEntity2,
117 const EntityWrapperPtr& theMirrorLine) const;
119 /// \brief Converts sketch parameters to the entity applicable for the solver.
120 /// \param theSketch [in] the element to be converted
121 /// \param theGroupID [in] group where the sketch should be created
122 /// \return Entity respective the sketch or empty pointer, it the sketch has incorrect attributes
123 EntityWrapperPtr createSketchEntity(CompositeFeaturePtr theSketch,
124 const GroupID& theGroupID) const;
126 //// /// \brief Converts two axes of sketch's trihedron to the normal entity
127 //// /// \param theNormal [in] direction of the normal of the sketch
128 //// /// \param theDirX [in] direction of the X axis of the sketch
129 //// /// \param theGroupID [in] group, the normal belongs to
130 //// /// \return Created entity or empty pointer, if there are incorrect attributes
131 //// EntityWrapperPtr createNormal(AttributePtr theNormal,
132 //// AttributePtr theDirX,
133 //// const GroupID& theGroupID) const;
136 static BuilderPtr mySelf;