1
0
mirror of https://git.dev.opencascade.org/repos/occt.git synced 2025-06-05 11:24:17 +03:00
occt/src/ShapeAnalysis/ShapeAnalysis_FreeBoundData.cdl
abv 6e33d3ced2 0024830: Remove redundant keyword 'mutable' in CDL declarations
Redundant keyword 'mutable' removed in CDL files.
In IGESConvGeom_GeomBuilder, unused methods MakeXY() and MakeXYZ() removed.
Method StepAP214_AutoDesignGroupAssignment::Init() replicating same method of the base class is removed as it causes CDL extraction error after above (seemingly irrelevant) changes.
2014-05-29 14:58:25 +04:00

139 lines
4.4 KiB
Plaintext

-- Created on: 1998-08-25
-- Created by: Pavel DURANDIN <pdn@nnov.matra-dtv.fr>
-- Copyright (c) 1998-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 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.
--
-- Alternatively, this file may be used under the terms of Open CASCADE
-- commercial license or contractual agreement.
-- Roman LYGIN <rln@nnov.matra-dtv.fr>
class FreeBoundData from ShapeAnalysis inherits TShared from MMgt
---Purpose: This class is intended to represent free bound and to store
-- its properties.
--
-- This class is used by ShapeAnalysis_FreeBoundsProperties
-- class when storing each free bound and its properties.
--
-- The properties stored in this class are the following:
-- - area of the contour,
-- - perimeter of the contour,
-- - ratio of average length to average width of the contour,
-- - average width of contour,
-- - notches (narrow 'V'-like sub-contours) on the contour and
-- their maximum width.
--
-- This class provides methods for setting and getting fields
-- only.
uses
Wire from TopoDS,
HSequenceOfShape from TopTools,
DataMapOfShapeReal from TopTools
is
Create returns FreeBoundData from ShapeAnalysis;
---Purpose: Empty constructor
Create (freebound: Wire from TopoDS)
returns FreeBoundData from ShapeAnalysis;
---Purpose: Creates object with contour given in the form of TopoDS_Wire
Clear (me: mutable);
---Purpose: Clears all properties of the contour.
-- Contour bound itself is not cleared.
-- Methods for setting fields
SetFreeBound (me: mutable; freebound: Wire from TopoDS);
---Purpose: Sets contour
---C++: inline
SetArea (me: mutable; area: Real);
---Purpose: Sets area of the contour
---C++: inline
SetPerimeter (me: mutable; perimeter: Real);
---Purpose: Sets perimeter of the contour
---C++: inline
SetRatio (me: mutable; ratio: Real);
---Purpose: Sets ratio of average length to average width of the contour
---C++: inline
SetWidth (me: mutable; width: Real);
---Purpose: Sets average width of the contour
---C++: inline
AddNotch (me: mutable; notch: Wire from TopoDS; width: Real);
---Purpose: Adds notch on the contour with its maximum width
-- Methods for getting fields
FreeBound (me) returns Wire from TopoDS;
---Purpose: Returns contour
---C++: inline
Area (me) returns Real;
---Purpose: Returns area of the contour
---C++: inline
Perimeter (me) returns Real;
---Purpose: Returns perimeter of the contour
---C++: inline
Ratio (me) returns Real;
---Purpose: Returns ratio of average length to average width of the contour
---C++: inline
Width (me) returns Real;
---Purpose: Returns average width of the contour
---C++: inline
NbNotches (me) returns Integer;
---Purpose: Returns number of notches on the contour
---C++: inline
Notches (me) returns HSequenceOfShape from TopTools;
---Purpose: Returns sequence of notches on the contour
---C++: inline
Notch (me; index: Integer) returns Wire from TopoDS;
---Purpose: Returns notch on the contour
---C++: inline
NotchWidth (me; index: Integer) returns Real;
---Purpose: Returns maximum width of notch specified by its rank number
-- on the contour
NotchWidth (me; notch: Wire from TopoDS) returns Real;
---Purpose: Returns maximum width of notch specified as TopoDS_Wire
-- on the contour
fields
myBound : Wire from TopoDS;
myArea : Real;
myPerimeter : Real;
myRatio : Real;
myWidth : Real;
myNotches : HSequenceOfShape from TopTools;
myNotchesParams: DataMapOfShapeReal from TopTools;
end FreeBoundData;