f7fa813d18df5bc31ef643786b452542523baa30
[occt.git] / src / Graphic3d / Graphic3d_Plotter.cdl
1 -- Created on: 1997-04-18
2 -- Created by: JLF, CAL
3 -- Copyright (c) 1997-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 deferred class Plotter from Graphic3d inherits TShared from MMgt
18
19         ---Version:
20
21         ---Purpose: This class allows the definition of a plotter
22
23         ---Keywords:
24
25         ---Warning:
26         ---References:
27
28 uses
29
30         DataStructureManager    from Graphic3d
31
32 raises
33
34         PlotterDefinitionError  from Graphic3d
35
36 is
37
38         Initialize
39         ---Level: Public
40         ---Purpose: Initialise the constructor of the plotter.
41         --  Warning: Raises InitialisationError if the initialisation
42         --          of the plotter failed.
43         raises PlotterDefinitionError from Graphic3d;
44         -- if the initialisation of the plotter failed.
45
46         Destroy ( me     : mutable )
47                 is virtual;
48         ---Level: Public
49         ---Purpose: Deletes the plotter <me>.
50         ---C++: alias ~
51
52         ---------------------------------------------------
53         -- Category: Methods to modify the class definition
54         ---------------------------------------------------
55
56         BeginPlot ( me          : mutable;
57                     aProjector  : DataStructureManager from Graphic3d )
58                 returns Boolean from Standard
59                 raises PlotterDefinitionError from Graphic3d
60                 is virtual;
61         ---Level: Public
62         ---Purpose:
63         --  Warning: Returns Standard_True if plotting is enabled in the view.
64         --          Raises PlotterDefinitionError from Graphic3d
65         --          if plotting has already started.
66         ---Category: Methods to modify the class definition
67
68         EndPlot ( me    : mutable )
69                 raises PlotterDefinitionError from Graphic3d
70                 is virtual;
71         ---Level: Public
72         ---Purpose: Stops the plotting.
73         --  Warning: Raises PlotterDefinitionError from Graphic3d
74         --          if plotting has not started yet.
75         ---Category: Methods to modify the class definition
76
77         ----------------------------
78         -- Category: Inquire methods
79         ----------------------------
80
81         PlottingState ( me )
82                 returns Boolean from Standard
83                 is deferred;
84         ---Level: Public
85         ---Purpose: 
86         ---Category: Inquire methods
87
88 --\f
89
90 fields
91
92 --
93 -- Class        :       Graphic3d_Plotter
94 --
95 -- Purpose      :       Declaration of variables specific to plotters
96 --
97 -- Reminder     :       A plotter 
98
99         -- the update display mode
100         MyPlottingState         :       Boolean from Standard is protected;
101
102 end Plotter from Graphic3d;