0027961: Visualization - remove unused and no more working OpenGl_AVIWriter
[occt.git] / src / LProp3d / LProp3d_SLProps.hxx
CommitLineData
42cf5bc1 1// Created on: 2002-08-02
2// Created by: Alexander KARTOMIN (akm)
3// Copyright (c) 2002-2014 OPEN CASCADE SAS
4//
5// This file is part of Open CASCADE Technology software library.
6//
7// This library is free software; you can redistribute it and/or modify it under
8// the terms of the GNU Lesser General Public License version 2.1 as published
9// by the Free Software Foundation, with special exception defined in the file
10// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
11// distribution for complete text of the license and disclaimer of any warranty.
12//
13// Alternatively, this file may be used under the terms of Open CASCADE
14// commercial license or contractual agreement.
15
16#ifndef _LProp3d_SLProps_HeaderFile
17#define _LProp3d_SLProps_HeaderFile
18
19#include <Standard.hxx>
20#include <Standard_DefineAlloc.hxx>
21#include <Standard_Handle.hxx>
22
23#include <Standard_Real.hxx>
24#include <Standard_Integer.hxx>
25#include <gp_Pnt.hxx>
26#include <gp_Vec.hxx>
27#include <gp_Dir.hxx>
28#include <LProp_Status.hxx>
29#include <Standard_Boolean.hxx>
30class Adaptor3d_HSurface;
31class LProp_BadContinuity;
32class Standard_DomainError;
33class Standard_OutOfRange;
34class LProp_NotDefined;
35class LProp3d_SurfaceTool;
36class gp_Pnt;
37class gp_Vec;
38class gp_Dir;
39
40
41
42class LProp3d_SLProps
43{
44public:
45
46 DEFINE_STANDARD_ALLOC
47
48
36b9ff75 49 //! Initializes the local properties of the surface <S>
50 //! for the parameter values (<U>, <V>).
51 //! The current point and the derivatives are
52 //! computed at the same time, which allows an
53 //! optimization of the computation time.
54 //! <N> indicates the maximum number of derivations to
55 //! be done (0, 1, or 2). For example, to compute
56 //! only the tangent, N should be equal to 1.
57 //! <Resolution> is the linear tolerance (it is used to test
58 //! if a vector is null).
42cf5bc1 59 Standard_EXPORT LProp3d_SLProps(const Handle(Adaptor3d_HSurface)& S, const Standard_Real U, const Standard_Real V, const Standard_Integer N, const Standard_Real Resolution);
60
36b9ff75 61 //! idem as previous constructor but without setting the value
62 //! of parameters <U> and <V>.
42cf5bc1 63 Standard_EXPORT LProp3d_SLProps(const Handle(Adaptor3d_HSurface)& S, const Standard_Integer N, const Standard_Real Resolution);
64
36b9ff75 65 //! idem as previous constructor but without setting the value
66 //! of parameters <U> and <V> and the surface.
67 //! the surface can have an empty constructor.
42cf5bc1 68 Standard_EXPORT LProp3d_SLProps(const Standard_Integer N, const Standard_Real Resolution);
69
36b9ff75 70 //! Initializes the local properties of the surface S
71 //! for the new surface.
42cf5bc1 72 Standard_EXPORT void SetSurface (const Handle(Adaptor3d_HSurface)& S);
73
36b9ff75 74 //! Initializes the local properties of the surface S
75 //! for the new parameter values (<U>, <V>).
42cf5bc1 76 Standard_EXPORT void SetParameters (const Standard_Real U, const Standard_Real V);
77
36b9ff75 78 //! Returns the point.
42cf5bc1 79 Standard_EXPORT const gp_Pnt& Value() const;
80
36b9ff75 81 //! Returns the first U derivative.
82 //! The derivative is computed if it has not been yet.
42cf5bc1 83 Standard_EXPORT const gp_Vec& D1U();
84
36b9ff75 85 //! Returns the first V derivative.
86 //! The derivative is computed if it has not been yet.
42cf5bc1 87 Standard_EXPORT const gp_Vec& D1V();
88
36b9ff75 89 //! Returns the second U derivatives
90 //! The derivative is computed if it has not been yet.
42cf5bc1 91 Standard_EXPORT const gp_Vec& D2U();
92
36b9ff75 93 //! Returns the second V derivative.
94 //! The derivative is computed if it has not been yet.
42cf5bc1 95 Standard_EXPORT const gp_Vec& D2V();
96
36b9ff75 97 //! Returns the second UV cross-derivative.
98 //! The derivative is computed if it has not been yet.
42cf5bc1 99 Standard_EXPORT const gp_Vec& DUV();
100
36b9ff75 101 //! returns True if the U tangent is defined.
102 //! For example, the tangent is not defined if the
103 //! two first U derivatives are null.
42cf5bc1 104 Standard_EXPORT Standard_Boolean IsTangentUDefined();
105
36b9ff75 106 //! Returns the tangent direction <D> on the iso-V.
42cf5bc1 107 Standard_EXPORT void TangentU (gp_Dir& D);
108
36b9ff75 109 //! returns if the V tangent is defined.
110 //! For example, the tangent is not defined if the
111 //! two first V derivatives are null.
42cf5bc1 112 Standard_EXPORT Standard_Boolean IsTangentVDefined();
113
36b9ff75 114 //! Returns the tangent direction <D> on the iso-V.
42cf5bc1 115 Standard_EXPORT void TangentV (gp_Dir& D);
116
36b9ff75 117 //! Tells if the normal is defined.
42cf5bc1 118 Standard_EXPORT Standard_Boolean IsNormalDefined();
119
36b9ff75 120 //! Returns the normal direction.
42cf5bc1 121 Standard_EXPORT const gp_Dir& Normal();
122
36b9ff75 123 //! returns True if the curvature is defined.
42cf5bc1 124 Standard_EXPORT Standard_Boolean IsCurvatureDefined();
125
36b9ff75 126 //! returns True if the point is umbilic (i.e. if the
127 //! curvature is constant).
42cf5bc1 128 Standard_EXPORT Standard_Boolean IsUmbilic();
129
36b9ff75 130 //! Returns the maximum curvature
42cf5bc1 131 Standard_EXPORT Standard_Real MaxCurvature();
132
36b9ff75 133 //! Returns the minimum curvature
42cf5bc1 134 Standard_EXPORT Standard_Real MinCurvature();
135
36b9ff75 136 //! Returns the direction of the maximum and minimum curvature
137 //! <MaxD> and <MinD>
42cf5bc1 138 Standard_EXPORT void CurvatureDirections (gp_Dir& MaxD, gp_Dir& MinD);
139
36b9ff75 140 //! Returns the mean curvature.
42cf5bc1 141 Standard_EXPORT Standard_Real MeanCurvature();
142
36b9ff75 143 //! Returns the Gaussian curvature
42cf5bc1 144 Standard_EXPORT Standard_Real GaussianCurvature();
145
146
147
148
149protected:
150
151
152
153
154
155private:
156
157
158
159 Handle(Adaptor3d_HSurface) mySurf;
160 Standard_Real myU;
161 Standard_Real myV;
162 Standard_Integer myDerOrder;
163 Standard_Integer myCN;
164 Standard_Real myLinTol;
165 gp_Pnt myPnt;
166 gp_Vec myD1u;
167 gp_Vec myD1v;
168 gp_Vec myD2u;
169 gp_Vec myD2v;
170 gp_Vec myDuv;
171 gp_Dir myNormal;
172 Standard_Real myMinCurv;
173 Standard_Real myMaxCurv;
174 gp_Dir myDirMinCurv;
175 gp_Dir myDirMaxCurv;
176 Standard_Real myMeanCurv;
177 Standard_Real myGausCurv;
178 Standard_Integer mySignificantFirstDerivativeOrderU;
179 Standard_Integer mySignificantFirstDerivativeOrderV;
180 LProp_Status myUTangentStatus;
181 LProp_Status myVTangentStatus;
182 LProp_Status myNormalStatus;
183 LProp_Status myCurvatureStatus;
184
185
186};
187
188
189
190
191
192
193
194#endif // _LProp3d_SLProps_HeaderFile