1
0
mirror of https://git.dev.opencascade.org/repos/occt.git synced 2025-05-21 10:55:33 +03:00
occt/src/IGESGraph/IGESGraph_LineFontDefPattern.cdl
bugmaster b311480ed5 0023024: Update headers of OCCT files
Added appropriate copyright and license information in source files
2012-03-21 19:43:04 +04:00

95 lines
3.7 KiB
Plaintext
Executable File

-- Created on: 1993-01-11
-- Created by: CKY / Contract Toubro-Larsen ( Niraj RANGWALA )
-- Copyright (c) 1993-1999 Matra Datavision
-- Copyright (c) 1999-2012 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.
--
-- 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.
--
-- 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.
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;