1
0
mirror of https://git.dev.opencascade.org/repos/occt.git synced 2025-07-10 12:25:50 +03:00
occt/src/IGESGraph/IGESGraph_LineFontDefPattern.cdl
bugmster 973c2be1e1 0024428: Implementation of LGPL license
The copying permission statements at the beginning of source files updated to refer to LGPL.
Copyright dates extended till 2014 in advance.
2013-12-17 12:42:41 +04:00

90 lines
3.4 KiB
Plaintext

-- Created on: 1993-01-11
-- Created by: CKY / Contract Toubro-Larsen ( Niraj RANGWALA )
-- Copyright (c) 1993-1999 Matra Datavision
-- Copyright (c) 1999-2014 OPEN CASCADE SAS
--
-- This file is part of Open CASCADE Technology software library.
--
-- This library is free software; you can redistribute it and / or modify it
-- under the terms of the GNU Lesser General Public 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.
--
-- Alternatively, this file may be used under the terms of Open CASCADE
-- commercial license or contractual agreement.
class LineFontDefPattern from IGESGraph inherits LineFontEntity
---Purpose : defines IGESLineFontDefPattern, Type <304> Form <2>
-- in package IGESGraph
--
-- Line Font may be defined by repetition of a basic pattern
-- of visible-blank(or, on-off) segments superimposed on
-- a line or a curve. The line or curve is then displayed
-- according to the basic pattern.
uses
IGESEntity from IGESData,
HAsciiString from TCollection,
HArray1OfReal from TColStd
raises OutOfRange
is
Create returns mutable LineFontDefPattern;
-- Specific Methods pertaining to class
Init (me : mutable;
allSegLength : HArray1OfReal;
aPattern : HAsciiString);
---Purpose : This method is used to set the fields of the class
-- LineFontDefPattern
-- - allSegLength : Containing lengths of respective segments
-- - aPattern : HAsciiString indicating visible-blank segments
NbSegments (me) returns Integer;
---Purpose : returns the number of segments in the visible-blank pattern
Length (me; Index : Integer) returns Real
raises OutOfRange;
---Purpose : returns the Length of Index'th segment of the basic pattern
-- raises exception if Index <= 0 or Index > NbSegments
DisplayPattern (me) returns HAsciiString from TCollection;
---Purpose : returns the string indicating which segments of the basic
-- pattern are visible and which are blanked.
-- e.g:
-- theNbSegments = 5 and if Bit Pattern = 10110, which means that
-- segments 2, 3 and 5 are visible, whereas segments 1 and 4 are
-- blank. The method returns "2H16" as the HAsciiString.
-- Note: The bits are right justified. (16h = 10110)
IsVisible (me; Index : Integer) returns Boolean;
---Purpose : The Display Pattern is decrypted to
-- return True if the Index'th basic pattern is Visible,
-- False otherwise.
-- If Index > NbSegments or Index <= 0 then return value is
-- False.
fields
--
-- Class : IGESGraph_LineFontDefPattern
--
-- Purpose : Declaration of the variables specific to Line Font Patterns.
--
-- Reminder : A Line Font Pattern is defined by :
-- - Length of each Segment
-- - Visible-Blank Pattern Bitmap
--
theSegmentLengths : HArray1OfReal;
theDisplayPattern : HAsciiString;
end LineFontDefPattern;