0027067: Avoid use of virtual methods for implementation of destructors in legacy...
[occt.git] / src / ShapeUpgrade / ShapeUpgrade_ShapeDivide.hxx
CommitLineData
42cf5bc1 1// Created on: 1999-04-26
2// Created by: Pavel DURANDIN
3// Copyright (c) 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 _ShapeUpgrade_ShapeDivide_HeaderFile
18#define _ShapeUpgrade_ShapeDivide_HeaderFile
19
20#include <Standard.hxx>
21#include <Standard_DefineAlloc.hxx>
22#include <Standard_Handle.hxx>
23
24#include <TopoDS_Shape.hxx>
25#include <Standard_Real.hxx>
26#include <Standard_Boolean.hxx>
27#include <Standard_Integer.hxx>
28#include <Message_Gravity.hxx>
29#include <ShapeExtend_Status.hxx>
30class ShapeUpgrade_FaceDivide;
31class ShapeBuild_ReShape;
32class ShapeExtend_BasicMsgRegistrator;
33class TopoDS_Shape;
34class Message_Msg;
35
36
37//! Divides a all faces in shell with given criteria Shell.
38class ShapeUpgrade_ShapeDivide
39{
40public:
41
42 DEFINE_STANDARD_ALLOC
43
44
45 Standard_EXPORT ShapeUpgrade_ShapeDivide();
46
47 //! Initialize by a Shape.
48 Standard_EXPORT ShapeUpgrade_ShapeDivide(const TopoDS_Shape& S);
49
50 //! Initialize by a Shape.
51 Standard_EXPORT void Init (const TopoDS_Shape& S);
52
e6f550da 53 Standard_EXPORT virtual ~ShapeUpgrade_ShapeDivide();
42cf5bc1 54
55 //! Defines the spatial precision used for splitting
56 Standard_EXPORT void SetPrecision (const Standard_Real Prec);
57
58 //! Sets maximal allowed tolerance
59 Standard_EXPORT void SetMaxTolerance (const Standard_Real maxtol);
60
61 //! Sets minimal allowed tolerance
62 Standard_EXPORT void SetMinTolerance (const Standard_Real mintol);
63
64 //! Purpose sets mode for trimming (segment) surface by
65 //! wire UV bounds.
66 Standard_EXPORT void SetSurfaceSegmentMode (const Standard_Boolean Segment);
67
68 //! Performs splitting and computes the resulting shape
69 //! If newContext is True (default), the internal context
70 //! will be cleared at start, else previous substitutions
71 //! will be acting.
72 Standard_EXPORT virtual Standard_Boolean Perform (const Standard_Boolean newContext = Standard_True);
73
74 //! Gives the resulting Shape, or Null shape if not done.
75 Standard_EXPORT TopoDS_Shape Result() const;
76
77 //! Returns context with all the modifications made during
78 //! last call(s) to Perform() recorded
79 Standard_EXPORT Handle(ShapeBuild_ReShape) GetContext() const;
80
81 //! Sets context with recorded modifications to be applied
82 //! during next call(s) to Perform(shape,Standard_False)
83 Standard_EXPORT void SetContext (const Handle(ShapeBuild_ReShape)& context);
84
85 //! Sets message registrator
86 Standard_EXPORT virtual void SetMsgRegistrator (const Handle(ShapeExtend_BasicMsgRegistrator)& msgreg);
87
88 //! Returns message registrator
89 Standard_EXPORT Handle(ShapeExtend_BasicMsgRegistrator) MsgRegistrator() const;
90
91 //! Sends a message to be attached to the shape.
92 //! Calls corresponding message of message registrator.
93 Standard_EXPORT void SendMsg (const TopoDS_Shape& shape, const Message_Msg& message, const Message_Gravity gravity = Message_Info) const;
94
95 //! Queries the status of last call to Perform
96 //! OK : no splitting was done (or no call to Perform)
97 //! DONE1: some edges were splitted
98 //! DONE2: surface was splitted
99 //! FAIL1: some errors occured
100 Standard_EXPORT Standard_Boolean Status (const ShapeExtend_Status status) const;
101
102 //! Sets the tool for splitting faces.
103 Standard_EXPORT void SetSplitFaceTool (const Handle(ShapeUpgrade_FaceDivide)& splitFaceTool);
104
105 //! Sets mode for splitting 3d curves from edges.
106 //! 0 - only curve 3d from free edges.
107 //! 1 - only curve 3d from shared edges.
108 //! 2 - all curve 3d.
109 Standard_EXPORT void SetEdgeMode (const Standard_Integer aEdgeMode);
110
111
112
113
114protected:
115
116
117 //! Returns the tool for splitting faces.
118 Standard_EXPORT virtual Handle(ShapeUpgrade_FaceDivide) GetSplitFaceTool() const;
119
120 Standard_EXPORT virtual Message_Msg GetFaceMsg() const;
121
122 Standard_EXPORT virtual Message_Msg GetWireMsg() const;
123
124 //! Returns a message decsribing modification of a shape.
125 Standard_EXPORT virtual Message_Msg GetEdgeMsg() const;
126
127
128 Handle(ShapeBuild_ReShape) myContext;
129 Handle(ShapeExtend_BasicMsgRegistrator) myMsgReg;
130 TopoDS_Shape myShape;
131 TopoDS_Shape myResult;
132 Standard_Real myPrecision;
133 Standard_Real myMinTol;
134 Standard_Real myMaxTol;
135 Standard_Boolean mySegmentMode;
136 Standard_Integer myStatus;
137 Standard_Integer myEdgeMode;
138
139
140private:
141
142
143
144 Handle(ShapeUpgrade_FaceDivide) mySplitFaceTool;
145
146
147};
148
149
150
151
152
153
154
155#endif // _ShapeUpgrade_ShapeDivide_HeaderFile