0027961: Visualization - remove unused and no more working OpenGl_AVIWriter
[occt.git] / src / TopTools / TopTools_LocationSet.hxx
CommitLineData
42cf5bc1 1// Created on: 1993-07-16
2// Created by: Remi LEQUETTE
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 _TopTools_LocationSet_HeaderFile
18#define _TopTools_LocationSet_HeaderFile
19
20#include <Standard.hxx>
21#include <Standard_DefineAlloc.hxx>
22#include <Standard_Handle.hxx>
23
24#include <TopLoc_IndexedMapOfLocation.hxx>
25#include <Standard_Integer.hxx>
26#include <Standard_OStream.hxx>
27#include <Standard_IStream.hxx>
28class Message_ProgressIndicator;
29class Standard_OutOfRange;
30class TopLoc_Location;
31
32
33//! The class LocationSet stores a set of location in
34//! a relocatable state.
35//!
36//! It can be created from Locations.
37//!
38//! It can create Locations.
39//!
40//! It can be write and read from a stream.
41class TopTools_LocationSet
42{
43public:
44
45 DEFINE_STANDARD_ALLOC
46
47
48 //! Returns an empty set of locations.
49 Standard_EXPORT TopTools_LocationSet();
50
51 //! Clears the content of the set.
52 Standard_EXPORT void Clear();
53
54 //! Incorporate a new Location in the set and returns
55 //! its index.
56 Standard_EXPORT Standard_Integer Add (const TopLoc_Location& L);
57
58 //! Returns the location of index <I>.
59 Standard_EXPORT const TopLoc_Location& Location (const Standard_Integer I) const;
60
61 //! Returns the index of <L>.
62 Standard_EXPORT Standard_Integer Index (const TopLoc_Location& L) const;
63
64 //! Dumps the content of me on the stream <OS>.
65 Standard_EXPORT void Dump (Standard_OStream& OS) const;
66
67 //! Writes the content of me on the stream <OS> in a
68 //! format that can be read back by Read.
69 Standard_EXPORT void Write (Standard_OStream& OS) const;
70
71 //! Reads the content of me from the stream <IS>. me
72 //! is first cleared.
73 Standard_EXPORT void Read (Standard_IStream& IS);
74
75 Standard_EXPORT void SetProgress (const Handle(Message_ProgressIndicator)& PR);
76
77 Standard_EXPORT Handle(Message_ProgressIndicator) GetProgress() const;
78
79
80
81
82protected:
83
84
85
86
87
88private:
89
90
91
92 TopLoc_IndexedMapOfLocation myMap;
93 Handle(Message_ProgressIndicator) myProgress;
94
95
96};
97
98
99
100
101
102
103
104#endif // _TopTools_LocationSet_HeaderFile