EIC code displayed by LXR master/​include/​opencascade/​Poly_Polygon3D.hxx	Source navigation Diff markup Identifier search General search
	Version: master test Revert   Change

File indexing completed on 2025-01-18 10:04:38

 // 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.
 
 #ifndef _Poly_Polygon3D_HeaderFile
 #define _Poly_Polygon3D_HeaderFile
 
 #include <Standard_Transient.hxx>
 #include <TColgp_Array1OfPnt.hxx>
 #include <TColStd_HArray1OfReal.hxx>
 
 DEFINE_STANDARD_HANDLE(Poly_Polygon3D, Standard_Transient)
 
 //! 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.
 class Poly_Polygon3D : public Standard_Transient
 {
 public:
 
   //! Constructs a 3D polygon with specific number of nodes.
   Standard_EXPORT Poly_Polygon3D (const Standard_Integer theNbNodes,
                                   const Standard_Boolean theHasParams);
 
   //! Constructs a 3D polygon defined by the table of points, Nodes.
   Standard_EXPORT Poly_Polygon3D(const TColgp_Array1OfPnt& Nodes);
   
   //! 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.
   Standard_EXPORT Poly_Polygon3D(const TColgp_Array1OfPnt& Nodes, const TColStd_Array1OfReal& Parameters);
 
   //! Creates a copy of current polygon
   Standard_EXPORT virtual Handle(Poly_Polygon3D) Copy() const;
   
   //! Returns the deflection of this polygon
   Standard_Real Deflection() const { return myDeflection; }
 
   //! Sets the deflection of this polygon. See more on deflection in Poly_Polygon2D
   void Deflection (const Standard_Real theDefl) { myDeflection = theDefl; }
   
   //! 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.
   Standard_Integer NbNodes() const { return myNodes.Length(); }
 
   //! Returns the table of nodes for this polygon.
   const TColgp_Array1OfPnt& Nodes() const { return myNodes; }
 
   //! Returns the table of nodes for this polygon.
   TColgp_Array1OfPnt& ChangeNodes() { return myNodes; }
 
   //! 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.
   Standard_Boolean HasParameters() const { return !myParameters.IsNull(); }
   
   //! Returns true if parameters are associated with the nodes
   //! in this polygon.
   const TColStd_Array1OfReal& Parameters() const { return myParameters->Array1(); }
 
   //! Returns the table of the parameters associated with each node in this polygon.
   //! ChangeParameters function returns 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.
   TColStd_Array1OfReal& ChangeParameters() const { return myParameters->ChangeArray1(); }
 
   //! Dumps the content of me into the stream
   Standard_EXPORT virtual void DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth = -1) const;
 
   DEFINE_STANDARD_RTTIEXT(Poly_Polygon3D,Standard_Transient)
 
 private:
 
   Standard_Real myDeflection;
   TColgp_Array1OfPnt myNodes;
   Handle(TColStd_HArray1OfReal) myParameters;
 
 };
 
 #endif // _Poly_Polygon3D_HeaderFile

This page was automatically generated by the 2.3.7 LXR engine. The LXR team