-- Created by: NW,JPB,CAL
-- Copyright (c) 1991-1999 Matra Datavision
--- Copyright (c) 1999-2012 OPEN CASCADE SAS
+-- Copyright (c) 1999-2014 OPEN CASCADE SAS
--
--- The content of this file is subject to the Open CASCADE Technology Public
--- License Version 6.5 (the "License"). You may not use the content of this file
--- except in compliance with the License. Please obtain a copy of the License
--- at http://www.opencascade.org and read it completely before using this file.
+-- This file is part of Open CASCADE Technology software library.
--
--- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
--- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
+-- This library is free software; you can redistribute it and/or modify it under
+-- the terms of the GNU Lesser General Public License version 2.1 as published
+-- by the Free Software Foundation, with special exception defined in the file
+-- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
+-- distribution for complete text of the license and disclaimer of any warranty.
--
--- The Original Code and all software distributed under the License is
--- distributed on an "AS IS" basis, without warranty of any kind, and the
--- Initial Developer hereby disclaims all such warranties, including without
--- limitation, any warranties of merchantability, fitness for a particular
--- purpose or non-infringement. Please see the License for the specific terms
--- and conditions governing the rights and limitations under the License.
-
--- Package: Aspect
--- Updated: Vendredi 2 Octobre 1992
--- Mercredi 31 mars 1993
--- Lundi 16 janvier 1995
--- Reason : Traitement des Markers (G400)
--- Purpose: Specifications definitives
--- Modified: 15/01/98 ; FMN : Ajout Hidden Line
--- Modified: 07/07/98 ; DCB : Adding plotmode enum
--- Modified: 07-07-98 by DCB (S3602 study)
--- Adding plotmode enum
--- Modified: 20-07-98 by DCB (S3602 study)
--- Adding Plotter and PlotterConfigTool classes
--- to plotters (PLO)
--- Modified: 22-07-98 by DCB
--- Adding DriverPtr, PlotterDriverPtr, WindowDriverPtr
--- pointers.
--- Modified: 24/08/98 ; CAL : S3892. Ajout grilles 3d.
--- Modified: 16-09-98 by BGN (S3989)
---- Adding TypeOfTriedronEcho, TypeOfTriedronPosition.
--- Modified: 30-11-98 ; FMN : S4069. Textes always visible.
--- Modified: 30/10/98 : DCB : S4046
--- Adding class PlotterParameter and changing the Plotter's class
--- implementation according to new PLO specifications (S3604 ???)
--- Also new classes : (H)Array1OfPlotterParameter
--- New enumeration : TypeOfPlotterParameter.
--- New exception : PlotterParameterError.
--- Modified: 25-NOV-98 : DCB
--- Removing all plotters specific implementation from Aspect.
--- These classes and enums will now be located in PlotMgt.
--- Modified: 17-NOV-99 : GG GER61351
--- Add TypeOfFacingModel enum
--- Modified: 20-JAN-00 : GG
--- Add GDM_None in enum GridDrawMode.
--- Modified: 25-JAN-00 : VKH
--- Add class PixMap
--- Modified: 26-JAN-00 : EUG/GG G003
--- Add enum TypeOfDegenerateModel
--- Modified: 23-FEB-00 : GG
--- Returns format name in ValuesOfFOSP() internal method.
--- Modified: 27-03-02 RIC120302 GG Add imported class
--- Display, Drawable, RenderingContext, GraphicCallbackProc
--- Modified: 22-03-04 OCC4895 SAN High-level interface for controlling polygon offsets
--- Modified: 21-06-04 STV Added Aspect_ColorScale class
-
-------------------------------------------------------------------------
+-- Alternatively, this file may be used under the terms of Open CASCADE
+-- commercial license or contractual agreement.
package Aspect
-- G002A study
imported CLayer2d;
- ---Purpose: Defines the C structure <alayer>
- ---Category: Imported types
- imported RGBPixel;
- ---Purpose:
+ ---Category: Imported types
primitive Handle;
primitive Drawable;
- ---Purpose:
- -- To manage Drawable
primitive Display;
- ---Purpose:
- -- To manage Display
primitive RenderingContext;
- ---Purpose:
- -- To manage 2D or 3D graphic context
imported GraphicCallbackProc;
- ---Purpose:
- -- To manage client post display
-- 22-03-04 OCC4895 SAN High-level interface for controlling polygon offsets
imported PolygonOffsetMode;
- ---Purpose:
- -- Enumeration for polygon offset modes
-
- ---------------------
- -- Category: Pointers
- ---------------------
-
- pointer DriverPtr to Driver from Aspect;
- pointer WindowDriverPtr to WindowDriver from Aspect;
-
- ---Category: Pointers
-----------------------
-- Category: Exceptions
exception BadAccess inherits DomainError;
---Category: Exceptions
- exception ColorMapDefinitionError inherits OutOfRange;
- ---Category: The exceptions
-
- exception EdgeDefinitionError inherits OutOfRange;
- ---Category: Exceptions
-
exception IdentDefinitionError inherits OutOfRange;
---Category: Exceptions
- exception TypeMapDefinitionError inherits OutOfRange;
- ---Category: The exceptions
-
- exception WidthMapDefinitionError inherits OutOfRange;
- ---Category: The exceptions
-
- exception FontMapDefinitionError inherits OutOfRange;
- ---Category: The exceptions
-
- exception MarkMapDefinitionError inherits OutOfRange;
- ---Category: The exceptions
-
exception WindowDefinitionError inherits OutOfRange;
---Category: The exceptions
exception WindowError inherits OutOfRange;
---Category: The exceptions
- exception PixmapDefinitionError inherits OutOfRange;
- ---Category: The exceptions
-
- exception PixmapError inherits OutOfRange;
- ---Category: The exceptions
-
exception DriverDefinitionError inherits OutOfRange;
---Category: The exceptions
- exception DriverError inherits OutOfRange;
- ---Category: The exceptions
-
exception GraphicDeviceDefinitionError inherits OutOfRange;
---Category: The exceptions
exception DisplayConnectionDefinitionError inherits OutOfRange;
---Category: The exceptions
- exception LineStyleDefinitionError inherits OutOfRange;
- ---Category: Exceptions
-
- exception LineWidthDefinitionError inherits OutOfRange;
- ---Category: Exceptions
-
- exception PolyStyleDefinitionError inherits OutOfRange;
- ---Category: Exceptions
-
- exception FontStyleDefinitionError inherits OutOfRange;
- ---Category: Exceptions
-
- exception MarkerStyleDefinitionError inherits OutOfRange;
- ---Category: Exceptions
-
- exception UndefinedMap inherits OutOfRange;
- ---Category: Exceptions
-
- ------------------------------
- -- Category: Classes Color map
- ------------------------------
-
- deferred class ColorMap;
- ---Purpose: Defines a color map.
- ---Category: Classes Color map
-
- class ColorCubeColorMap;
- ---Purpose: Associates a index and a color in the "ColorCube" space.
- ---Category: Classes Color map
-
- class ColorRampColorMap;
- ---Purpose: Associates a index and a color in the linear "ColorRamp"
- -- space.
- ---Category: Classes Color map
-
- class GenericColorMap;
- ---Purpose: Associates an index and a color.
- ---Category: Classes Color map
-
- class ColorMapEntry;
- ---Purpose: Defines an entry in the color map :
- -- an index and a color.
- ---Category: Classes Color map
-
- ------------------------------
- -- Category: Classes Pixel
- ------------------------------
-
- deferred class Pixel;
- ---Purpose: Defines a picture element.
- ---Category: Classes Pixel
-
- class IndexPixel;
- ---Purpose:
- ---Category: Classes Pixel
-
- class ColorPixel;
- ---Purpose:
- ---Category: Classes Pixel
-
---------------------------
-- Category: Classes Aspect
---------------------------
deferred class AspectLine;
- ---Purpose: Creates and updates a group of graphic attributes
- -- for primitives 'Line'
---Category: Classes Aspect
deferred class AspectMarker;
- ---Purpose: Creates and updates a group of graphic attributes
- -- for primitives 'Marker'.
---Category: Classes Aspect
deferred class AspectFillArea;
- ---Purpose: Creates and updates a group of graphic attributes
- -- for primitives 'Face'.
---Category: Classes Aspect
--------------------
--------------------
class Background;
- ---Purpose: Defines a window background
---Category: Classes
class GradientBackground;
- ---Purpose: Defines a window gradient background
- ---Category: Classes
-
- class Edge;
- ---Purpose: Defines an edge.
---Category: Classes
class GenId;
- ---Purpose: Creates and controles all identifiers.
---Category: Classes
- class FontStyle;
- ---Purpose: Defines a Font Style
- ---Category: The classes
-
- class FontMapEntry;
- ---Purpose: Defines an entry in the Font map :
- -- an index and a text Font.
- ---Category: Classes Font map
-
- class FontMap;
- ---Purpose: Associates an index and a text Font entry.
- ---Category: The classes
-
- class WidthMapEntry;
- ---Purpose: Defines an entry in the Width map :
- -- an index and a line Width.
- ---Category: Classes Width map
-
- class WidthMap;
- ---Purpose: Associates an index and a line width entry.
- ---Category: The classes
-
- class LineStyle;
- ---Purpose: Defines a Line Style
- ---Category: The classes
-
- class TypeMap;
- ---Purpose: Associates an index and a line type entry.
- ---Category: The classes
-
- class TypeMapEntry;
- ---Purpose: Defines an entry in the Type map :
- -- an index and a line style.
- ---Category: Classes Type map
-
- class MarkerStyle;
- ---Purpose: Defines a Marker Style
- ---Category: The classes
-
- class MarkMap;
- ---Purpose: Associates an index and a Marker entry.
- ---Category: The classes
-
- class MarkMapEntry;
- ---Purpose: Defines an entry in the Marker map :
- -- an index and a marker style.
- ---Category: Classes Mark map
-
deferred class Window;
- ---Purpose: Defines a window.
- ---Category: Classes
-
- deferred class Driver;
- ---Purpose: Defines a virtual driver.
- ---Category: Classes
-
- deferred class WindowDriver;
- ---Purpose: Defines a virtual driver associated to a window.
---Category: Classes
deferred class Grid;
class CircularGrid;
deferred class ColorScale;
- ---Purpose: Defines a color scale for viewer.
- imported DisplayConnection;
- ---Purpose: Creates and provides connection with X server.
-
- imported DisplayConnection_Handle;
- ---Purpose: Handle for DisplayConnection;
+ imported transient class DisplayConnection;
-------------------------
-- Category: Enumerations
IS_HOLLOW,
IS_HATCH,
IS_SOLID,
- IS_HIDDENLINE
+ IS_HIDDENLINE,
+ IS_POINT
end InteriorStyle;
---Purpose: Definition of interior types for primitive
-- faces.
-- IS_HATCH display hatched with a hatch style.
-- IS_SOLID display the interior entirely filled.
-- IS_HIDDENLINE display in hidden lines removed.
- --
- ---Category: Enumerations
-
- enumeration TypeOfColorMap is TOC_Generic,
- TOC_ColorCube,
- TOC_ColorRamp
- end TypeOfColorMap;
- ---Purpose: Definition of the color map types
+ -- IS_POINT display only vertices.
--
---Category: Enumerations
---Category: Enumerations
enumeration TypeOfHighlightMethod is TOHM_COLOR,
- TOHM_BLINK,
TOHM_BOUNDBOX
end TypeOfHighlightMethod;
---Purpose: Definition of a highlight method
--
-- TOHM_COLOR drawn in the highlight color
-- (default white)
- -- TOHM_BLINK blinking
-- TOHM_BOUNDBOX enclosed by the boundary box
-- (default white)
--
-- WOL_USERDEFINED defined by Users
---Category: Enumerations
- enumeration TypeOfFont is TOF_DEFAULT,
- TOF_COURIER,
- TOF_HELVETICA,
- TOF_TIMES,
- TOF_USERDEFINED
- end TypeOfFont;
- ---Purpose: Definition of line types
- --
- -- TOF_DEFAULT Default system font
- -- TOF_COURIER
- -- TOF_HELVETICA
- -- TOF_USERDEFINED defined by Users
- ---Category: Enumerations
-
- enumeration TypeOfText is TOT_SOLID,
- TOT_OUTLINE
- end TypeOfText;
- ---Purpose: Definition of Text types
- --
- -- TOF_SOLID Default text
- -- TOF_OUTLINE
- ---Category: Enumerations
-
enumeration TypeOfStyleText is TOST_NORMAL,
TOST_ANNOTATION
end TypeOfStyleText;
enumeration TypeOfDisplayText is TODT_NORMAL,
TODT_SUBTITLE,
TODT_DEKALE,
- TODT_BLEND
+ TODT_BLEND,
+ TODT_DIMENSION
end TypeOfDisplayText;
---Purpose: Define the display type of the text.
--
-- TODT_SUBTITLE There is a subtitle under the text.
-- TODT_DEKALE The text is displayed with a 3D style.
-- TODT_BLEND The text is displayed in XOR.
+ -- TODT_DIMENSION Dimension line under text will be invisible.
---Category: Enumerations
enumeration TypeOfMarker is TOM_POINT,
TOM_PLUS,
TOM_STAR,
- TOM_O,
TOM_X,
+ TOM_O,
TOM_O_POINT,
TOM_O_PLUS,
TOM_O_STAR,
TOM_O_X,
- TOM_BALL,
TOM_RING1,
TOM_RING2,
TOM_RING3,
+ TOM_BALL,
TOM_USERDEFINED
end TypeOfMarker;
---Purpose: Definition of types of markers
-- TOM_POINT point .
-- TOM_PLUS plus +
-- TOM_STAR star *
- -- TOM_O circle O
-- TOM_X cross x
+ -- TOM_O circle O
-- TOM_O_POINT a point in a circle
-- TOM_O_PLUS a plus in a circle
-- TOM_O_STAR a star in a circle
-- TOM_O_X a cross in a circle
- -- TOM_BALL a ball with 1 color and different saturations
-- TOM_RING1 a large ring
-- TOM_RING2 a medium ring
-- TOM_RING3 a small ring
+ -- TOM_BALL a ball with 1 color and different saturations
-- TOM_USERDEFINED defined by Users
--
---Category: Enumerations
---Purpose: Defines the type of Resize Window method applied
-- by the user.
- enumeration CardinalPoints is CP_North,
- CP_NorthEast,
- CP_East,
- CP_SouthEast,
- CP_South,
- CP_SouthWest,
- CP_West,
- CP_NorthWest,
- CP_Center
- end CardinalPoints;
-
- enumeration TypeOfRenderingMode is TORM_IMMEDIAT,
- TORM_RETAIN,
- TORM_CLEAR_AND_RETAIN
- end TypeOfRenderingMode;
- ---Purpose: Definition of the rendering modes
-
- enumeration TypeOfColorSpace is TOCS_BlackAndWhite,
- TOCS_GreyScale,
- TOCS_RGB
- end TypeOfColorSpace;
- ---Purpose:
-
- enumeration FormatOfSheetPaper is
- FOSP_A0, -- 0.841 x 1.189 (M)
- FOSP_A1, -- 0.594 x 0.841 (M)
- FOSP_A2, -- 0.420 x 0.594 (M)
- FOSP_A3, -- 0.297 x 0.420 (M)
- FOSP_A4, -- 0.210 x 0.297 (M)
- FOSP_A5, -- 0.1485 x 0.210 (M)
- FOSP_K_LONG, -- 1.016 x 3.6322 (M)
- FOSP_K_SHORT, -- 1.016 x 1.397 (M)
- FOSP_J_LONG, -- 0.8636 x 4.4704 (M)
- FOSP_J_SHORT, -- 0.8636 x 1.397 (M)
- FOSP_H_LONG, -- 0.7112 x 3.6322 (M)
- FOSP_H_SHORT, -- 0.7112 x 1.1176 (M)
- FOSP_G_LONG, -- 0.2794 x 2.286 (M)
- FOSP_G_SHORT, -- 0.2794 x 0.5715 (M)
- FOSP_F, -- 0.7112 x 1.016 (M)
- FOSP_E, -- 0.8636 x 1.1176 (M)
- FOSP_D, -- 0.5588 x 0.8636 (M)
- FOSP_C, -- 0.4318 x 0.5588 (M)
- FOSP_B, -- 0.2794 x 0.4318 (M)
- FOSP_A, -- 0.2159 x 0.2794 (M)
- FOSP_UNKNOWN -- User defined
- end FormatOfSheetPaper;
- ---Purpose:
-
enumeration TypeOfPrimitive is
TOP_UNKNOWN,
TOP_POLYLINE,
end GridType;
---Purpose: Defines the grid type : Rectangular or Circular.
- --------- Start DCB modification ----------------------------------------
- enumeration PlotMode is
- PM_DPLOTTER,
- PM_FILEONLY,
- PM_NPLOTTER
- end PlotMode;
- ---Purpose: Defines plot mode for plotter drivers derived from
- -- Aspect_PlotterDriver:
- -- 1) PM_DPLOTTER - send file to plotter and delete file
- -- 2) PM_FILEONLY - do not send file to the plotter
- -- 3) PM_NPLOTTER - send file to the plotter but not delete a file
-
-
- enumeration ListingType is
- LPID_DIRPLOT,
- LPID_DIRPARPLO,
- LPID_ALLDIRS
- end ListingType;
- ---Purpose: Defines where to search plotter files (PLO)
-
- enumeration PlotterOrigin is
- PO_CENTER,
- PO_BOTTOMLEFT,
- PO_TOPLEFT,
- PO_TOPRIGHT,
- PO_BOTTOMRIGHT,
- PO_UNKNOWN
- end PlotterOrigin;
- --------- Stop DCB modification ----------------------------------------
-
-
enumeration TypeOfTriedronEcho is TOTE_NONE,
TOTE_ORIGIN,
TOTE_AXIS_X,
TOFM_FRONT_SIDE
end TypeOfFacingModel;
- enumeration TypeOfDegenerateModel is
- TDM_NONE,
- TDM_TINY,
- TDM_WIREFRAME,
- TDM_MARKER,
- TDM_BBOX,
- TDM_AUTO
- end TypeOfDegenerateModel;
- ---Purpose: Defines type of degeneration model of the
- -- graphic structure.
- ---Category: The enumerations
-
enumeration FillMethod is
FM_NONE,
FM_CENTERED,
-- are smaller than the printer's printing
-- area dimensions - use multiple printing
-- frames to cover the whole printing area
-
+ enumeration XAtom is
+ XA_DELETE_WINDOW
+ end XAtom;
+ ---Purpose: Defines custom identifiers(atoms) for X window custom named properties
---------------------------------
-- Category: Instantiated classes
---------------------------------
- class Array1OfEdge instantiates
- Array1 from TCollection (Edge from Aspect);
- ---Category: Instantiated classes
-
- class SequenceOfColorMapEntry instantiates
- Sequence from TCollection (ColorMapEntry from Aspect);
- ---Category: Instantiated classes
-
- class SequenceOfTypeMapEntry instantiates
- Sequence from TCollection (TypeMapEntry from Aspect);
- ---Category: Instantiated classes
-
- class SequenceOfWidthMapEntry instantiates
- Sequence from TCollection (WidthMapEntry from Aspect);
- ---Category: Instantiated classes
-
- class SequenceOfFontMapEntry instantiates
- Sequence from TCollection (FontMapEntry from Aspect);
- ---Category: Instantiated classes
-
- class SequenceOfMarkMapEntry instantiates
- Sequence from TCollection (MarkMapEntry from Aspect);
- ---Category: Instantiated classes
-
- class SequenceOfColor instantiates
- Sequence from TCollection(Color from Quantity);
-
- ----------------------------
- -- Category: Package methods
- ----------------------------
-
- ValuesOfFOSP (aFOSP : FormatOfSheetPaper from Aspect;
- aWidth, aHeight : out Length from Quantity)
- returns CString from Standard;
- ---Level: Internal
- ---Purpose: Returns the format size according to the default
- -- LENGTH unit of the required format <aFOSP>.
- -- Returns more the normalized format name.
- ---Category: Package methods
-
- ToCString (aString: ExtendedString from TCollection)
- returns CString from Standard;
- ---Level: Internal
- ---Purpose: Translates an ExtendedString to a CString
- -- depending of the local format.
- ---Category: Package methods
-
- Inverse ( aMat : Array2OfReal from TColStd;
- Inv : out Array2OfReal from TColStd )
- returns Boolean from Standard;
- ---Level: Internal
- ---Purpose: Inverses <aMat> a 4x4 matrix.
+ imported SequenceOfColor;
end Aspect;
projects / occt.git / blobdiff