1 // Created on: 1994-08-18
2 // Created by: Laurent PAINNOT
3 // Copyright (c) 1994-1999 Matra Datavision
4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
6 // This file is part of Open CASCADE Technology software library.
8 // This library is free software; you can redistribute it and/or modify it under
9 // the terms of the GNU Lesser General Public License version 2.1 as published
10 // by the Free Software Foundation, with special exception defined in the file
11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
12 // distribution for complete text of the license and disclaimer of any warranty.
14 // Alternatively, this file may be used under the terms of Open CASCADE
15 // commercial license or contractual agreement.
17 // 08-Aug-95 : xab : interpolation uses BSplCLib::Interpolate
19 #include <BSplCLib.hxx>
20 #include <GeomAPI_Interpolate.hxx>
23 #include <Standard_ConstructionError.hxx>
24 #include <StdFail_NotDone.hxx>
25 #include <TColgp_Array1OfPnt.hxx>
26 #include <TColgp_Array1OfVec.hxx>
27 #include <TColStd_Array1OfBoolean.hxx>
28 #include <TColStd_Array1OfInteger.hxx>
29 #include <TColStd_HArray1OfReal.hxx>
31 //=======================================================================
32 //function : CheckPoints
34 //=======================================================================
35 static Standard_Boolean CheckPoints(const TColgp_Array1OfPnt& PointArray,
36 const Standard_Real Tolerance)
39 Standard_Real tolerance_squared = Tolerance * Tolerance,
41 Standard_Boolean result = Standard_True ;
42 for (ii = PointArray.Lower() ; result && ii < PointArray.Upper() ; ii++) {
44 PointArray.Value(ii).SquareDistance(PointArray.Value(ii+1)) ;
45 result = (distance_squared >= tolerance_squared) ;
50 //=======================================================================
51 //function : CheckTangents
53 //=======================================================================
54 static Standard_Boolean CheckTangents(
55 const TColgp_Array1OfVec& Tangents,
56 const TColStd_Array1OfBoolean& TangentFlags,
57 const Standard_Real Tolerance)
61 Standard_Real tolerance_squared = Tolerance * Tolerance,
63 Standard_Boolean result = Standard_True ;
64 index = TangentFlags.Lower() ;
65 for (ii = Tangents.Lower(); result && ii <= Tangents.Upper() ; ii++) {
66 if(TangentFlags.Value(index)) {
68 Tangents.Value(ii).SquareMagnitude() ;
69 result = (distance_squared >= tolerance_squared) ;
76 //=======================================================================
77 //function : CheckParameters
79 //=======================================================================
80 static Standard_Boolean CheckParameters(const
81 TColStd_Array1OfReal& Parameters)
84 Standard_Real distance ;
85 Standard_Boolean result = Standard_True ;
86 for (ii = Parameters.Lower() ; result && ii < Parameters.Upper() ; ii++) {
88 Parameters.Value(ii+1) - Parameters.Value(ii) ;
89 result = (distance >= RealSmall()) ;
93 //=======================================================================
94 //function : BuildParameters
96 //=======================================================================
97 static void BuildParameters(const Standard_Boolean PeriodicFlag,
98 const TColgp_Array1OfPnt& PointsArray,
99 Handle(TColStd_HArray1OfReal)& ParametersPtr)
103 Standard_Real distance ;
105 num_parameters = PointsArray.Length() ;
107 num_parameters += 1 ;
110 new TColStd_HArray1OfReal(1,
112 ParametersPtr->SetValue(1,0.0e0) ;
114 for (ii = PointsArray.Lower() ; ii < PointsArray.Upper() ; ii++) {
116 PointsArray.Value(ii).Distance(PointsArray.Value(ii+1)) ;
117 ParametersPtr->SetValue(index,
118 ParametersPtr->Value(ii) + distance) ;
123 PointsArray.Value(PointsArray.Upper()).
124 Distance(PointsArray.Value(PointsArray.Lower())) ;
125 ParametersPtr->SetValue(index,
126 ParametersPtr->Value(ii) + distance) ;
129 //=======================================================================
130 //function : BuildPeriodicTangents
132 //=======================================================================
134 static void BuildPeriodicTangent(
135 const TColgp_Array1OfPnt& PointsArray,
136 TColgp_Array1OfVec& TangentsArray,
137 TColStd_Array1OfBoolean& TangentFlags,
138 const TColStd_Array1OfReal& ParametersArray)
143 Standard_Real *point_array,
149 if (PointsArray.Length() < 3) {
150 throw Standard_ConstructionError();
153 if (!TangentFlags.Value(1)) {
155 if (PointsArray.Length() == 3) {
158 point_array = (Standard_Real *) &PointsArray.Value(PointsArray.Lower()) ;
160 (Standard_Real *) &ParametersArray.Value(1) ;
161 TangentFlags.SetValue(1,Standard_True) ;
162 PLib::EvalLagrange(ParametersArray.Value(1),
169 for (ii = 1 ; ii <= 3 ; ii++) {
170 a_vector.SetCoord(ii,eval_result[1][ii-1]) ;
172 TangentsArray.SetValue(1,a_vector) ;
175 //=======================================================================
176 //function : BuildTangents
178 //=======================================================================
180 static void BuildTangents(const TColgp_Array1OfPnt& PointsArray,
181 TColgp_Array1OfVec& TangentsArray,
182 TColStd_Array1OfBoolean& TangentFlags,
183 const TColStd_Array1OfReal& ParametersArray)
187 Standard_Real *point_array,
195 if ( PointsArray.Length() < 3) {
196 throw Standard_ConstructionError();
198 if (PointsArray.Length() == 3) {
201 if (!TangentFlags.Value(1)) {
202 point_array = (Standard_Real *) &PointsArray.Value(PointsArray.Lower()) ;
204 (Standard_Real *) &ParametersArray.Value(1) ;
205 TangentFlags.SetValue(1,Standard_True) ;
206 PLib::EvalLagrange(ParametersArray.Value(1),
213 for (ii = 1 ; ii <= 3 ; ii++) {
214 a_vector.SetCoord(ii,eval_result[1][ii-1]) ;
216 TangentsArray.SetValue(1,a_vector) ;
218 if (! TangentFlags.Value(TangentFlags.Upper())) {
220 (Standard_Real *) &PointsArray.Value(PointsArray.Upper() - degree) ;
221 TangentFlags.SetValue(TangentFlags.Upper(),Standard_True) ;
223 (Standard_Real *) &ParametersArray.Value(ParametersArray.Upper() - degree) ;
224 PLib::EvalLagrange(ParametersArray.Value(ParametersArray.Upper()),
231 for (ii = 1 ; ii <= 3 ; ii++) {
232 a_vector.SetCoord(ii,eval_result[1][ii-1]) ;
234 TangentsArray.SetValue(TangentsArray.Upper(),a_vector) ;
237 //=======================================================================
238 //function : BuildTangents
239 //purpose : scale the given tangent so that they have the length of
240 // the size of the derivative of the lagrange interpolation
242 //=======================================================================
243 static void ScaleTangents(const TColgp_Array1OfPnt& PointsArray,
244 TColgp_Array1OfVec& TangentsArray,
245 const TColStd_Array1OfBoolean& TangentFlags,
246 const TColStd_Array1OfReal& ParametersArray)
254 Standard_Real *point_array,
262 num_points = PointsArray.Length() ;
263 if (num_points == 2) {
266 else if (num_points >= 3) {
270 index = PointsArray.Lower() ;
271 for (ii = TangentFlags.Lower() ; ii <= TangentFlags.Upper() ; ii++) {
272 if (TangentFlags.Value(ii)) {
274 (Standard_Real *) &PointsArray.Value(index) ;
276 (Standard_Real *) &ParametersArray.Value(index) ;
277 PLib::EvalLagrange(ParametersArray.Value(ii),
286 for (jj = 1 ; jj <= 3 ; jj++) {
287 value[0] += Abs(TangentsArray.Value(ii).Coord(jj)) ;
288 value[1] += Abs(eval_result[1][jj-1]) ;
290 ratio = value[1] / value[0] ;
291 for (jj = 1 ; jj <= 3 ; jj++) {
292 a_vector.SetCoord(jj, ratio *
293 TangentsArray.Value(ii).Coord(jj)) ;
295 TangentsArray.SetValue(ii, a_vector) ;
296 if (ii != TangentFlags.Lower()) {
299 if (index > PointsArray.Upper() - degree) {
300 index = PointsArray.Upper() - degree ;
307 //=======================================================================
308 //function : GeomAPI_Interpolate
310 //=======================================================================
312 GeomAPI_Interpolate::GeomAPI_Interpolate
313 (const Handle(TColgp_HArray1OfPnt)& PointsPtr,
314 const Standard_Boolean PeriodicFlag,
315 const Standard_Real Tolerance) :
316 myTolerance(Tolerance),
318 myIsDone(Standard_False),
319 myPeriodic(PeriodicFlag),
320 myTangentRequest(Standard_False)
322 Standard_Integer ii ;
323 Standard_Boolean result =
324 CheckPoints(PointsPtr->Array1(),
327 new TColgp_HArray1OfVec(myPoints->Lower(),
330 new TColStd_HArray1OfBoolean(myPoints->Lower(),
334 throw Standard_ConstructionError();
336 BuildParameters(PeriodicFlag,
340 for (ii = myPoints->Lower() ; ii <= myPoints->Upper() ; ii++) {
341 myTangentFlags->SetValue(ii,Standard_False) ;
348 //=======================================================================
349 //function : GeomAPI_Interpolate
351 //=======================================================================
353 GeomAPI_Interpolate::GeomAPI_Interpolate
354 (const Handle(TColgp_HArray1OfPnt)& PointsPtr,
355 const Handle(TColStd_HArray1OfReal)& ParametersPtr,
356 const Standard_Boolean PeriodicFlag,
357 const Standard_Real Tolerance) :
358 myTolerance(Tolerance),
360 myIsDone(Standard_False),
361 myParameters(ParametersPtr),
362 myPeriodic(PeriodicFlag),
363 myTangentRequest(Standard_False)
365 Standard_Integer ii ;
368 Standard_Boolean result =
369 CheckPoints(PointsPtr->Array1(),
373 if ((PointsPtr->Length()) + 1 != ParametersPtr->Length()) {
374 throw Standard_ConstructionError();
378 new TColgp_HArray1OfVec(myPoints->Lower(),
381 new TColStd_HArray1OfBoolean(myPoints->Lower(),
385 throw Standard_ConstructionError();
389 CheckParameters(ParametersPtr->Array1()) ;
391 throw Standard_ConstructionError();
394 for (ii = myPoints->Lower() ; ii <= myPoints->Upper() ; ii++) {
395 myTangentFlags->SetValue(ii,Standard_False) ;
399 //=======================================================================
402 //=======================================================================
404 void GeomAPI_Interpolate::Load(
405 const TColgp_Array1OfVec& Tangents,
406 const Handle(TColStd_HArray1OfBoolean)& TangentFlagsPtr,
407 const Standard_Boolean Scale )
410 Standard_Boolean result ;
411 Standard_Integer ii ;
412 myTangentRequest = Standard_True ;
413 myTangentFlags = TangentFlagsPtr ;
414 if (Tangents.Length() != myPoints->Length() ||
415 TangentFlagsPtr->Length() != myPoints->Length()) {
416 throw Standard_ConstructionError();
419 CheckTangents(Tangents,
420 TangentFlagsPtr->Array1(),
424 new TColgp_HArray1OfVec(Tangents.Lower(),Tangents.Upper()) ;
425 for (ii = Tangents.Lower() ; ii <= Tangents.Upper() ; ii++ ) {
426 myTangents->SetValue(ii,Tangents.Value(ii)) ;
430 ScaleTangents(myPoints->Array1(),
431 myTangents->ChangeArray1(),
432 TangentFlagsPtr->Array1(),
433 myParameters->Array1()) ;
437 throw Standard_ConstructionError();
443 //=======================================================================
446 //=======================================================================
448 void GeomAPI_Interpolate::Load(const gp_Vec& InitialTangent,
449 const gp_Vec& FinalTangent,
450 const Standard_Boolean Scale )
452 Standard_Boolean result ;
453 myTangentRequest = Standard_True ;
454 myTangentFlags->SetValue(1,Standard_True) ;
455 myTangentFlags->SetValue(myPoints->Length(),Standard_True) ;
456 myTangents->SetValue(1,InitialTangent) ;
457 myTangents->SetValue(myPoints->Length(),FinalTangent) ;
459 CheckTangents(myTangents->Array1(),
460 myTangentFlags->Array1(),
463 throw Standard_ConstructionError();
467 ScaleTangents(myPoints->Array1(),
468 myTangents->ChangeArray1(),
469 myTangentFlags->Array1(),
470 myParameters->Array1()) ;
474 //=======================================================================
477 //=======================================================================
479 void GeomAPI_Interpolate::Perform()
485 PerformNonPeriodic() ;
488 //=======================================================================
489 //function : PerformPeriodic
491 //=======================================================================
493 void GeomAPI_Interpolate::PerformPeriodic()
495 Standard_Integer degree,
508 Standard_Real period ;
512 num_points = myPoints->Length() ;
513 period = myParameters->Value(myParameters->Upper()) -
514 myParameters->Value(myParameters->Lower()) ;
515 num_poles = num_points + 1 ;
516 if (num_points == 2 && !myTangentRequest) {
518 // build a periodic curve of degree 1
522 TColStd_Array1OfInteger deg1_mults(1,num_poles) ;
523 for (ii = 1 ; ii <= num_poles ; ii++) {
524 deg1_mults.SetValue(ii,1) ;
528 new Geom_BSplineCurve(myPoints->Array1(),
529 myParameters->Array1(),
533 myIsDone = Standard_True ;
537 num_distinct_knots = num_points + 1 ;
541 if (myTangentRequest)
542 for (ii = myTangentFlags->Lower() + 1 ;
543 ii <= myTangentFlags->Upper() ; ii++) {
544 if (myTangentFlags->Value(ii)) {
549 TColStd_Array1OfReal parameters(1,num_poles) ;
550 TColStd_Array1OfReal flatknots(1,num_poles + degree + 1) ;
551 TColStd_Array1OfInteger mults(1,num_distinct_knots) ;
552 TColStd_Array1OfInteger contact_order_array(1, num_poles) ;
553 TColgp_Array1OfPnt poles(1,num_poles) ;
555 for (ii = 1 ; ii <= half_order ; ii++) {
556 flatknots.SetValue(ii,myParameters->Value(myParameters->Upper() -1) -
558 flatknots.SetValue(ii + half_order,myParameters->
559 Value(myParameters->Lower())) ;
560 flatknots.SetValue(num_poles + ii,
561 myParameters->Value(myParameters->Upper())) ;
562 flatknots.SetValue(num_poles + half_order + ii,
563 myParameters->Value(half_order) + period) ;
565 for (ii = 1 ; ii <= num_poles ; ii++) {
566 contact_order_array.SetValue(ii,0) ;
568 for (ii = 2 ; ii < num_distinct_knots ; ii++) {
569 mults.SetValue(ii,1) ;
571 mults.SetValue(1,half_order) ;
572 mults.SetValue(num_distinct_knots ,half_order) ;
573 if (num_points >= 3) {
576 // only enter here if there are more than 3 points otherwise
577 // it means we have already the tangent
579 BuildPeriodicTangent(myPoints->Array1(),
580 myTangents->ChangeArray1(),
581 myTangentFlags->ChangeArray1(),
582 myParameters->Array1()) ;
584 contact_order_array.SetValue(2,1) ;
585 parameters.SetValue(1,myParameters->Value(1)) ;
586 parameters.SetValue(2,myParameters->Value(1)) ;
587 poles.SetValue(1,myPoints->Value(1)) ;
588 for (jj = 1 ; jj <= 3 ; jj++) {
589 a_point.SetCoord(jj,myTangents->Value(1).Coord(jj)) ;
591 poles.SetValue(2,a_point) ;
595 index1 = degree + 2 ;
596 if (myTangentRequest) {
597 for (ii = myTangentFlags->Lower() + 1 ;
598 ii <= myTangentFlags->Upper() ; ii++) {
599 parameters.SetValue(index,myParameters->Value(ii)) ;
600 flatknots.SetValue(index1,myParameters->Value(ii)) ;
601 poles.SetValue(index,myPoints->Value(ii)) ;
604 if (myTangentFlags->Value(ii)) {
605 mults.SetValue(mult_index,mults.Value(mult_index) + 1) ;
606 contact_order_array(index) = 1 ;
608 parameters.SetValue(index,
609 myParameters->Value(ii)) ;
610 flatknots.SetValue(index1,myParameters->Value(ii)) ;
611 for (jj = 1 ; jj <= 3 ; jj++) {
612 a_point.SetCoord(jj,myTangents->Value(ii).Coord(jj)) ;
614 poles.SetValue(index,a_point) ;
624 for(ii = myParameters->Lower() ; ii <= myParameters->Upper() ; ii++) {
625 parameters.SetValue(index1,
626 myParameters->Value(ii)) ;
627 flatknots.SetValue(index,
628 myParameters->Value(ii)) ;
633 for (ii = myPoints->Lower() + 1 ; ii <= myPoints->Upper() ; ii++) {
635 // copy all the given points since the last one will be initialized
636 // below by the first point in the array myPoints
638 poles.SetValue(index,
639 myPoints->Value(ii)) ;
644 contact_order_array.SetValue(num_poles - 1, 1) ;
645 parameters.SetValue(num_poles-1,
646 myParameters->Value(myParameters->Upper())) ;
648 // for the periodic curve ONLY the tangent of the first point
649 // will be used since the curve should close itself at the first
650 // point See BuildPeriodicTangent
652 for (jj = 1 ; jj <= 3 ; jj++) {
653 a_point.SetCoord(jj,myTangents->Value(1).Coord(jj)) ;
655 poles.SetValue(num_poles-1,a_point) ;
657 parameters.SetValue(num_poles,
658 myParameters->Value(myParameters->Upper())) ;
660 poles.SetValue(num_poles,
661 myPoints->Value(1)) ;
664 BSplCLib::Interpolate(degree,
670 if (!inversion_problem) {
671 TColgp_Array1OfPnt newpoles(poles.Value(1),
675 new Geom_BSplineCurve(newpoles,
676 myParameters->Array1(),
680 myIsDone = Standard_True ;
686 //=======================================================================
687 //function : PerformNonPeriodic
689 //=======================================================================
691 void GeomAPI_Interpolate::PerformNonPeriodic()
693 Standard_Integer degree,
710 num_poles = myPoints->Length() ;
711 if (num_poles == 2 && !myTangentRequest) {
714 else if (num_poles == 3 && !myTangentRequest) {
716 num_distinct_knots = 2 ;
721 if (myTangentRequest)
722 for (ii = myTangentFlags->Lower() + 1 ;
723 ii < myTangentFlags->Upper() ; ii++) {
724 if (myTangentFlags->Value(ii)) {
731 TColStd_Array1OfReal parameters(1,num_poles) ;
732 TColStd_Array1OfReal flatknots(1,num_poles + degree + 1) ;
733 TColStd_Array1OfInteger mults(1,num_distinct_knots) ;
734 TColStd_Array1OfReal knots(1,num_distinct_knots) ;
735 TColStd_Array1OfInteger contact_order_array(1, num_poles) ;
736 TColgp_Array1OfPnt poles(1,num_poles) ;
738 for (ii = 1 ; ii <= degree + 1 ; ii++) {
739 flatknots.SetValue(ii,myParameters->Value(1)) ;
740 flatknots.SetValue(ii + num_poles,
741 myParameters->Value(num_points)) ;
743 for (ii = 1 ; ii <= num_poles ; ii++) {
744 contact_order_array.SetValue(ii,0) ;
746 for (ii = 2 ; ii < num_distinct_knots ; ii++) {
747 mults.SetValue(ii,1) ;
749 mults.SetValue(1,degree + 1) ;
750 mults.SetValue(num_distinct_knots ,degree + 1) ;
754 for (ii = 1 ; ii <= num_poles ; ii++) {
755 poles.SetValue(ii ,myPoints->Value(ii)) ;
758 new Geom_BSplineCurve(poles,
759 myParameters->Array1(),
762 myIsDone = Standard_True ;
765 knots.SetValue(1,myParameters->Value(1)) ;
766 knots.SetValue(2,myParameters->Value(3)) ;
767 for (ii = 1 ; ii <= num_poles ; ii++) {
768 poles.SetValue(ii,myPoints->Value(ii)) ;
771 BSplCLib::Interpolate(degree,
773 myParameters->Array1(),
777 if (!inversion_problem) {
779 new Geom_BSplineCurve(poles,
783 myIsDone = Standard_True ;
788 // check if the boundary conditions are set
790 if (num_points >= 3) {
792 // cannot build the tangents with degree 3 with only 2 points
793 // if those where not given in advance
795 BuildTangents(myPoints->Array1(),
796 myTangents->ChangeArray1(),
797 myTangentFlags->ChangeArray1(),
798 myParameters->Array1()) ;
800 contact_order_array.SetValue(2,1) ;
801 parameters.SetValue(1,myParameters->Value(1)) ;
802 parameters.SetValue(2,myParameters->Value(1)) ;
803 poles.SetValue(1,myPoints->Value(1)) ;
804 for (jj = 1 ; jj <= 3 ; jj++) {
805 a_point.SetCoord(jj,myTangents->Value(1).Coord(jj)) ;
808 poles.SetValue(2,a_point) ;
812 index2 = myPoints->Lower() + 1 ;
813 index3 = degree + 2 ;
814 if (myTangentRequest) {
815 for (ii = myParameters->Lower() + 1 ;
816 ii < myParameters->Upper() ; ii++) {
817 parameters.SetValue(index,myParameters->Value(ii)) ;
818 poles.SetValue(index,myPoints->Value(index2)) ;
819 flatknots.SetValue(index3,myParameters->Value(ii)) ;
822 if (myTangentFlags->Value(index1)) {
824 // set the multiplicities, the order of the contact, the
827 mults.SetValue(mult_index,mults.Value(mult_index) + 1) ;
828 contact_order_array(index) = 1 ;
829 flatknots.SetValue(index3, myParameters->Value(ii)) ;
830 parameters.SetValue(index,
831 myParameters->Value(ii)) ;
832 for (jj = 1 ; jj <= 3 ; jj++) {
833 a_point.SetCoord(jj,myTangents->Value(ii).Coord(jj)) ;
835 poles.SetValue(index,a_point) ;
847 for(ii = myParameters->Lower() ; ii <= myParameters->Upper() ; ii++) {
848 parameters.SetValue(index1,
849 myParameters->Value(ii)) ;
853 for (ii = myPoints->Lower() + 1 ; ii <= myPoints->Upper() - 1 ; ii++) {
854 poles.SetValue(index,
855 myPoints->Value(ii)) ;
861 for(ii = myParameters->Lower() ; ii <= myParameters->Upper() ; ii++) {
862 flatknots.SetValue(index,
863 myParameters->Value(ii)) ;
867 for (jj = 1 ; jj <= 3 ; jj++) {
869 myTangents->Value(num_points).Coord(jj)) ;
871 poles.SetValue(num_poles-1 ,a_point) ;
873 contact_order_array.SetValue(num_poles - 1,1) ;
874 parameters.SetValue(num_poles,
875 myParameters->Value(myParameters->Upper())) ;
876 parameters.SetValue(num_poles -1,
877 myParameters->Value(myParameters->Upper())) ;
879 poles.SetValue(num_poles,
880 myPoints->Value(num_points)) ;
882 BSplCLib::Interpolate(degree,
888 if (!inversion_problem) {
890 new Geom_BSplineCurve(poles,
891 myParameters->Array1(),
894 myIsDone = Standard_True ;
900 //=======================================================================
901 //function : Handle(Geom_BSplineCurve)&
903 //=======================================================================
905 const Handle(Geom_BSplineCurve)& GeomAPI_Interpolate::Curve() const
908 throw StdFail_NotDone(" ");
914 //=======================================================================
915 //function : Geom_BSplineCurve
917 //=======================================================================
919 GeomAPI_Interpolate::operator Handle(Geom_BSplineCurve)() const
925 //=======================================================================
928 //=======================================================================
930 Standard_Boolean GeomAPI_Interpolate::IsDone() const