1
0
mirror of https://git.dev.opencascade.org/repos/occt.git synced 2025-04-09 18:50:54 +03:00
occt/src/Poly/Poly_Polygon3D.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

96 lines
3.9 KiB
Plaintext

-- Created on: 1995-03-07
-- Created by: Laurent PAINNOT
-- Copyright (c) 1995-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.
class Polygon3D from Poly inherits TShared from MMgt
---Purpose: This class Provides a polygon in 3D space. It is generally an approximate representation of a curve.
-- A Polygon3D is defined by a table of nodes. Each node is
-- a 3D point. If the polygon is closed, the point of closure is
-- repeated at the end of the table of nodes.
-- If the polygon is an approximate representation of a curve,
-- you can associate with each of its nodes the value of the
-- parameter of the corresponding point on the curve.
uses Array1OfPnt from TColgp,
Array1OfReal from TColStd,
HArray1OfReal from TColStd
raises NullObject from Standard
is
Create(Nodes: Array1OfPnt from TColgp)
returns Polygon3D from Poly;
---Purpose: onstructs a 3D polygon defined by the table of points, Nodes.
Create(Nodes: Array1OfPnt from TColgp;
Parameters: Array1OfReal from TColStd)
returns Polygon3D from Poly;
---Purpose: Constructs a 3D polygon defined by
-- the table of points, Nodes, and the parallel table of
-- parameters, Parameters, where each value of the table
-- Parameters is the parameter of the corresponding point
-- on the curve approximated by the constructed polygon.
-- Warning
-- Both the Nodes and Parameters tables must have the
-- same bounds. This property is not checked at construction time.
Deflection(me) returns Real;
---Purpose: Returns the deflection of this polygon
Deflection(me : mutable; D : Real);
---Purpose: Sets the deflection of this polygon to D. See more on deflection in Poly_Polygon2D
NbNodes(me) returns Integer;
---Purpose: Returns the number of nodes in this polygon.
-- Note: If the polygon is closed, the point of closure is
-- repeated at the end of its table of nodes. Thus, on a closed
-- triangle the function NbNodes returns 4.
---C++: inline
Nodes(me) returns Array1OfPnt from TColgp
---Purpose: Returns the table of nodes for this polygon.
---C++: return const &
raises NullObject from Standard;
HasParameters(me) returns Boolean from Standard;
---Purpose: Returns the table of the parameters associated with each node in this polygon.
-- HasParameters function checks if parameters are associated with the nodes of this polygon.
Parameters(me) returns Array1OfReal from TColStd
---Purpose: Returns true if parameters are associated with the nodes
-- in this polygon.
---C++: return const &
raises NullObject from Standard;
ChangeParameters(me) returns Array1OfReal from TColStd
---Purpose: Returns the table of the parameters associated with each node in this polygon.
-- ChangeParameters function returnes the array as shared. Therefore if the table is selected by
-- reference you can, by simply modifying it, directly modify
-- the data structure of this polygon.
---C++: return &
raises NullObject from Standard;
fields
myDeflection: Real from Standard;
myNodes: Array1OfPnt from TColgp;
myParameters: HArray1OfReal from TColStd;
end Polygon3D;