projects / occt.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Update of header of files in context of License text
[occt.git] / src / Graphic3d / Graphic3d_GraphicDriver.cdl
CommitLineData
b311480e 1-- Created on: 1997-01-28
2-- Created by: CAL
3-- Copyright (c) 1997-1999 Matra Datavision
973c2be1 4-- Copyright (c) 1999-2014 OPEN CASCADE SAS
7fd59977 5--
973c2be1 6-- This file is part of Open CASCADE Technology software library.
b311480e 7--
d5f74e42 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
973c2be1 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.
b311480e 13--
973c2be1 14-- Alternatively, this file may be used under the terms of Open CASCADE
15-- commercial license or contractual agreement.
b311480e 16
6942f04a 17deferred class GraphicDriver from Graphic3d inherits TShared
7fd59977 18
19 ---Version:
20
2166f0fa 21 ---Purpose: This class allows the definition of a graphic driver
ff8178ef 22 -- for 3d interface (currently only OpenGl driver is used).
7fd59977 23
2166f0fa 24 ---Keywords: OpenGl
7fd59977 25
26 ---Warning:
27 ---References:
28
29uses
30
31 SharedLibrary from OSD,
32
33 Array1OfInteger from TColStd,
34 Array1OfReal from TColStd,
35 Array2OfReal from TColStd,
36
f0430952 37 AsciiString from TCollection,
7fd59977 38 ExtendedString from TCollection,
39
40 NameOfColor from Quantity,
41 Color from Quantity,
42
43 PlaneAngle from Quantity,
44
692613e5 45 PixMap from Image,
7fd59977 46
47 Array1OfEdge from Aspect,
48 CLayer2d from Aspect,
7fd59977 49 TypeOfTriedronEcho from Aspect,
50 TypeOfTriedronPosition from Aspect,
51 Handle from Aspect,
52 Display from Aspect,
7edf74fd 53 PrintAlgo from Aspect,
dc3fe572 54 DisplayConnection_Handle from Aspect,
7fd59977 55
c5751993 56 ZLayerSettings from Graphic3d,
57
7fd59977 58 AspectLine3d from Graphic3d,
59 AspectMarker3d from Graphic3d,
60 AspectText3d from Graphic3d,
61 AspectFillArea3d from Graphic3d,
62 HorizontalTextAlignment from Graphic3d,
63 CBitFields20 from Graphic3d,
b64d84be 64 Group from Graphic3d,
7fd59977 65 CLight from Graphic3d,
66 CPick from Graphic3d,
67 CPlane from Graphic3d,
68 CStructure from Graphic3d,
63bcc448 69 CStructure_Handle from Graphic3d,
7fd59977 70 CView from Graphic3d,
692613e5 71 BufferType from Graphic3d,
7fd59977 72 Structure from Graphic3d,
63bcc448 73 StructureManager from Graphic3d,
7fd59977 74 TextPath from Graphic3d,
75 TypeOfComposition from Graphic3d,
7fd59977 76 TypeOfPrimitive from Graphic3d,
77 Vector from Graphic3d,
78 Array1OfVertex from Graphic3d,
79 Array2OfVertex from Graphic3d,
80 Vertex from Graphic3d,
7fd59977 81 VerticalTextAlignment from Graphic3d,
7fd59977 82 PtrFrameBuffer from Graphic3d,
83 HArray1OfByte from TColStd,
84 FillMethod from Aspect,
85 GradientFillMethod from Aspect,
86 ExportFormat from Graphic3d,
87 SortType from Graphic3d,
88 HArray1OfReal from TColStd,
89 CUserDraw from Graphic3d,
90 NListOfHAsciiString from Graphic3d,
eeaaaefb 91 FontAspect from Font,
4269bd1b 92 CGraduatedTrihedron from Graphic3d,
938d4544 93 ClipPlane from Graphic3d,
94 Ax2 from gp
7fd59977 95
96raises
97
98 TransformError from Graphic3d
99
100is
101 Initialize ( AShrName : CString from Standard )
6e33d3ce 102 returns GraphicDriver from Graphic3d;
7fd59977 103 ---Level: Public
104 ---Purpose: Initialises the Driver
105
106 -------------------------
107 -- Category: Init methods
108 -------------------------
109
dc3fe572 110 Begin (me: mutable;
111 theDisplayConnection: DisplayConnection_Handle from Aspect)
112 returns Boolean from Standard
113 is deferred;
114 ---Purpose: Starts graphic driver with given connection
7fd59977 115
116 End ( me : mutable )
117 is deferred;
118 ---Purpose: call_togl_end
119
120 ----------------------------
121 -- Category: Inquire methods
122 ----------------------------
123
124 InquireLightLimit ( me : mutable )
125 returns Integer from Standard
126 is deferred;
127 ---Purpose: call_togl_inquirelight
128
7fd59977 129 InquirePlaneLimit ( me : mutable )
130 returns Integer from Standard
131 is deferred;
132 ---Purpose: call_togl_inquireplane
133
134 InquireViewLimit ( me : mutable )
135 returns Integer from Standard
136 is deferred;
137 ---Purpose: call_togl_inquireview
138
7fd59977 139 -----------------------------------------
140 -- Category: Structure management methods
141 -----------------------------------------
142
63bcc448 143 DisplayStructure ( me : mutable;
144 theCView : CView from Graphic3d;
145 theCStructure : in out CStructure from Graphic3d;
146 thePriority : Integer from Standard )
7fd59977 147 is deferred;
148 ---Purpose: call_togl_displaystructure
149
63bcc448 150 EraseStructure ( me : mutable;
151 theCView : CView from Graphic3d;
152 theCStructure : in out CStructure from Graphic3d )
7fd59977 153 is deferred;
154 ---Purpose: call_togl_erasestructure
155
156 RemoveStructure ( me : mutable;
63bcc448 157 theCStructure : in out CStructure_Handle from Graphic3d )
7fd59977 158 is deferred;
159 ---Purpose: call_togl_removestructure
160
63bcc448 161 Structure (me : mutable;
162 theManager : StructureManager from Graphic3d)
163 returns CStructure_Handle from Graphic3d
7fd59977 164 is deferred;
63bcc448 165 ---Purpose: Creates new empty graphic structure
7fd59977 166
7fd59977 167 ------------------------------------
168 -- Category: Structured mode methods
169 ------------------------------------
170
171 ActivateView ( me : mutable;
172 ACView : CView from Graphic3d )
173 is deferred;
174 ---Purpose: call_togl_activateview
175
176 AntiAliasing ( me : mutable;
177 ACView : CView from Graphic3d;
178 AFlag : Boolean from Standard )
179 is deferred;
180 ---Purpose: call_togl_antialiasing
181
182 Background ( me : mutable;
183 ACView : CView from Graphic3d )
184 is deferred;
185 ---Purpose: call_togl_background
186
187 GradientBackground ( me : mutable;
188 ACView : CView from Graphic3d;
189 AColor1: Color from Quantity;
190 AColor2: Color from Quantity;
191 FillStyle : GradientFillMethod from Aspect
192 )
2166f0fa 193 is deferred;
7fd59977 194 ---Purpose: call_togl_gradient_background
195
196
197 BackgroundImage( me : mutable;
198 FileName : CString from Standard;
199 ACView : CView from Graphic3d;
200 FillStyle : FillMethod from Aspect )
201 is deferred;
202
203 SetBgImageStyle( me : mutable;
204 ACView : CView from Graphic3d;
205 FillStyle : FillMethod from Aspect )
206 is deferred;
207
208 SetBgGradientStyle( me : mutable;
209 ACView : CView from Graphic3d;
210 FillStyle : GradientFillMethod from Aspect )
2166f0fa 211 is deferred;
7fd59977 212
213 ClipLimit ( me : mutable;
214 ACView : CView from Graphic3d;
215 AWait : Boolean from Standard )
216 is deferred;
217 ---Purpose: call_togl_cliplimit
218
219 DeactivateView ( me : mutable;
220 ACView : CView from Graphic3d )
221 is deferred;
222 ---Purpose: call_togl_deactivateview
223
224 DepthCueing ( me : mutable;
225 ACView : CView from Graphic3d;
226 AFlag : Boolean from Standard )
227 is deferred;
228 ---Purpose: call_togl_cliplimit
229
7fd59977 230 RatioWindow ( me : mutable;
231 ACView : CView from Graphic3d )
232 is deferred;
233 ---Purpose: call_togl_ratio_window
234
235 Redraw ( me : mutable;
679ecdee 236 theCView : CView from Graphic3d;
237 theCUnderLayer : CLayer2d from Aspect;
238 theCOverLayer : CLayer2d from Aspect;
239 theX : Integer = 0;
240 theY : Integer = 0;
241 theWidth : Integer = 0;
242 theHeight : Integer = 0 )
243 is deferred;
244 ---Purpose: Redraw content of the view
245
246 RedrawImmediate ( me : mutable;
247 theCView : CView from Graphic3d;
248 theCUnderLayer : CLayer2d from Aspect;
249 theCOverLayer : CLayer2d from Aspect )
250 is deferred;
251 ---Purpose: Redraw layer of immediate presentations
252
253 Invalidate ( me : mutable;
254 theCView : CView from Graphic3d )
255 is deferred;
256 ---Purpose: Invalidates content of the view but does not redraw it
7fd59977 257
258 RemoveView ( me : mutable;
259 ACView : CView from Graphic3d )
260 is deferred;
261 ---Purpose: call_togl_removeview
262
263 SetLight ( me : mutable;
264 ACView : CView from Graphic3d )
265 is deferred;
266 ---Purpose: call_togl_setlight
267
4269bd1b 268 SetClipPlanes (me : mutable; theCView : CView from Graphic3d) is deferred;
269 ---Purpose: Pass clip planes to the associated graphic driver view.
270
b5ac8292 271 SetCamera (me : mutable; theCView : CView from Graphic3d)
272 is deferred;
273 ---Purpose: Inform graphic driver if camera assigned to view changes.
274
7fd59977 275 SetVisualisation ( me : mutable;
276 ACView : CView from Graphic3d )
277 is deferred;
278 ---Purpose: call_togl_setvisualisation
279
7fd59977 280 Transparency ( me : mutable;
281 ACView : CView from Graphic3d;
282 AFlag : Boolean from Standard )
283 is deferred;
284 ---Purpose: call_togl_transparency
285
7fd59977 286 View ( me : mutable;
287 ACView : in out CView from Graphic3d )
288 returns Boolean from Standard
289 is deferred;
290 ---Purpose: call_togl_view
291
7fd59977 292 Environment ( me : mutable;
293 ACView : CView from Graphic3d )
294 is deferred;
295 ---Purpose:
296
7fd59977 297 ----------------------------------------
298 ---Category: Methods to create Triangle
299 -- for Purpose : see Graphic3d_Group.cdl
300 ----------------------------------------
301
7fd59977 302 EnableVBO( me : mutable;
303 status : Boolean from Standard )
2166f0fa 304 is deferred;
7fd59977 305 ---Purpose: enables/disables usage of OpenGL vertex buffer arrays while drawing primitiev arrays
306
f0430952 307 MemoryInfo (me;
308 theFreeBytes : out Size from Standard;
309 theInfo : out AsciiString from TCollection) returns Boolean from Standard is deferred;
310 ---Purpose: Returns information about GPU memory usage.
311
7fd59977 312 ----------------------------------------
313 ---Category: Methods to create Triedron
314 -- for Purpose : see Graphic3d_Group.cdl
315 ----------------------------------------
316
317 ZBufferTriedronSetup ( me : mutable;
318 XColor : NameOfColor from Quantity = Quantity_NOC_RED;
319 YColor : NameOfColor from Quantity = Quantity_NOC_GREEN;
320 ZColor : NameOfColor from Quantity = Quantity_NOC_BLUE1;
321 SizeRatio : Real from Standard = 0.8;
322 AxisDiametr : Real from Standard = 0.05;
323 NbFacettes : Integer from Standard = 12)
324 is deferred;
325 ---Purpose: call_togl_ztriedron_setup
326
327 TriedronDisplay ( me : mutable;
328 ACView : CView from Graphic3d;
329 APosition : TypeOfTriedronPosition from Aspect = Aspect_TOTP_CENTER;
330 AColor : NameOfColor from Quantity = Quantity_NOC_WHITE ;
331 AScale : Real from Standard = 0.02;
332 AsWireframe : Boolean from Standard = Standard_True )
333 is deferred;
334 ---Purpose: call_togl_triedron_display
335
336
337 TriedronErase ( me : mutable;
338 ACView : CView from Graphic3d)
339 is deferred;
340 ---Purpose: call_togl_triedron_erase
341
342
343 TriedronEcho ( me : mutable;
344 ACView : CView from Graphic3d;
345 AType : TypeOfTriedronEcho from Aspect = Aspect_TOTE_NONE )
346 is deferred;
347 ---Purpose: call_togl_triedron_echo
348
349 ---------------------------------
350 ---Category: Graduated trihedron
351 ---------------------------------
352
7fd59977 353 GraduatedTrihedronDisplay(me : mutable;
354 view : CView from Graphic3d;
13a22457 355 cubic : CGraduatedTrihedron from Graphic3d)
7fd59977 356 ---Purpose: call_togl_graduatedtrihedron_display
357 is deferred;
358
359 GraduatedTrihedronErase(me : mutable;
360 view : CView from Graphic3d)
361 ---Purpose: call_togl_graduatedtrihedron_erase
362 is deferred;
363
364 GraduatedTrihedronMinMaxValues(me : mutable;
365 xmin : ShortReal from Standard;
366 ymin : ShortReal from Standard;
367 zmin : ShortReal from Standard;
368 xmax : ShortReal from Standard;
369 ymax : ShortReal from Standard;
370 zmax : ShortReal from Standard)
371 ---Purpose: call_togl_graduatedtrihedron_minmaxvalues
372 is deferred;
373
7fd59977 374 ----------------------------------
679ecdee 375 -- Category: Immediate mode methods
7fd59977 376 ----------------------------------
377
1981cb22 378 SetImmediateModeDrawToFront (me : mutable;
379 theCView : CView from Graphic3d;
380 theDrawToFrontBuffer : Boolean from Standard)
381 returns Boolean from Standard
382 is deferred;
383 ---Purpose: @param theDrawToFrontBuffer Advanced option to modify rendering mode:
384 -- 1. TRUE. Drawing immediate mode structures directly to the front buffer over the scene image.
385 -- Fast, so preferred for interactive work (used by default).
386 -- However these extra drawings will be missed in image dump since it is performed from back buffer.
387 -- Notice that since no pre-buffering used the V-Sync will be ignored and rendering could be seen
388 -- in run-time (in case of slow hardware) and/or tearing may appear.
389 -- So this is strongly recommended to draw only simple (fast) structures.
390 -- 2. FALSE. Drawing immediate mode structures to the back buffer.
391 -- The complete scene is redrawn first, so this mode is slower if scene contains complex data and/or V-Sync is turned on.
392 -- But it works in any case and is especially useful for view dump because the dump image is read from the back buffer.
393 -- @return previous mode.
394
679ecdee 395 DisplayImmediateStructure ( me : mutable;
396 theCView : CView from Graphic3d;
397 theCStructure : CStructure from Graphic3d )
398 is deferred;
399 ---Purpose: Display structure in immediate mode on top of general presentation
7fd59977 400
679ecdee 401 EraseImmediateStructure ( me : mutable;
402 theCView : CView from Graphic3d;
403 theCStructure : CStructure from Graphic3d )
404 is deferred;
405 ---Purpose: Erases immediate structure
7fd59977 406
7fd59977 407 -------------------------------
408 -- Category: Layer mode methods
409 -------------------------------
410
411 Layer ( me : mutable;
412 ACLayer : in out CLayer2d from Aspect )
413 is deferred;
414 ---Purpose: call_togl_layer2d
415
416 RemoveLayer ( me : mutable;
417 ACLayer : CLayer2d from Aspect )
418 is deferred;
419 ---Purpose: call_togl_removelayer2d
420
421 BeginLayer ( me : mutable;
422 ACLayer : CLayer2d from Aspect )
423 is deferred;
424 ---Purpose: call_togl_begin_layer2d
425
426 BeginPolygon2d ( me : mutable )
427 is deferred;
428 ---Purpose: call_togl_begin_polygon2d
429
430 BeginPolyline2d ( me : mutable )
431 is deferred;
432 ---Purpose: call_togl_begin_polyline2d
433
434 ClearLayer ( me : mutable;
435 ACLayer : CLayer2d from Aspect )
436 is deferred;
437 ---Purpose: call_togl_clear_layer2d
438
439 Draw ( me : mutable;
440 X : ShortReal from Standard;
441 Y : ShortReal from Standard )
442 is deferred;
443 ---Purpose: call_togl_draw2d
444
445 Edge ( me : mutable;
446 X : ShortReal from Standard;
447 Y : ShortReal from Standard )
448 is deferred;
449 ---Purpose: call_togl_edge2d
450
451 EndLayer ( me : mutable )
452 is deferred;
453 ---Purpose: call_togl_end_layer2d
454
455 EndPolygon2d ( me : mutable )
456 is deferred;
457 ---Purpose: call_togl_end_polygon2d
458
459 EndPolyline2d ( me : mutable )
460 is deferred;
461 ---Purpose: call_togl_end_polyline2d
462
463 Move ( me : mutable;
464 X : ShortReal from Standard;
465 Y : ShortReal from Standard )
466 is deferred;
467 ---Purpose: call_togl_move2d
468
469 Rectangle ( me : mutable;
470 X, Y : ShortReal from Standard;
471 Width, Height : ShortReal from Standard )
472 is deferred;
473 ---Purpose: call_togl_rectangle2d
474
475 SetColor ( me : mutable;
476 R : ShortReal from Standard;
477 G : ShortReal from Standard;
478 B : ShortReal from Standard )
479 is deferred;
480 ---Purpose: call_togl_set_color
481
482 SetTransparency ( me : mutable;
483 ATransparency : ShortReal from Standard )
484 is deferred;
485 ---Purpose: call_togl_set_transparency
486
487 UnsetTransparency ( me : mutable )
488 is deferred;
489 ---Purpose: call_togl_unset_transparency
490
491 SetLineAttributes ( me : mutable;
492 Type : Integer from Standard;
493 Width : ShortReal from Standard )
494 is deferred;
495 ---Purpose: call_togl_set_line_attributes
496
497
498 SetTextAttributes ( me : mutable;
499 Font : CString from Standard;
500 Type : Integer from Standard;
501 R : ShortReal from Standard;
502 G : ShortReal from Standard;
503 B : ShortReal from Standard )
2166f0fa 504 is deferred;
25289ec1 505 ---Purpose: Set text attributes for under-/overlayer.
506 -- <Font> argument defines the name of the font to be used,
507 -- <Type> argument defines the display type of the text,
508 -- <R> <G> <B> values define the color of decal or subtitle background.
509 -- To set the color of the text you can use the SetColor method.
7fd59977 510
511 Text ( me : mutable;
512 AText : CString from Standard;
513 X, Y : ShortReal from Standard;
514 AHeight : ShortReal from Standard )
515 is deferred;
516 ---Purpose: call_togl_text2d
517 -- If AHeight < 0 default text height is used by driver (DefaultTextHeight method)
518
519 DefaultTextHeight( me )
520 returns ShortReal from Standard
521 is deferred;
522
523
524 TextSize( me;
525 AText : CString from Standard;
526 AHeight : ShortReal from Standard;
527 AWidth : in out ShortReal from Standard;
528 AnAscent : in out ShortReal from Standard;
529 ADescent : in out ShortReal from Standard )
530 is deferred;
531 ---Purpose: call_togl_textsize2d
532
533 SetBackFacingModel ( me : mutable;
534 aView : CView from Graphic3d )
535 is deferred;
536 ---Purpose: call_togl_backfacing
537
538 SetDepthTestEnabled( me; view : CView from Graphic3d;
539 isEnabled : Boolean from Standard )
540 is deferred;
541 ---Purpose: call_togl_depthtest
542
543 IsDepthTestEnabled( me; view : CView from Graphic3d )
544 returns Boolean from Standard is deferred;
545 ---Purpose: call_togl_isdepthtest
546
547 ReadDepths( me;
548 view : CView from Graphic3d;
549 x, y : Integer;
550 width, height : Integer;
551 buffer : Address )
552 is deferred;
553 ---Purpose: Reads depths of shown pixels of the given
554 -- rectangle (glReadPixels with GL_DEPTH_COMPONENT)
555
556 FBOCreate( me : mutable;
557 view : CView from Graphic3d;
558 width, height : Integer from Standard )
559 returns PtrFrameBuffer from Graphic3d
560 is deferred;
561 ---Purpose: Generate offscreen FBO in the graphic library.
562 -- If not supported on hardware returns NULL.
563
564 FBORelease( me : mutable;
565 view : CView from Graphic3d;
566 fboPtr : in out PtrFrameBuffer from Graphic3d )
567 is deferred;
568 ---Purpose: Remove offscreen FBO from the graphic library
569
570 FBOGetDimensions( me : mutable;
571 view : CView from Graphic3d;
572 fboPtr : PtrFrameBuffer from Graphic3d;
573 width, height : out Integer from Standard;
574 widthMax, heightMax : out Integer from Standard )
575 is deferred;
576 ---Purpose: Read offscreen FBO configuration.
577
578 FBOChangeViewport( me : mutable;
579 view : CView from Graphic3d;
580 fboPtr : in out PtrFrameBuffer from Graphic3d;
581 width, height : Integer from Standard )
582 is deferred;
583 ---Purpose: Change offscreen FBO viewport.
584
585 BufferDump( me : mutable;
692613e5 586 theCView : CView from Graphic3d;
587 theImage : in out PixMap from Image;
588 theBufferType : BufferType from Graphic3d )
7fd59977 589 returns Boolean from Standard
590 is deferred;
591 ---Purpose: Dump active rendering buffer into specified memory buffer.
592
593 SetGLLightEnabled( me; view : CView from Graphic3d;
594 isEnabled : Boolean from Standard )
595 is deferred;
596 ---Purpose: call_togl_gllight
597
598 IsGLLightEnabled( me; view : CView from Graphic3d )
599 returns Boolean from Standard is deferred;
600 ---Purpose: call_togl_isgllight
601
602 Print (me;
603 ACView : CView from Graphic3d;
604 ACUnderLayer : CLayer2d from Aspect;
605 ACOverLayer : CLayer2d from Aspect;
606 hPrnDC : Handle from Aspect;
607 showBackground : Boolean;
7edf74fd
A		 608 filename : CString;
609 printAlgorithm : PrintAlgo from Aspect = Aspect_PA_STRETCH;
610 theScaleFactor : Real from Standard = 1.0 )
611 returns Boolean from Standard is deferred;
7fd59977 612 ---Level: Internal
613 ---Purpose: print the contents of all layers of the view to the printer.
614 -- <hPrnDC> : Pass the PrinterDeviceContext (HDC),
615 -- <showBackground> : When set to FALSE then print the view without background color
616 -- (background is white)
617 -- else set to TRUE for printing with current background color.
618 -- <filename>: If != NULL, then the view will be printed to a file.
7edf74fd
A		 619 -- <printAlgorithm>: Select print algorithm: stretch, tile.
620 -- <theScaleFactor>: Scaling coefficient, used internally to scale the
621 -- printings accordingly to the scale factor selected in the printer
622 -- properties dialog.
623 -- Returns Standard_True if the data is passed to the printer, otherwise
624 -- Standard_False if the print operation failed due to the printer errors,
625 -- or insufficient system memory available.
7fd59977 626 ---Warning: Works only under Windows.
627
7fd59977 628 Export( me: mutable;
5cedc27f
K		 629 theFileName : CString from Standard;
630 theFormat : ExportFormat from Graphic3d;
631 theSortType : SortType from Graphic3d;
632 theWidth, theHeight : Integer from Standard;
633 theView : CView from Graphic3d;
634 theLayerUnder : CLayer2d from Aspect;
635 theLayerOver : CLayer2d from Aspect;
636 thePrecision : Real from Standard = 0.005;
637 theProgressBarFunc : Address from Standard = NULL;
638 theProgressObject : Address from Standard = NULL )
639 returns Boolean from Standard
640 is deferred;
641 ---Purpose:
642 -- Export scene into the one of the Vector graphics formats (SVG, PS, PDF...).
643 -- In contrast to Bitmaps, Vector graphics is scalable (so you may got quality benefits on printing to laser printer).
644 -- Notice however that results may differ a lot and do not contain some elements.
7fd59977 645
b7cd4ba7 646 InvalidateBVHData( me : mutable;
647 theCView : out CView from Graphic3d;
648 theLayerId : Integer from Standard )
649 is deferred;
650 ---Purpose:
651 -- Marks BVH tree and the set of BVH primitives of correspondent priority list with id theLayerId as outdated.
652
59f45b7c 653 AddZLayer( me : mutable;
654 theCView : CView from Graphic3d;
655 theLayerId : Integer from Standard )
656 is deferred;
657 ---Purpose: Add a new top-level z layer with ID <theLayerId> for
658 -- the view. Z layers allow drawing structures in higher layers
659 -- in foreground of structures in lower layers. To add a structure
660 -- to desired layer on display it is necessary to set the layer
661 -- ID for the structure.
662
663 RemoveZLayer( me : mutable;
664 theCView : CView from Graphic3d;
665 theLayerId : Integer from Standard )
666 is deferred;
667 ---Purpose: Remove Z layer from the specified view. All structures
668 -- displayed at the moment in layer will be displayed in default layer
669 -- ( the bottom-level z layer ). To unset layer ID from associated
670 -- structures use method UnsetZLayer (...).
671
672 UnsetZLayer( me : mutable;
673 theLayerId : Integer from Standard )
674 is deferred;
675 ---Purpose: Unset Z layer ID for all structures. The structure
676 -- indexes will be set to default layer ( the bottom-level z layer
677 -- with ID = 0 ).
678
679 ChangeZLayer( me : mutable;
680 theCStructure : CStructure from Graphic3d;
681 theLayerId : Integer from Standard )
682 is deferred;
683 ---Purpose: Change Z layer of a structure. The new z layer ID will
684 -- be used to define the associated layer for structure on display.
685
686 ChangeZLayer( me : mutable;
687 theCStructure : CStructure from Graphic3d;
688 theCView : CView from Graphic3d;
689 theNewLayerId : Integer from Standard )
690 is deferred;
691 ---Purpose: Change Z layer of a structure already presented in view.
692
693 GetZLayer( me;
694 theCStructure : CStructure from Graphic3d )
695 returns Integer from Standard is deferred;
696 ---Purpose: Get Z layer ID of structure. If the structure doesn't
697 -- exists in graphic driver, the method returns -1.
698
c5751993 699 SetZLayerSettings( me : mutable;
700 theCView : CView from Graphic3d;
701 theLayerId : Integer from Standard;
702 theSettings : ZLayerSettings from Graphic3d)
703 is deferred;
704 ---Purpose: Sets the settings for a single Z layer of specified view.
705
b7cd4ba7 706 ChangePriority( me : mutable;
707 theCStructure : CStructure from Graphic3d;
708 theCView : CView from Graphic3d;
709 theNewPriority : Integer from Standard )
710 is deferred;
711 ---Purpose: Changes the priority of a structure within its Z layer
712 -- in the specified view.
713
7fd59977 714 -----------------------------
715 -- Category: Internal methods
716 -----------------------------
717
718 PrintBoolean ( me;
719 AComment : CString from Standard;
720 AValue : Boolean from Standard );
721
7fd59977 722 PrintCLight ( me;
723 ACLight : CLight from Graphic3d;
724 AField : Integer from Standard );
725
726 PrintCPick ( me;
727 ACPick : CPick from Graphic3d;
728 AField : Integer from Standard );
7fd59977 729
730 PrintCStructure ( me;
731 ACStructure : CStructure from Graphic3d;
732 AField : Integer from Standard );
733
734 PrintCView ( me;
735 ACView : CView from Graphic3d;
736 AField : Integer from Standard );
737
738 PrintFunction ( me;
739 AFunc : CString from Standard );
740
741 PrintInteger ( me;
742 AComment : CString from Standard;
743 AValue : Integer from Standard );
744
745 PrintIResult ( me;
746 AFunc : CString from Standard;
747 AResult : Integer from Standard );
748
749 PrintShortReal ( me;
750 AComment : CString from Standard;
751 AValue : ShortReal from Standard );
752
753 PrintMatrix ( me;
754 AComment : CString from Standard;
755 AMatrix : Array2OfReal from TColStd )
756 raises TransformError from Graphic3d;
757
758 PrintString ( me;
759 AComment : CString from Standard;
760 AString : CString from Standard );
761
762 SetTrace ( me : mutable;
763 ALevel : Integer from Standard )
764 is static;
765
766 Trace ( me )
767 returns Integer from Standard
768 is static;
769
770 --ListOfAvalableFontNames( me;
771 -- lst: out NListOfHAsciiString from Graphic3d )
772 -- returns Boolean from Standard
773 -- is deferred;
774 -- Purpose: Initialize list of names of avalable system fonts
775 -- returns Standard_False if fails
776 -- ABD Integration support of system fonts (using FTGL and FreeType)
777
dc3fe572 778 GetDisplayConnection (me)
779 returns DisplayConnection_Handle from Aspect;
780 ---C++: return const &
781
782 ---Purpose: returns Handle to display connection
783
eb4320f2 784 IsDeviceLost (me)
785 returns Boolean from Standard;
786 -- Purpose: @return Standard_True in cases when the last view has been removed but some objects still present.
787
788 ResetDeviceLostFlag (me: mutable);
789 -- Purpose: Resets DeviceLostFlag to default (Standard_False) state.
790
7fd59977 791fields
792
dc3fe572 793 MyTraceLevel : Integer from Standard is protected;
794 MySharedLibrary : SharedLibrary from OSD is protected;
795 myDisplayConnection: DisplayConnection_Handle from Aspect is protected;
eb4320f2 796 myDeviceLostFlag : Boolean from Standard is protected;
7fd59977 797
798end GraphicDriver from Graphic3d;
Open CASCADE Technology repository