Files
OCCT/src/IGESDraw/IGESDraw_Drawing.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

126 lines
4.9 KiB
Plaintext
Executable File

-- Created on: 1993-01-09
-- Created by: CKY / Contract Toubro-Larsen ( TCD )
-- 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 Drawing from IGESDraw inherits IGESEntity
---Purpose: defines IGESDrawing, Type <404> Form <0>
-- in package IGESDraw
--
-- Specifies a drawing as a collection of annotation entities
-- defined in drawing space, and views which together
-- constitute a single representation of a part
uses
HArray1OfIGESEntity from IGESData,
ViewKindEntity from IGESData,
HArray1OfViewKindEntity from IGESDraw,
Pnt2d from gp,
XYZ from gp,
XY from gp,
HArray1OfXY from TColgp
raises DimensionMismatch, OutOfRange
is
Create returns mutable Drawing;
-- Specific Methods pertaining to the class
Init (me : mutable;
allViews : HArray1OfViewKindEntity;
allViewOrigins : HArray1OfXY;
allAnnotations : HArray1OfIGESEntity)
raises DimensionMismatch;
---Purpose : This method is used to set the fields of the class
-- Drawing
-- - allViews : Pointers to DEs of View entities
-- - allViewOrigins : Origin coordinates of transformed Views
-- - allAnnotations : Pointers to DEs of Annotation entities
-- raises exception if Lengths of allViews and allViewOrigins are
-- not same.
NbViews (me) returns Integer;
---Purpose : returns the number of view pointers in <me>
ViewItem (me; ViewIndex : Integer) returns ViewKindEntity
raises OutOfRange;
---Purpose : returns the ViewKindEntity indicated by ViewIndex
-- raises an exception if ViewIndex <= 0 or ViewIndex > NbViews().
ViewOrigin (me; TViewIndex : Integer) returns Pnt2d
raises OutOfRange;
---Purpose : returns the Drawing space coordinates of the origin of the
-- Transformed view indicated by TViewIndex
-- raises an exception if TViewIndex <= 0 or TViewIndex > NbViews().
NbAnnotations (me) returns Integer;
---Purpose : returns the number of Annotation entities in <me>
Annotation (me; AnnotationIndex : Integer) returns IGESEntity
raises OutOfRange;
---Purpose : returns the Annotation entity in this Drawing, indicated by the
-- AnnotationIndex
-- raises an exception if AnnotationIndex <= 0 or
-- AnnotationIndex > NbAnnotations().
-- infered informations
ViewToDrawing(me; NumView : Integer; ViewCoords : XYZ)
returns XY;
-- returns the Transformation of a View from View space to
-- Drawing space.
DrawingUnit (me; value : out Real) returns Boolean;
---Purpose : Returns the Drawing Unit Value if it is specified (by a
-- specific property entity)
-- If not specified, returns False, and val as zero :
-- unit to consider is then the model unit in GlobalSection
DrawingSize (me; X,Y : out Real) returns Boolean;
---Purpose : Returns the Drawing Size if it is specified (by a
-- specific property entity)
-- If not specified, returns False, and X,Y as zero :
-- unit to consider is then the model unit in GlobalSection
fields
--
-- Class : IGESDraw_Drawing
--
-- Purpose : Declaration of the variables specific to a
-- Drawing Entity.
--
-- Reminder : A Drawing Entity is defined by :
-- - Pointers to DEs of View entities
-- - Origin coordinates of transformed views
-- - Pointers to DEs of Annotation entities
--
theViews : HArray1OfViewKindEntity;
theViewOrigins : HArray1OfXY;
theAnnotations : HArray1OfIGESEntity;
end Drawing;