0023544: Texture management in TKOpenGl should be redesigned
[occt.git] / src / Graphic3d / Graphic3d_Plotter.cdl
CommitLineData
b311480e 1-- Created on: 1997-04-18
2-- Created by: JLF, CAL
3-- Copyright (c) 1997-1999 Matra Datavision
4-- Copyright (c) 1999-2012 OPEN CASCADE SAS
7fd59977 5--
b311480e 6-- The content of this file is subject to the Open CASCADE Technology Public
7-- License Version 6.5 (the "License"). You may not use the content of this file
8-- except in compliance with the License. Please obtain a copy of the License
9-- at http://www.opencascade.org and read it completely before using this file.
7fd59977 10--
b311480e 11-- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
12-- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
7fd59977 13--
b311480e 14-- The Original Code and all software distributed under the License is
15-- distributed on an "AS IS" basis, without warranty of any kind, and the
16-- Initial Developer hereby disclaims all such warranties, including without
17-- limitation, any warranties of merchantability, fitness for a particular
18-- purpose or non-infringement. Please see the License for the specific terms
19-- and conditions governing the rights and limitations under the License.
20
7fd59977 21
22deferred class Plotter from Graphic3d inherits TShared from MMgt
23
24 ---Version:
25
26 ---Purpose: This class allows the definition of a plotter
27
28 ---Keywords:
29
30 ---Warning:
31 ---References:
32
33uses
34
35 DataStructureManager from Graphic3d
36
37raises
38
39 PlotterDefinitionError from Graphic3d
40
41is
42
43 Initialize
44 ---Level: Public
45 ---Purpose: Initialise the constructor of the plotter.
46 -- Warning: Raises InitialisationError if the initialisation
47 -- of the plotter failed.
48 raises PlotterDefinitionError from Graphic3d;
49 -- if the initialisation of the plotter failed.
50
51 Destroy ( me : mutable )
52 is virtual;
53 ---Level: Public
54 ---Purpose: Deletes the plotter <me>.
55 ---C++: alias ~
56
57 ---------------------------------------------------
58 -- Category: Methods to modify the class definition
59 ---------------------------------------------------
60
61 BeginPlot ( me : mutable;
62 aProjector : DataStructureManager from Graphic3d )
63 returns Boolean from Standard
64 raises PlotterDefinitionError from Graphic3d
65 is virtual;
66 ---Level: Public
67 ---Purpose:
68 -- Warning: Returns Standard_True if plotting is enabled in the view.
69 -- Raises PlotterDefinitionError from Graphic3d
70 -- if plotting has already started.
71 ---Category: Methods to modify the class definition
72
73 EndPlot ( me : mutable )
74 raises PlotterDefinitionError from Graphic3d
75 is virtual;
76 ---Level: Public
77 ---Purpose: Stops the plotting.
78 -- Warning: Raises PlotterDefinitionError from Graphic3d
79 -- if plotting has not started yet.
80 ---Category: Methods to modify the class definition
81
82 ----------------------------
83 -- Category: Inquire methods
84 ----------------------------
85
86 PlottingState ( me )
87 returns Boolean from Standard
88 is deferred;
89 ---Level: Public
90 ---Purpose:
91 ---Category: Inquire methods
92
93--\f
94
95fields
96
97--
98-- Class : Graphic3d_Plotter
99--
100-- Purpose : Declaration of variables specific to plotters
101--
102-- Reminder : A plotter
103
104 -- the update display mode
105 MyPlottingState : Boolean from Standard is protected;
106
107end Plotter from Graphic3d;