0031687: Draw Harness, ViewerTest - extend command vrenderparams with option updating...
[occt.git] / src / ShapeProcessAPI / ShapeProcessAPI_ApplySequence.hxx
CommitLineData
42cf5bc1 1// Created on: 1999-06-22
2// Created by: data exchange team
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 _ShapeProcessAPI_ApplySequence_HeaderFile
18#define _ShapeProcessAPI_ApplySequence_HeaderFile
19
20#include <Standard.hxx>
21#include <Standard_DefineAlloc.hxx>
22#include <Standard_Handle.hxx>
23
24#include <TopTools_DataMapOfShapeShape.hxx>
25#include <TCollection_AsciiString.hxx>
26#include <Standard_CString.hxx>
27#include <Standard_Boolean.hxx>
28#include <TopAbs_ShapeEnum.hxx>
29class ShapeProcess_ShapeContext;
30class TopoDS_Shape;
31
32
33//! Applies one of the sequence read from resource file.
34class ShapeProcessAPI_ApplySequence
35{
36public:
37
38 DEFINE_STANDARD_ALLOC
39
40
41 //! Creates an object and loads resource file and sequence of
42 //! operators given by their names.
43 Standard_EXPORT ShapeProcessAPI_ApplySequence(const Standard_CString rscName, const Standard_CString seqName = "");
44
45 //! Returns object for managing resource file and sequence of
46 //! operators.
47 Standard_EXPORT Handle(ShapeProcess_ShapeContext)& Context();
48
49 //! Performs sequence of operators stored in myRsc.
50 //! If <fillmap> is True adds history "shape-shape" into myMap
51 //! for shape and its subshapes until level <until> (included).
52 //! If <until> is TopAbs_SHAPE, all the subshapes are considered.
53 Standard_EXPORT TopoDS_Shape PrepareShape (const TopoDS_Shape& shape, const Standard_Boolean fillmap = Standard_False, const TopAbs_ShapeEnum until = TopAbs_SHAPE);
54
55 //! Clears myMap with accumulated history.
56 Standard_EXPORT void ClearMap();
57
58 //! Returns myMap with accumulated history.
59 Standard_EXPORT const TopTools_DataMapOfShapeShape& Map() const;
60
61 //! Prints result of preparation onto the messenger of the context.
62 //! Note that results can be accumulated from previous preparations
63 //! it method ClearMap was not called before PrepareShape.
64 Standard_EXPORT void PrintPreparationResult() const;
65
66
67
68
69protected:
70
71
72
73
74
75private:
76
77
78
79 Handle(ShapeProcess_ShapeContext) myContext;
80 TopTools_DataMapOfShapeShape myMap;
81 TCollection_AsciiString mySeq;
82
83
84};
85
86
87
88
89
90
91
92#endif // _ShapeProcessAPI_ApplySequence_HeaderFile