0026377: Passing Handle objects as arguments to functions as non-const reference...
[occt.git] / src / AppDef / AppDef_MyLineTool.hxx
CommitLineData
42cf5bc1 1// Created on: 1993-01-20
2// Created by: Laurent PAINNOT
3// Copyright (c) 1993-1999 Matra Datavision
4// Copyright (c) 1999-2014 OPEN CASCADE SAS
5//
6// This file is part of Open CASCADE Technology software library.
7//
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.
13//
14// Alternatively, this file may be used under the terms of Open CASCADE
15// commercial license or contractual agreement.
16
17#ifndef _AppDef_MyLineTool_HeaderFile
18#define _AppDef_MyLineTool_HeaderFile
19
20#include <Standard.hxx>
21#include <Standard_DefineAlloc.hxx>
22#include <Standard_Handle.hxx>
23
24#include <Standard_Integer.hxx>
25#include <TColgp_Array1OfPnt.hxx>
26#include <TColgp_Array1OfPnt2d.hxx>
27#include <Standard_Boolean.hxx>
28#include <TColgp_Array1OfVec.hxx>
29#include <TColgp_Array1OfVec2d.hxx>
30#include <Approx_Status.hxx>
31class AppDef_MultiLine;
32
33
34//! example of MultiLine tool corresponding to the tools of the packages
35//! AppParCurves and Approx. For Approx, the tool will not addd points
36//! if the algorithms want some.
37class AppDef_MyLineTool
38{
39public:
40
41 DEFINE_STANDARD_ALLOC
42
43
44 //! Returns the first index of multipoints of the MultiLine.
45 Standard_EXPORT static Standard_Integer FirstPoint (const AppDef_MultiLine& ML);
46
47 //! Returns the last index of multipoints of the MultiLine.
48 Standard_EXPORT static Standard_Integer LastPoint (const AppDef_MultiLine& ML);
49
50 //! Returns the number of 2d points of a MultiLine.
51 Standard_EXPORT static Standard_Integer NbP2d (const AppDef_MultiLine& ML);
52
53 //! Returns the number of 3d points of a MultiLine.
54 Standard_EXPORT static Standard_Integer NbP3d (const AppDef_MultiLine& ML);
55
56 //! returns the 3d points of the multipoint <MPointIndex>
57 //! when only 3d points exist.
58 Standard_EXPORT static void Value (const AppDef_MultiLine& ML, const Standard_Integer MPointIndex, TColgp_Array1OfPnt& tabPt);
59
60 //! returns the 2d points of the multipoint <MPointIndex>
61 //! when only 2d points exist.
62 Standard_EXPORT static void Value (const AppDef_MultiLine& ML, const Standard_Integer MPointIndex, TColgp_Array1OfPnt2d& tabPt2d);
63
64 //! returns the 3d and 2d points of the multipoint
65 //! <MPointIndex>.
66 Standard_EXPORT static void Value (const AppDef_MultiLine& ML, const Standard_Integer MPointIndex, TColgp_Array1OfPnt& tabPt, TColgp_Array1OfPnt2d& tabPt2d);
67
68 //! returns the 3d points of the multipoint <MPointIndex>
69 //! when only 3d points exist.
70 Standard_EXPORT static Standard_Boolean Tangency (const AppDef_MultiLine& ML, const Standard_Integer MPointIndex, TColgp_Array1OfVec& tabV);
71
72 //! returns the 2d tangency points of the multipoint
73 //! <MPointIndex> only when 2d points exist.
74 Standard_EXPORT static Standard_Boolean Tangency (const AppDef_MultiLine& ML, const Standard_Integer MPointIndex, TColgp_Array1OfVec2d& tabV2d);
75
76 //! returns the 3d and 2d points of the multipoint
77 //! <MPointIndex>.
78 Standard_EXPORT static Standard_Boolean Tangency (const AppDef_MultiLine& ML, const Standard_Integer MPointIndex, TColgp_Array1OfVec& tabV, TColgp_Array1OfVec2d& tabV2d);
79
80 //! returns the 3d curvatures of the multipoint <MPointIndex>
81 //! when only 3d points exist.
82 Standard_EXPORT static Standard_Boolean Curvature (const AppDef_MultiLine& ML, const Standard_Integer MPointIndex, TColgp_Array1OfVec& tabV);
83
84 //! returns the 2d curvatures of the multipoint
85 //! <MPointIndex> only when 2d points exist.
86 Standard_EXPORT static Standard_Boolean Curvature (const AppDef_MultiLine& ML, const Standard_Integer MPointIndex, TColgp_Array1OfVec2d& tabV2d);
87
88 //! returns the 3d and 2d curvatures of the multipoint
89 //! <MPointIndex>.
90 Standard_EXPORT static Standard_Boolean Curvature (const AppDef_MultiLine& ML, const Standard_Integer MPointIndex, TColgp_Array1OfVec& tabV, TColgp_Array1OfVec2d& tabV2d);
91
92 //! returns NoPointsAdded
93 Standard_EXPORT static Approx_Status WhatStatus (const AppDef_MultiLine& ML, const Standard_Integer I1, const Standard_Integer I2);
94
95 //! Is never called in the algorithms.
96 //! Nothing is done.
97 Standard_EXPORT static AppDef_MultiLine& MakeMLBetween (const AppDef_MultiLine& ML, const Standard_Integer I1, const Standard_Integer I2, const Standard_Integer NbPMin);
98
99
100
101
102protected:
103
104
105
106
107
108private:
109
110
111
112
113
114};
115
116
117
118
119
120
121
122#endif // _AppDef_MyLineTool_HeaderFile