9122586122ba7ed90d08c6d97dd2d82b7d1e6c78
[occt.git] / src / Graphic3d / Graphic3d.cdl
1 -- Created on: 1993-03-31
2 -- Created by: NW,JPB,CAL
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 -- Package  :   Graphic3d
18 -- Updated  :   Vendredi 2 Octobre 1992
19 --          Mercredi 31 Mars 1993
20 --          Mercredi 19 Janvier 1994
21 --      1/08/97 ; PCT : Ajout texture mapping
22 --      11/97 ; CAL : retrait de la dependance avec math
23 --      11/97 ; CAL : retrait des DataStructure
24 --              04/98 ; FGU : ajout champs 'TOR_EMISSION'
25 --      16-09-98; BGN: (S3819) Ajout TypeOfTriedronEcho,
26 --                             TypeOfTriedronPosition.
27 --              22-09-98; BGN: S3989 (anciennement S3819): report
28 --                             dans Aspect des TypeOfTriedron*
29 --              26-03-99 : FMN ; Compatibilite ascendante:
30 --              Ajout des anciens noms de materiaux.
31 --              09-04-99 : GG ; Compatibilite ascendante:
32 --                         NameOfPhysicalMaterial disparait
33 --              23-11-99 : GG ; Add material name DEFAULT
34 --          16-06-2000 : ATS : Study G005: class ArrayOfPrimitives
35 --              and derivated used for model presentation.
36 --                       Required: enumeration TypeOfPrimitive;
37 --                  imported PrimitiveArray; class PrimitiveList.
38 --      17-12-01 : GG ; IMP171201 : Add material name UserDefined
39 --              Thanks to Stephane ROUTELOUS
40 --              20-01-2009 : ABD Integration support of system fonts (using FTGL and FreeType)
41 -- Objective    :   Specifications definitives
42
43 package Graphic3d
44
45     ---Version:
46
47     ---Purpose: This package permits the creation of 3d graphic objects
48     --      in a visualiser.
49     --      These objects, called structures, are composed of groups of
50     --      primitives and attributes.
51     --      The group is the smallest editable element of a structure.
52     --      A structure can be displayed, erased, high-lighted.
53     --      A transformation can be applied to it.
54     --      Structures can be connected to form a tree of structures,
55     --      composed by transformations.
56     --      The visualiser permits global manipulation of structures.
57
58     ---Keywords: Structure, Group, Primitives, Line, Marker, Text,
59     --  FillAreas, Vertex, Vector, Material, Font, Shading
60     ---Warning:
61     ---References:
62
63 uses
64
65     TCollection,
66     TColStd,
67     TColgp,
68     OSD,
69     Quantity,
70     Aspect,
71     MMgt,
72     WNT,
73     Image,
74     gp,
75     Font
76 is
77
78     -----------------------
79     -- Category: Exceptions
80     -----------------------
81
82     exception AspectTextDefinitionError inherits OutOfRange;
83     ---Category: Exceptions
84
85     exception CycleError inherits DomainError;
86     ---Category: Exceptions
87
88     exception GroupDefinitionError inherits OutOfRange;
89     ---Category: Exceptions
90
91     exception InitialisationError inherits OutOfRange;
92     ---Category: Exceptions
93
94     exception MaterialDefinitionError inherits OutOfRange;
95     ---Category: Exceptions
96
97     exception PlotterDefinitionError inherits OutOfRange;
98     ---Category: The exceptions
99
100     exception PriorityDefinitionError inherits OutOfRange;
101     ---Category: Exceptions
102
103     exception StructureDefinitionError inherits OutOfRange;
104     ---Category: Exceptions
105
106     exception TransformError inherits OutOfRange;
107     ---Category: Exceptions
108
109     exception VectorError inherits OutOfRange;
110     ---Category: Exceptions
111
112     -------------------------
113     -- Category: Enumerations
114     -------------------------
115
116         enumeration NameOfMaterial is
117                     NOM_BRASS,      -- laiton       (PHYSIC)
118                     NOM_BRONZE,     -- bronze       (PHYSIC)
119                     NOM_COPPER,     -- cuivre       (PHYSIC)
120                     NOM_GOLD,       -- or           (PHYSIC)
121
122                     NOM_PEWTER,     -- etain        (PHYSIC)
123
124                     NOM_PLASTER,    -- platre       (GENERIC)
125                     NOM_PLASTIC,    -- plastic      (GENERIC)
126
127                     NOM_SILVER,     -- argent       (PHYSIC)
128
129                     NOM_STEEL,      -- acier        (PHYSIC)
130
131                     NOM_STONE,      -- pierre       (PHYSIC)
132
133                     NOM_SHINY_PLASTIC,   -- plastique brillant   (GENERIC)
134                     NOM_SATIN,           --  satin        (GENERIC)
135                     NOM_METALIZED,       -- metallise New (GENERIC)
136                     NOM_NEON_GNC,        -- neon      New (GENERIC)
137                     NOM_CHROME,          -- chrome    New (PHYSIC)
138                     NOM_ALUMINIUM,       -- aluminium New (PHYSIC)
139                     NOM_OBSIDIAN,        -- obsidian  New (PHYSIC)
140                     NOM_NEON_PHC,        -- neon      New (PHYSIC)
141                     NOM_JADE,            -- jade      New (PHYSIC)
142
143                     NOM_CHARCOAL,
144
145                     NOM_WATER,
146                     NOM_GLASS,
147                     NOM_DIAMOND,
148
149                     NOM_DEFAULT,
150                     NOM_UserDefined -- owner material
151     end NameOfMaterial;
152     ---Purpose: Types of aspect materials.
153     ---Category: Enumerations
154
155     enumeration TypeOfMaterial is MATERIAL_ASPECT,          -- Materiel generique
156                                   MATERIAL_PHYSIC           -- Materiel physique
157     end TypeOfMaterial;
158         ---Purpose: Types of materials specifies if a material can change color.
159     ---Category: Enumerations
160
161         enumeration  NameOfTexture1D  is  NOT_1D_ELEVATION,
162                       NOT_1D_UNKNOWN
163     end  NameOfTexture1D;
164     ---Purpose: Types of standard textures.
165     ---Category: Enumerations
166
167
168     enumeration  NameOfTexture2D  is  NOT_2D_MATRA,
169                                       NOT_2D_ALIENSKIN,
170                                       NOT_2D_BLUE_ROCK,
171                                       NOT_2D_BLUEWHITE_PAPER,
172                                       NOT_2D_BRUSHED,
173                                       NOT_2D_BUBBLES,
174                                       NOT_2D_BUMP,
175                                       NOT_2D_CAST,
176                                       NOT_2D_CHIPBD,
177                                       NOT_2D_CLOUDS,
178                                       NOT_2D_FLESH,
179                                       NOT_2D_FLOOR,
180                                       NOT_2D_GALVNISD,
181                                       NOT_2D_GRASS,
182                                       NOT_2D_ALUMINUM,
183                                       NOT_2D_ROCK,
184                                       NOT_2D_KNURL,
185                                       NOT_2D_MAPLE,
186                                       NOT_2D_MARBLE,
187                                       NOT_2D_MOTTLED,
188                                       NOT_2D_RAIN,
189                                       NOT_2D_UNKNOWN
190     end  NameOfTexture2D;
191     ---Purpose: Types of standard textures.
192     ---Category: Enumerations
193
194
195         enumeration  NameOfTextureEnv is  NOT_ENV_CLOUDS,
196                                           NOT_ENV_CV,
197                                           NOT_ENV_MEDIT,
198                                           NOT_ENV_PEARL,
199                                           NOT_ENV_SKY1,
200                                           NOT_ENV_SKY2,
201                                           NOT_ENV_LINES,
202                                           NOT_ENV_ROAD,
203                                           NOT_ENV_UNKNOWN
204     end  NameOfTextureEnv;
205     ---Purpose: Types of standard textures.
206     ---Category: Enumerations
207
208         enumeration  TypeOfTexture  is  TOT_1D,
209                                         TOT_2D,
210                                         TOT_2D_MIPMAP;
211     ---Purpose: Type of the texture file format.
212     ---Category: Enumerations
213
214     enumeration  TypeOfTextureMode  is  TOTM_OBJECT,
215                                         TOTM_SPHERE,
216                                         TOTM_EYE,
217                                         TOTM_MANUAL,
218                                         TOTM_SPRITE;
219     ---Purpose: Type of the texture projection.
220     ---Category: Enumerations
221
222     enumeration  TypeOfTextureFilter is TOTF_NEAREST,
223                                         TOTF_BILINEAR,
224                                         TOTF_TRILINEAR;
225     ---Purpose: Type of the texture filter.
226     -- Notice that for textures without mipmaps linear interpolation will be used instead of TOTF_BILINEAR and TOTF_TRILINEAR.
227     ---Category: Enumerations
228
229     enumeration  LevelOfTextureAnisotropy is LOTA_OFF,
230                                              LOTA_FAST,
231                                              LOTA_MIDDLE,
232                                              LOTA_QUALITY;
233     ---Purpose: Level of anisotropy filter.
234     -- Notice that actual quality depends on hardware capabilities!
235     ---Category: Enumerations
236
237     enumeration  NameOfTexturePlane  is  NOTP_XY,
238                                          NOTP_YZ,
239                                          NOTP_ZX,
240                                          NOTP_UNKNOWN;
241     ---Purpose: Type of the texture projection plane for both S and T texture coordinate.
242     ---Category: Enumerations
243
244     enumeration TypeOfComposition is    TOC_REPLACE,
245                         TOC_POSTCONCATENATE
246     end TypeOfComposition;
247     ---Purpose: To manage the transformation matrices of structures.
248     ---Category: Enumerations
249
250     enumeration TypeOfConnection is TOC_ANCESTOR,
251                     TOC_DESCENDANT
252     end TypeOfConnection;
253     ---Purpose: To manage the connections between the structures.
254     ---Category: Enumerations
255
256     enumeration TypeOfPolygon is    TOP_UNKNOWN,
257                                     TOP_COMPLEX,
258                                     TOP_CONCAVE,
259                                     TOP_CONVEX
260     end TypeOfPolygon;
261     ---Purpose: The type of polygon in a group in a structure.
262     ---Category: Enumerations
263
264     enumeration TypeOfPrimitive is  TOP_UNDEFINED,
265                                     TOP_POLYLINE,
266                                     TOP_POLYGON,
267                                     TOP_TRIANGLEMESH,
268                                     TOP_QUADRANGLEMESH,
269                                     TOP_TEXT,
270                                     TOP_MARKER,
271                                     TOP_PARRAY
272     end TypeOfPrimitive;
273     ---Purpose: The type of primitive in a group in a structure.
274     ---Category: Enumerations
275
276         enumeration TypeOfPrimitiveArray is TOPA_UNDEFINED,
277                                             TOPA_POINTS,
278                                             TOPA_POLYLINES,
279                                             TOPA_SEGMENTS,
280                                             TOPA_POLYGONS,
281                                             TOPA_TRIANGLES,
282                                             TOPA_QUADRANGLES,
283                                             TOPA_TRIANGLESTRIPS,
284                                             TOPA_QUADRANGLESTRIPS,
285                                             TOPA_TRIANGLEFANS
286         end TypeOfPrimitiveArray;
287         ---Purpose: The type of primitive array in a group in a structure.
288         ---Category: Enumerations
289
290     enumeration TypeOfReflection is TOR_AMBIENT,
291                                     TOR_DIFFUSE,
292                                     TOR_SPECULAR,
293                                     TOR_EMISSION
294     end TypeOfReflection;
295     ---Purpose: Nature of the reflection of a material.
296     ---Category: Enumerations
297
298     enumeration TypeOfStructure is  TOS_WIREFRAME,
299                                     TOS_SHADING,
300                                     TOS_COMPUTED,
301                                     TOS_ALL
302     end TypeOfStructure;
303     ---Purpose: Structural attribute indicating if it can be displayed
304     --      in wireframe, shadow mode, or both.
305     ---Category: Enumerations
306
307     enumeration TextPath is TP_UP,
308                             TP_DOWN,
309                             TP_LEFT,
310                             TP_RIGHT
311     end TextPath;
312     ---Purpose: Direction in which text is displayed.
313     ---Category: Enumerations
314
315     enumeration HorizontalTextAlignment is  HTA_LEFT,
316                                             HTA_CENTER,
317                                             HTA_RIGHT
318     end HorizontalTextAlignment;
319     ---Purpose: Defines the horizontal position of the text
320     --      relative to its anchor.
321     ---Category: Enumerations
322
323     enumeration VerticalTextAlignment is    VTA_BOTTOM,
324                                             VTA_CENTER,
325                                             VTA_TOP
326     end VerticalTextAlignment;
327     ---Purpose: Defines the vertical position of the text
328     --      relative to its anchor.
329     ---Category: Enumerations
330
331     enumeration GroupAspect is ASPECT_LINE,
332         ASPECT_TEXT,
333         ASPECT_MARKER,
334         ASPECT_FILL_AREA
335     end GroupAspect;
336     ---Purpose: Identifies primitives aspects defined per group.
337     -- - ASPECT_LINE: aspect for line primitives;
338     -- - ASPECT_TEXT: aspect for text primitives;
339     -- - ASPECT_MARKER: aspect for marker primitives;
340     -- - ASPECT_FILL_AREA: aspect for face primitives.
341
342     enumeration RenderingMode is
343       RM_RASTERIZATION, RM_RAYTRACING
344     end RenderingMode;
345     ---Purpose: Describes rendering modes.
346     -- - RM_RASTERIZATION: enables OpenGL rasterization mode;
347     -- - RM_RAYTRACING: enables GPU ray-tracing mode.
348
349     ---------------------------
350     -- Category: Imported types
351     ---------------------------
352
353     imported Buffer;
354     imported Buffer_Handle;
355     imported BoundBuffer;
356     imported BoundBuffer_Handle;
357     imported IndexBuffer;
358     imported IndexBuffer_Handle;
359
360     imported BufferType;
361
362     imported CBitFields20;
363     ---Category: Imported types
364
365     imported CBitFields16;
366     ---Category: Imported types
367
368     imported CBitFields8;
369     ---Category: Imported types
370
371     imported CBitFields4;
372     ---Category: Imported types
373
374     imported CAspectFillArea;
375     imported CAspectMarker;
376     imported CAspectLine;
377     imported CAspectText;
378
379     imported CStructure;
380     ---Category: Imported types
381
382     pointer CStructurePtr to CStructure from Graphic3d;
383
384     imported CStructure_Handle;
385
386     imported CLight;
387     ---Category: Imported types
388
389     imported CPick;
390     ---Category: Imported types
391
392     imported CPlane;
393     ---Category: Imported types
394
395     imported CBounds;
396     ---Category: Imported types
397
398     imported CUserDraw;
399     ---Category: Imported types
400
401     imported CView;
402     ---Category: Imported types
403     
404     imported RenderingParams;
405     ---Purpose: Describes rendering parameters and effects.
406     ---Category: Imported types
407
408     imported CGraduatedTrihedron;
409     ---Category: Imported types
410
411     imported ClipPlane;
412     ---Category: Imported types
413
414     imported ClipPlane_Handle;
415
416     imported CTexture;
417
418     imported CTransPersStruct;
419     imported TransModeFlags;
420     
421     imported MarkerImage;
422     imported MarkerImage_Handle;
423     imported Camera_Handle;
424
425     primitive PtrFrameBuffer;
426     primitive Vec2;
427     primitive Vec3;
428     primitive Vec4;
429     imported  Mat4;
430     imported  Mat4d;
431
432     imported ZLayerSettings;
433
434     --------------------
435     -- Category: Classes
436     --------------------
437
438     deferred class ArrayOfPrimitives;
439
440     class ArrayOfPoints;
441
442     class ArrayOfPolylines;
443
444     class ArrayOfSegments;
445
446     class ArrayOfPolygons;
447
448     class ArrayOfTriangles;
449
450     class ArrayOfTriangleStrips;
451
452     class ArrayOfTriangleFans;
453
454     class ArrayOfQuadrangles;
455
456     class ArrayOfQuadrangleStrips;
457
458     class AspectLine3d;
459     ---Category: Classes
460
461     class AspectFillArea3d;
462     ---Category: Classes
463
464     class AspectMarker3d;
465     ---Category: Classes
466
467     class AspectText3d;
468     ---Category: Classes
469
470     deferred class Group;
471     ---Category: Classes
472
473     class MaterialAspect;
474     ---Category: Classes
475
476     class Structure;
477     ---Category: Classes
478
479     pointer StructurePtr to Structure from Graphic3d;
480
481     deferred class GraphicDriver;
482
483     deferred class StructureManager;
484     ---Category: Classes
485
486     pointer StructureManagerPtr to StructureManager from Graphic3d;
487
488     deferred class DataStructureManager;
489     ---Category: Classes
490
491     deferred class Plotter;
492     ---Category: The classes
493
494     class Vector;
495     ---Category: Classes
496
497     imported Vertex;
498     ---Category: Classes
499
500     ---------------------------------
501     -- Category: Instantiated classes
502     ---------------------------------
503
504     imported SequenceOfGroup;
505
506     ---Category: Instantiated classes
507
508     class MapOfStructure instantiates
509             Map from TCollection (Structure from Graphic3d,MapTransientHasher from TColStd);
510
511
512     ---Category: Instantiated classes
513
514     class SequenceOfStructure instantiates
515             Sequence from TCollection
516             (Structure from Graphic3d);
517     ---Category: Instantiated classes
518
519     class HSequenceOfStructure instantiates
520             HSequence from TCollection
521         (Structure from Graphic3d, SequenceOfStructure from Graphic3d);
522     ---Category: Instantiated classes
523
524     class Array1OfVector instantiates
525             Array1 from TCollection (Vector from Graphic3d);
526     ---Category: Instantiated classes
527
528     class Array1OfVertex instantiates
529             Array1 from TCollection (Vertex from Graphic3d);
530     ---Category: Instantiated classes
531
532     class Array2OfVertex instantiates
533             Array2 from TCollection (Vertex from Graphic3d);
534     ---Category: Instantiated classes
535
536     class ListOfShortReal instantiates
537             List from TCollection (ShortReal from Standard);
538     ---Category: Instantiated classes
539
540     --ABD Integration support of system fonts (using FTGL and FreeType)
541     imported NListOfHAsciiString;
542     ---Category: Instantiated classes
543
544     imported ShaderProgram_Handle;
545     ---Category: Instantiated classes
546
547     imported SequenceOfHClipPlane;
548     ---Category: Instantiated classes
549     -- Sequence of handles on clip planes
550
551     deferred  class  TextureRoot  from  Graphic3d;
552     deferred  class  TextureMap   from  Graphic3d;
553     deferred  class  Texture1D    from  Graphic3d;
554     deferred  class  Texture2D    from  Graphic3d;
555
556     class  TextureParams    from  Graphic3d;
557     class  TextureEnv       from  Graphic3d;
558     class  Texture1Dmanual  from  Graphic3d;
559     class  Texture1Dsegment from  Graphic3d;
560     class  Texture2Dmanual  from  Graphic3d;
561     class  Texture2Dplane   from  Graphic3d;
562
563
564     enumeration ExportFormat is
565
566         EF_PostScript,
567         EF_EnhPostScript,
568         EF_TEX,
569         EF_PDF,
570         EF_SVG,
571         EF_PGF,
572         EF_EMF
573
574     end ExportFormat;
575
576
577     enumeration SortType is
578
579         ST_Simple,    -- sorting by depth of center point of primitive(fast)
580         ST_BSP_Tree   -- sorting by BSPTree (slow, but fine result )
581
582         end SortType;
583
584     ----------------------------
585     -- Category: Package methods
586     ----------------------------
587
588     InitGraphicDriver (theDisplayConnection: DisplayConnection_Handle from Aspect)
589        returns GraphicDriver from Graphic3d
590        raises  DriverDefinitionError from Aspect;
591     ---Purpose: Initialize graphic driver and returns Handle to it.
592
593     
594
595 end Graphic3d;