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

151 lines
5.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 RectArraySubfigure from IGESDraw
inherits IGESEntity
--- Purpose : Defines IGES Rectangular Array Subfigure Instance Entity,
-- Type <412> Form Number <0> in package IGESDraw
-- Used to produce copies of object called the base entity,
-- arranging them in equally spaced rows and columns
uses
HArray1OfInteger from TColStd,
XYZ from gp,
Pnt from gp
raises OutOfRange
is
Create returns mutable RectArraySubfigure;
-- Specific Methods pertaining to the class
Init (me : mutable;
aBase : IGESEntity;
aScale : Real;
aCorner : XYZ;
nbCols : Integer;
nbRows : Integer;
hDisp : Real;
vtDisp : Real;
rotationAngle : Real;
doDont : Integer;
allNumPos : HArray1OfInteger);
---Purpose : This method is used to set the fields of the class
-- RectArraySubfigure
-- - aBase : a base entity which is replicated
-- - aScale : Scale Factor
-- - aCorner : lower left hand corner for the entire array
-- - nbCols : Number of columns of the array
-- - nbRows : Number of rows of the array
-- - hDisp : Column separations
-- - vtDisp : Row separation
-- - rotationAngle : Rotation angle specified in radians
-- - allDont : DO-DON'T flag to control which portion
-- to display
-- - allNumPos : List of positions to be or not to be
-- displayed
BaseEntity (me) returns IGESEntity;
---Purpose : returns the base entity, copies of which are produced
ScaleFactor (me) returns Real;
---Purpose : returns the scale factor
LowerLeftCorner (me) returns Pnt;
---Purpose : returns coordinates of lower left hand corner for the entire array
TransformedLowerLeftCorner (me) returns Pnt;
---Purpose : returns Transformed coordinates of lower left corner for the array
NbColumns (me) returns Integer;
---Purpose : returns number of columns in the array
NbRows (me) returns Integer;
---Purpose : returns number of rows in the array
ColumnSeparation (me) returns Real;
---Purpose : returns horizontal distance between columns
RowSeparation (me) returns Real;
---Purpose : returns vertical distance between rows
RotationAngle (me) returns Real;
---Purpose : returns rotation angle in radians
DisplayFlag (me) returns Boolean;
---Purpose : returns True if (ListCount = 0) i.e., all elements to be displayed
ListCount (me) returns Integer;
---Purpose : returns 0 if all replicated entities to be displayed
DoDontFlag (me) returns Boolean;
---Purpose : returns 0 if half or fewer of the elements of the array are defined
-- 1 if half or more of the elements are defined
PositionNum (me; Index : Integer) returns Boolean;
---Purpose : returns whether Index is to be processed (DO)
-- or not to be processed(DON'T)
-- if (ListCount = 0) return theDoDontFlag
ListPosition (me; Index : Integer) returns Integer
raises OutOfRange;
---Purpose : returns the Index'th value position
-- raises exception if Index <= 0 or Index > ListCount()
fields
--
-- Class : IGESDraw_RectArraySubfigure
--
-- Purpose : Declaration of the variables specific to a RectArraySubfigure.
--
-- Reminder : A Rectangular Array Subfigure Instance is defined by :
-- - a base entity which is replicated
-- - Number of columns and rows of the array
-- - Column and row separations
-- - lower left hand corner for the entire array
-- - angle of rotation specified in radians
-- - a DO-DON'T flag to control which portion to display
-- - List of positions.
--
theBaseEntity : IGESEntity;
theScaleFactor : Real;
theLowerLeftCorner : XYZ;
theNbColumns : Integer;
theNbRows : Integer;
theColumnSeparation : Real;
theRowSeparation : Real;
theRotationAngle : Real;
theDoDontFlag : Integer;
thePositions : HArray1OfInteger;
end RectArraySubfigure;