/
SketchObject.h
709 lines (601 loc) · 35.2 KB
/
SketchObject.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
/***************************************************************************
* Copyright (c) 2008 Jürgen Riegel <juergen.riegel@web.de> *
* *
* This file is part of the FreeCAD CAx development system. *
* *
* This library is free software; you can redistribute it and/or *
* modify it under the terms of the GNU Library General Public *
* License as published by the Free Software Foundation; either *
* version 2 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 Library General Public License for more details. *
* *
* You should have received a copy of the GNU Library General Public *
* License along with this library; see the file COPYING.LIB. If not, *
* write to the Free Software Foundation, Inc., 59 Temple Place, *
* Suite 330, Boston, MA 02111-1307, USA *
* *
***************************************************************************/
#ifndef SKETCHER_SKETCHOBJECT_H
#define SKETCHER_SKETCHOBJECT_H
#include <App/PropertyStandard.h>
#include <App/PropertyFile.h>
#include <App/FeaturePython.h>
#include <Base/Axis.h>
#include <Mod/Part/App/Part2DObject.h>
#include <Mod/Part/App/PropertyGeometryList.h>
#include <Mod/Sketcher/App/PropertyConstraintList.h>
#include <Mod/Sketcher/App/SketchAnalysis.h>
#include "GeometryFacade.h"
#include "Analyse.h"
#include "Sketch.h"
#include "SketchGeometryExtension.h"
namespace Sketcher
{
struct SketcherExport GeoEnum
{
static const int RtPnt;
static const int HAxis;
static const int VAxis;
static const int RefExt;
};
class SketchAnalysis;
class SketcherExport SketchObject : public Part::Part2DObject
{
PROPERTY_HEADER_WITH_OVERRIDE(Sketcher::SketchObject);
public:
SketchObject();
~SketchObject();
/// Property
/**
The Geometry list contains the non-external Part::Geometry objects in the sketch. The list
may be accessed directly, or indirectly via getInternalGeometry().
Many of the methods in this class take geoId and posId parameters. A GeoId is a unique identifier for
geometry in the Sketch. geoId >= 0 means an index in the Geometry list. geoId < 0 refers to sketch
axes and external geometry. posId is a PointPos enum, documented in Constraint.h.
*/
Part ::PropertyGeometryList Geometry;
Sketcher::PropertyConstraintList Constraints;
App ::PropertyLinkSubList ExternalGeometry;
App ::PropertyBool FullyConstrained;
/** @name methods override Feature */
//@{
short mustExecute() const override;
/// recalculate the Feature (if no recompute is needed see also solve() and solverNeedsUpdate boolean)
App::DocumentObjectExecReturn *execute(void) override;
/// returns the type name of the ViewProvider
const char* getViewProviderName(void) const override {
return "SketcherGui::ViewProviderSketch";
}
//@}
/** SketchObject can work in two modes: Recompute Mode and noRecomputes Mode
- In Recompute Mode, a recompute is necessary after each geometry addition to update the solver DoF (default)
- In NoRecomputes Mode, no recompute is necessary after a geometry addition. If a recompute is triggered
it is just less efficient.
This flag does not regulate whether this object will recompute or not if execute() or a recompute() is actually executed,
it just regulates whether the solver is called or not (i.e. whether it relies on
the solve of execute for the calculation)
*/
bool noRecomputes;
/*!
\brief Returns true if the sketcher supports the given geometry
\param geo - the geometry
\retval bool - true if the geometry is supported
*/
bool isSupportedGeometry(const Part::Geometry *geo) const;
/*!
\brief Add geometry to a sketch
\param geo - geometry to add
\param construction - true for construction lines
\retval int - GeoId of added element
*/
int addGeometry(const Part::Geometry *geo, bool construction=false);
/*!
\brief Add multiple geometry elements to a sketch
\param geoList - geometry to add
\param construction - true for construction lines
\retval int - GeoId of last added element
*/
int addGeometry(const std::vector<Part::Geometry *> &geoList, bool construction=false);
/*!
\brief Deletes indicated geometry (by geoid).
\param GeoId - the geometry to delete
\param deleteinternalgeo - if true deletes the associated and unconstraint internal geometry, otherwise deletes only the GeoId
\retval int - 0 if successful
*/
int delGeometry(int GeoId, bool deleteinternalgeo = true);
/// Deletes just the GeoIds indicated, it does not look for internal geometry
int delGeometriesExclusiveList(const std::vector<int>& GeoIds);
/// Does the same as \a delGeometry but allows to delete several geometries in one step
int delGeometries(const std::vector<int>& GeoIds);
/// deletes all the elements/constraints of the sketch except for external geometry
int deleteAllGeometry();
/// deletes all the constraints of the sketch
int deleteAllConstraints();
/// add all constraints in the list
int addConstraints(const std::vector<Constraint *> &ConstraintList);
/// Copy the constraints instead of cloning them and copying the expressions if any
int addCopyOfConstraints(const SketchObject &orig);
/// add constraint
int addConstraint(const Constraint *constraint);
/// add constraint
int addConstraint(std::unique_ptr<Constraint> constraint);
/// delete constraint
int delConstraint(int ConstrId);
/** deletes a group of constraints at once, if norecomputes is active, the default behaviour is that
* it will solve the sketch.
*
* If updating the Geometry property as a consequence of a (successful) solve() is not wanted, updategeometry=false,
* prevents the update. This allows to update the solve status (e.g. dof), without updating the geometry (i.e. make it
* move to fulfil the constraints).
*/
int delConstraints(std::vector<int> ConstrIds, bool updategeometry=true);
int delConstraintOnPoint(int GeoId, PointPos PosId, bool onlyCoincident=true);
int delConstraintOnPoint(int VertexId, bool onlyCoincident=true);
/// Deletes all constraints referencing an external geometry
int delConstraintsToExternal();
/// transfers all constraints of a point to a new point
int transferConstraints(int fromGeoId, PointPos fromPosId, int toGeoId, PointPos toPosId,
bool tangencyHolds = false);
/// swaps original GeoId for a new one
void swapInvolvedGeometry(Constraint *constraint, int fromGeoId, int toGeoId);
/// Carbon copy another sketch geometry and constraints
int carbonCopy(App::DocumentObject * pObj, bool construction = true);
/// add an external geometry reference
int addExternal(App::DocumentObject *Obj, const char* SubName);
/** delete external
* ExtGeoId >= 0 with 0 corresponding to the first user defined
* external geometry
*/
int delExternal(int ExtGeoId);
/** deletes all external geometry */
int delAllExternal();
/** returns a pointer to a given Geometry index, possible indexes are:
* id>=0 for user defined geometries,
* id==-1 for the horizontal sketch axis,
* id==-2 for the vertical sketch axis
* id<=-3 for user defined projected external geometries,
*/
template < typename GeometryT = Part::Geometry,
typename = typename std::enable_if<
std::is_base_of<Part::Geometry, typename std::decay<GeometryT>::type>::value
>::type
>
const GeometryT * getGeometry(int GeoId) const;
std::unique_ptr<const GeometryFacade> getGeometryFacade(int GeoId) const;
/// returns a list of all internal geometries
const std::vector<Part::Geometry *> &getInternalGeometry(void) const { return Geometry.getValues(); }
/// returns a list of projected external geometries
const std::vector<Part::Geometry *> &getExternalGeometry(void) const { return ExternalGeo; }
/// rebuilds external geometry (projection onto the sketch plane)
void rebuildExternalGeometry(void);
/// returns the number of external Geometry entities
int getExternalGeometryCount(void) const { return ExternalGeo.size(); }
/// retrieves a vector containing both normal and external Geometry (including the sketch axes)
std::vector<Part::Geometry*> getCompleteGeometry(void) const;
/// converts a GeoId index into an index of the CompleteGeometry vector
int getCompleteGeometryIndex(int GeoId) const;
int getGeoIdFromCompleteGeometryIndex(int completeGeometryIndex) const;
/// returns non zero if the sketch contains conflicting constraints
int hasConflicts(void) const;
/**
* sets the geometry of sketchObject as the solvedsketch geometry
* returns the DoF of such a geometry.
*/
int setUpSketch();
/** solves the sketch and updates the geometry, but not all the dependent features (does not recompute)
When a recompute is necessary, recompute triggers execute() which solves the sketch and updates all dependent features
When a solve only is necessary (e.g. DoF changed), solve() solves the sketch and
updates the geometry (if updateGeoAfterSolving==true), but does not trigger any recompute.
@return 0 if no error, if error, the following codes in this order of priority: -4 if overconstrained,
-3 if conflicting, -1 if solver error, -2 if redundant constraints
*/
int solve(bool updateGeoAfterSolving=true);
/// set the datum of a Distance or Angle constraint and solve
int setDatum(int ConstrId, double Datum);
/// set the driving status of this constraint and solve
int setDriving(int ConstrId, bool isdriving);
/// get the driving status of this constraint
int getDriving(int ConstrId, bool &isdriving);
/// toggle the driving status of this constraint
int toggleDriving(int ConstrId);
/// set the driving status of this constraint and solve
int setActive(int ConstrId, bool isactive);
/// get the driving status of this constraint
int getActive(int ConstrId, bool &isactive);
/// toggle the driving status of this constraint
int toggleActive(int ConstrId);
/// Make all dimensionals Driving/non-Driving
int setDatumsDriving(bool isdriving);
/// Move Dimensional constraints at the end of the properties array
int moveDatumsToEnd(void);
/// set the driving status of this constraint and solve
int setVirtualSpace(int ConstrId, bool isinvirtualspace);
/// get the driving status of this constraint
int getVirtualSpace(int ConstrId, bool &isinvirtualspace) const;
/// toggle the driving status of this constraint
int toggleVirtualSpace(int ConstrId);
/// move this point to a new location and solve
int movePoint(int GeoId, PointPos PosId, const Base::Vector3d& toPoint, bool relative=false, bool updateGeoBeforeMoving=false);
/// retrieves the coordinates of a point
Base::Vector3d getPoint(int GeoId, PointPos PosId) const;
/// toggle geometry to draft line
int toggleConstruction(int GeoId);
int setConstruction(int GeoId, bool on);
/*!
\brief Create a sketch fillet from the point at the intersection of two lines
\param geoId, pos - one of the (exactly) two coincident endpoints
\param radius - fillet radius
\param trim - if false, leaves the original lines untouched
\param createCorner - keep geoId/pos as a Point and keep as many constraints as possible
\retval - 0 on success, -1 on failure
*/
int fillet(int geoId, PointPos pos, double radius, bool trim=true, bool preserveCorner=false);
/*!
\brief More general form of fillet
\param geoId1, geoId2 - geoId for two lines (which don't necessarily have to coincide)
\param refPnt1, refPnt2 - reference points on the input geometry, used to influence the free fillet variables
\param radius - fillet radius
\param trim - if false, leaves the original lines untouched
\param preserveCorner - if the lines are coincident, place a Point where they meet and keep as many
of the existing constraints as possible
\retval - 0 on success, -1 on failure
*/
int fillet(int geoId1, int geoId2,
const Base::Vector3d& refPnt1, const Base::Vector3d& refPnt2,
double radius, bool trim=true, bool createCorner=false);
/// trim a curve
int trim(int geoId, const Base::Vector3d& point);
/// extend a curve
int extend(int geoId, double increment, int endPoint);
/// split a curve
int split(int geoId, const Base::Vector3d &point);
/// adds symmetric geometric elements with respect to the refGeoId (line or point)
int addSymmetric(const std::vector<int> &geoIdList, int refGeoId, Sketcher::PointPos refPosId=Sketcher::none);
/// with default parameters adds a copy of the geometric elements displaced by the displacement vector.
/// It creates an array of csize elements in the direction of the displacement vector by rsize elements in the
/// direction perpendicular to the displacement vector, wherein the modulus of this perpendicular vector is scaled by perpscale.
int addCopy(const std::vector<int> &geoIdList, const Base::Vector3d& displacement, bool moveonly = false, bool clone=false, int csize=2, int rsize=1, bool constraindisplacement = false, double perpscale = 1.0);
/// Exposes all internal geometry of an object supporting internal geometry
/*!
* \return -1 on error
*/
int exposeInternalGeometry(int GeoId);
/*!
\brief Deletes all unused (not further constrained) internal geometry
\param GeoId - the geometry having the internal geometry to delete
\param delgeoid - if true in addition to the unused internal geometry also deletes the GeoId geometry
\retval int - returns -1 on error, otherwise the number of deleted elements
*/
int deleteUnusedInternalGeometry(int GeoId, bool delgeoid=false);
/*!
\brief Approximates the given geometry with a B-spline
\param GeoId - the geometry to approximate
\param delgeoid - if true in addition to the unused internal geometry also deletes the GeoId geometry
\retval bool - returns true if the approximation succeeded, or false if it did not succeed.
*/
bool convertToNURBS(int GeoId);
/*!
\brief Increases the degree of a BSpline by degreeincrement, which defaults to 1
\param GeoId - the geometry of type bspline to increase the degree
\param degreeincrement - the increment in number of degrees to effect
\retval bool - returns true if the increase in degree succeeded, or false if it did not succeed.
*/
bool increaseBSplineDegree(int GeoId, int degreeincrement = 1);
/*!
\brief Decreases the degree of a BSpline by degreedecrement, which defaults to 1
\param GeoId - the geometry of type bspline to increase the degree
\param degreedecrement - the decrement in number of degrees to effect
\retval bool - returns true if the decrease in degree succeeded, or false if it did not succeed.
*/
bool decreaseBSplineDegree(int GeoId, int degreedecrement = 1);
/*!
\brief Increases or Decreases the multiplicity of a BSpline knot by the multiplicityincr param, which defaults to 1, if the result is multiplicity zero, the knot is removed
\param GeoId - the geometry of type bspline to increase the degree
\param knotIndex - the index of the knot to modify (note that index is OCC consistent, so 1<=knotindex<=knots)
\param multiplicityincr - the increment (positive value) or decrement (negative value) of multiplicity of the knot
\retval bool - returns true if the operation succeeded, or false if it did not succeed.
*/
bool modifyBSplineKnotMultiplicity(int GeoId, int knotIndex, int multiplicityincr = 1);
/// retrieves for a Vertex number the corresponding GeoId and PosId
void getGeoVertexIndex(int VertexId, int &GeoId, PointPos &PosId) const;
int getHighestVertexIndex(void) const { return VertexId2GeoId.size() - 1; } // Most recently created
int getHighestCurveIndex(void) const { return Geometry.getSize() - 1; }
void rebuildVertexIndex(void);
/// retrieves for a GeoId and PosId the Vertex number
int getVertexIndexGeoPos(int GeoId, PointPos PosId) const;
// retrieves an array of maps, each map containing the points that are coincidence by virtue of
// any number of direct or indirect coincidence constraints
const std::vector< std::map<int, Sketcher::PointPos> > getCoincidenceGroups();
// returns if the given geoId is fixed (coincident) with external geometry on any of the possible relevant points
void isCoincidentWithExternalGeometry(int GeoId, bool &start_external, bool &mid_external, bool &end_external);
// returns a map containing all the GeoIds that are coincident with the given point as keys, and the PosIds as values associated
// with the keys.
const std::map<int, Sketcher::PointPos> getAllCoincidentPoints(int GeoId, PointPos PosId);
/// retrieves for a Vertex number a list with all coincident points (sharing a single coincidence constraint)
void getDirectlyCoincidentPoints(int GeoId, PointPos PosId, std::vector<int> &GeoIdList,
std::vector<PointPos> &PosIdList);
void getDirectlyCoincidentPoints(int VertexId, std::vector<int> &GeoIdList, std::vector<PointPos> &PosIdList);
bool arePointsCoincident(int GeoId1, PointPos PosId1, int GeoId2, PointPos PosId2);
/// fetches all constraints involving given GeoId
void getAppliedConstraints(int GeoId, std::vector<int> &constraintList);
/// generates a warning message about constraint conflicts and appends it to the given message
static void appendConflictMsg(const std::vector<int> &conflicting, std::string &msg);
/// generates a warning message about redundant constraints and appends it to the given message
static void appendRedundantMsg(const std::vector<int> &redundant, std::string &msg);
/// generates a warning message about malformed constraints and appends it to the given message
static void appendMalformedConstraintsMsg(const std::vector<int> &malformed, std::string &msg);
double calculateAngleViaPoint(int geoId1, int geoId2, double px, double py);
bool isPointOnCurve(int geoIdCurve, double px, double py);
double calculateConstraintError(int ConstrId);
int changeConstraintsLocking(bool bLock);
/// returns whether a given constraint has an associated expression or not
bool constraintHasExpression(int constrid) const;
///porting functions
int port_reversedExternalArcs(bool justAnalyze);
// from base class
virtual PyObject *getPyObject(void) override;
virtual unsigned int getMemSize(void) const override;
virtual void Save(Base::Writer &/*writer*/) const override;
virtual void Restore(Base::XMLReader &/*reader*/) override;
/// returns the number of construction lines (to be used as axes)
virtual int getAxisCount(void) const override;
/// retrieves an axis iterating through the construction lines of the sketch (indices start at 0)
virtual Base::Axis getAxis(int axId) const override;
/// verify and accept the assigned geometry
virtual void acceptGeometry() override;
/// Check if constraint has invalid indexes
bool evaluateConstraint(const Constraint *constraint) const;
/// Check for constraints with invalid indexes
bool evaluateConstraints() const;
/// Remove constraints with invalid indexes
void validateConstraints();
/// Checks if support is valid
bool evaluateSupport(void);
/// validate External Links (remove invalid external links)
void validateExternalLinks(void);
/// gets DoF of last solver execution
inline int getLastDoF() const {return lastDoF;}
/// gets HasConflicts status of last solver execution
inline bool getLastHasConflicts() const {return lastHasConflict;}
/// gets HasRedundancies status of last solver execution
inline bool getLastHasRedundancies() const {return lastHasRedundancies;}
/// gets HasRedundancies status of last solver execution
inline bool getLastHasPartialRedundancies() const {return lastHasPartialRedundancies;}
/// gets HasMalformedConstraints status of last solver execution
inline bool getLastHasMalformedConstraints() const {return lastHasMalformedConstraints;}
/// gets solver status of last solver execution
inline int getLastSolverStatus() const {return lastSolverStatus;}
/// gets solver SolveTime of last solver execution
inline float getLastSolveTime() const {return lastSolveTime;}
/// gets the conflicting constraints of the last solver execution
inline const std::vector<int> &getLastConflicting(void) const { return lastConflicting; }
/// gets the redundant constraints of last solver execution
inline const std::vector<int> &getLastRedundant(void) const { return lastRedundant; }
/// gets the redundant constraints of last solver execution
inline const std::vector<int> &getLastPartiallyRedundant(void) const { return lastPartiallyRedundant; }
/// gets the redundant constraints of last solver execution
inline const std::vector<int> &getLastMalformedConstraints(void) const { return lastMalformedConstraints; }
public: /* Solver exposed interface */
/// gets the solved sketch as a reference
inline const Sketch &getSolvedSketch(void) const {return solvedSketch;}
/// enables/disables solver initial solution recalculation when moving point mode (useful for dragging)
inline void setRecalculateInitialSolutionWhileMovingPoint(bool recalculateInitialSolutionWhileMovingPoint)
{solvedSketch.setRecalculateInitialSolutionWhileMovingPoint(recalculateInitialSolutionWhileMovingPoint);}
/// Forwards a request for a temporary initMove to the solver using the current sketch state as a reference (enables dragging)
inline int initTemporaryMove(int geoId, PointPos pos, bool fine=true);
/** Forwards a request for point or curve temporary movement to the solver using the current state as a reference (enables dragging).
* NOTE: A temporary move operation must always be preceded by a initTemporaryMove() operation.
*/
inline int moveTemporaryPoint(int geoId, PointPos pos, Base::Vector3d toPoint, bool relative=false);
/// forwards a request to update an extension of a geometry of the solver to the solver.
inline void updateSolverExtension(int geoId, std::unique_ptr<Part::GeometryExtension> && ext)
{ return solvedSketch.updateExtension(geoId, std::move(ext));}
public:
/// returns the geometric elements/vertex which the solver detects as having dependent parameters.
/// these parameters relate to not fully constraint edges/vertices.
void getGeometryWithDependentParameters(std::vector<std::pair<int,PointPos>>& geometrymap);
/// Flag to allow external geometry from other bodies than the one this sketch belongs to
bool isAllowedOtherBody() const {
return allowOtherBody;
}
void setAllowOtherBody(bool on) {
allowOtherBody = on;
}
/// Flag to allow carbon copy from misaligned geometry
bool isAllowedUnaligned() const {
return allowUnaligned;
}
void setAllowUnaligned(bool on) {
allowUnaligned = on;
}
enum eReasonList{
rlAllowed,
rlOtherDoc,
rlCircularReference,
rlOtherPart,
rlOtherBody,
rlOtherBodyWithLinks, // for carbon copy
rlNotASketch, // for carbon copy
rlNonParallel, // for carbon copy
rlAxesMisaligned, // for carbon copy
rlOriginsMisaligned // for carbon copy
};
/// Return true if this object is allowed as external geometry for the
/// sketch. rsn argument receives the reason for disallowing.
bool isExternalAllowed(App::Document *pDoc, App::DocumentObject *pObj, eReasonList* rsn = 0) const;
bool isCarbonCopyAllowed(App::Document *pDoc, App::DocumentObject *pObj, bool & xinv, bool & yinv, eReasonList* rsn = 0) const;
bool isPerformingInternalTransaction() const {return internaltransaction;};
/** retrieves intersection points of this curve with the closest two curves around a point of this curve.
* - it includes internal and external intersecting geometry.
* - it returns Constraint::GeoUndef if no intersection is found.
*/
bool seekTrimPoints(int GeoId, const Base::Vector3d &point,
int &GeoId1, Base::Vector3d &intersect1,
int &GeoId2, Base::Vector3d &intersect2);
public:
// Analyser functions
int autoConstraint(double precision = Precision::Confusion() * 1000, double angleprecision = M_PI/20, bool includeconstruction = true);
int detectMissingPointOnPointConstraints(double precision = Precision::Confusion() * 1000, bool includeconstruction = true);
void analyseMissingPointOnPointCoincident(double angleprecision = M_PI/8);
int detectMissingVerticalHorizontalConstraints(double angleprecision = M_PI/8);
int detectMissingEqualityConstraints(double precision);
std::vector<ConstraintIds> &getMissingPointOnPointConstraints(void);
std::vector<ConstraintIds> &getMissingVerticalHorizontalConstraints(void);
std::vector<ConstraintIds> &getMissingLineEqualityConstraints(void);
std::vector<ConstraintIds> &getMissingRadiusConstraints(void);
void setMissingRadiusConstraints(std::vector<ConstraintIds> &cl);
void setMissingLineEqualityConstraints(std::vector<ConstraintIds>& cl);
void setMissingVerticalHorizontalConstraints(std::vector<ConstraintIds>& cl);
void setMissingPointOnPointConstraints(std::vector<ConstraintIds>& cl);
void makeMissingPointOnPointCoincident(bool onebyone = false);
void makeMissingVerticalHorizontal(bool onebyone = false);
void makeMissingEquality(bool onebyone = true);
// helper
/// returns the number of redundant constraints detected
int autoRemoveRedundants(bool updategeo = true);
int renameConstraint(int GeoId, std::string name);
// Validation routines
std::vector<Base::Vector3d> getOpenVertices(void) const;
public: // geometry extension functionalities for single element sketch object user convenience
int setGeometryId(int GeoId, long id);
int getGeometryId(int GeoId, long &id) const;
protected:
/// get called by the container when a property has changed
virtual void onChanged(const App::Property* /*prop*/) override;
virtual void onDocumentRestored() override;
virtual void restoreFinished() override;
virtual void setExpression(const App::ObjectIdentifier &path, std::shared_ptr<App::Expression> expr) override;
std::string validateExpression(const App::ObjectIdentifier &path, std::shared_ptr<const App::Expression> expr);
void constraintsRenamed(const std::map<App::ObjectIdentifier, App::ObjectIdentifier> &renamed);
void constraintsRemoved(const std::set<App::ObjectIdentifier> &removed);
/*!
\brief Returns a list of supported geometries from the input list
\param geoList - the geometry list
\retval list - the supported geometry list
*/
std::vector<Part::Geometry *> supportedGeometry(const std::vector<Part::Geometry *> &geoList) const;
/*!
\brief Transfer constraints on lines being filleted.
Since filleting moves the endpoints of the input geometry, existing constraints may no longer be
sensible. If fillet() was called with preserveCorner=false, the constraints are simply deleted.
But if the lines are coincident and preserveCorner=true, we can preserve most constraints on the
old end points by moving them to the preserved corner, or transforming distance constraints on
straight lines into point-to-point distance constraints.
\param geoId1, podId1, geoId2, posId2 - The two lines that have just been filleted
*/
void transferFilletConstraints(int geoId1, PointPos posId1, int geoId2, PointPos posId2);
// refactoring functions
// check whether constraint may be changed driving status
int testDrivingChange(int ConstrId, bool isdriving);
virtual void onUndoRedoFinished() override;
// migration functions
void migrateSketch(void);
static void appendConstraintsMsg(const std::vector<int> &vector,
const std::string & singularmsg,
const std::string & pluralmsg,
std::string &msg);
// retrieves redundant, conflicting and malformed constraint information from the solver
void retrieveSolverDiagnostics();
// retrieves whether a geometry blocked state corresponds to this constraint
// returns true of the constraint is of Block type, false otherwise
bool getBlockedState(const Constraint * cstr, bool & blockedstate) const;
// retrieves the geometry blocked state corresponding to this constraint
// returns true of the constraint is of InternalAlignment type, false otherwise
bool getInternalTypeState(const Constraint * cstr, Sketcher::InternalType::InternalType & internaltypestate) const;
// Checks whether the geometry state stored in the geometry extension matches the current sketcher situation (e.g. constraints)
// and corrects the state if not matching.
void synchroniseGeometryState();
// helper function to create a new constraint and move it to the Constraint Property
void addConstraint( Sketcher::ConstraintType constrType,
int firstGeoId,
Sketcher::PointPos firstPos,
int secondGeoId = Constraint::GeoUndef,
Sketcher::PointPos secondPos = Sketcher::none,
int thirdGeoId = Constraint::GeoUndef,
Sketcher::PointPos thirdPos = Sketcher::none);
// creates a new constraint
std::unique_ptr<Constraint> createConstraint( Sketcher::ConstraintType constrType,
int firstGeoId,
Sketcher::PointPos firstPos,
int secondGeoId = Constraint::GeoUndef,
Sketcher::PointPos secondPos = Sketcher::none,
int thirdGeoId = Constraint::GeoUndef,
Sketcher::PointPos thirdPos = Sketcher::none);
private:
/// Flag to allow external geometry from other bodies than the one this sketch belongs to
bool allowOtherBody;
/// Flag to allow carbon copy from misaligned geometry
bool allowUnaligned;
std::vector<Part::Geometry *> ExternalGeo;
std::vector<int> VertexId2GeoId;
std::vector<PointPos> VertexId2PosId;
Sketch solvedSketch;
/** this internal flag indicate that an operation modifying the geometry, but not the DoF of the sketch took place (e.g. toggle construction),
so if next action is a movement of a point (movePoint), the geometry must be updated first.
*/
bool solverNeedsUpdate;
int lastDoF;
bool lastHasConflict;
bool lastHasRedundancies;
bool lastHasPartialRedundancies;
bool lastHasMalformedConstraints;
int lastSolverStatus;
float lastSolveTime;
std::vector<int> lastConflicting;
std::vector<int> lastRedundant;
std::vector<int> lastPartiallyRedundant;
std::vector<int> lastMalformedConstraints;
boost::signals2::scoped_connection constraintsRenamedConn;
boost::signals2::scoped_connection constraintsRemovedConn;
bool AutoLockTangencyAndPerpty(Constraint* cstr, bool bForce = false, bool bLock = true);
// Geometry Extensions is used to store on geometry a state that is enforced by pre-existing constraints
// Like Block constraint and InternalAlignment constraint. This enables (more) convenient handling in ViewProviderSketch
// and solver.
//
// These functions are responsible for updating the Geometry State, currently Geometry Mode (Blocked) and
// Geometry InternalType (BSplineKnot, BSplinePole).
//
// The data life model for handling this state is as follows:
// 1. Upon restore, any migration is handled to set the status for legacy files (backwards compatibility)
// 2. Functionality adding constraints (of the relevant type) calls addGeometryState to set the status
// 3. Functionality removing constraints (of the relevant type) calls removeGeometryState to remove the status
// 4. Save mechanism will ensure persistence.
void addGeometryState(const Constraint* cstr) const;
void removeGeometryState(const Constraint* cstr) const;
SketchAnalysis * analyser;
bool internaltransaction;
bool managedoperation; // indicates whether changes to properties are the deed of SketchObject or not (for input validation)
};
inline int SketchObject::initTemporaryMove(int geoId, PointPos pos, bool fine/*=true*/)
{
// if a previous operation did not update the geometry (including geometry extensions)
// or constraints (including any deleted pointer, as in renameConstraint) of the solver,
// here we update them before starting a temporary operation.
if(solverNeedsUpdate)
solve();
return solvedSketch.initMove(geoId,pos,fine);
}
inline int SketchObject::moveTemporaryPoint(int geoId, PointPos pos, Base::Vector3d toPoint, bool relative/*=false*/)
{
return solvedSketch.movePoint(geoId, pos, toPoint, relative);
}
template < typename GeometryT,
typename >
const GeometryT * SketchObject::getGeometry(int GeoId) const
{
if (GeoId >= 0) {
const std::vector<Part::Geometry *> &geomlist = getInternalGeometry();
if (GeoId < int(geomlist.size()))
return static_cast<GeometryT *>(geomlist[GeoId]);
}
else if (-GeoId <= int(ExternalGeo.size()))
return static_cast<GeometryT *>(ExternalGeo[-GeoId-1]);
return nullptr;
}
typedef App::FeaturePythonT<SketchObject> SketchObjectPython;
} //namespace Sketcher
#endif // SKETCHER_SKETCHOBJECT_H