src/Poly/Poly_Polygon3D.hxx

   1 // Created on: 1995-03-07
   2 // Created by: Laurent PAINNOT
   3 // Copyright (c) 1995-1999 Matra Datavision
   4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
   5 //
   6 // This file is part of Open CASCADE Technology software library.
   7 //
   8 // This library is free software; you can redistribute it and/or modify it under
   9 // the terms of the GNU Lesser General Public License version 2.1 as published
  10 // by the Free Software Foundation, with special exception defined in the file
  11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  12 // distribution for complete text of the license and disclaimer of any warranty.
  13 //
  14 // Alternatively, this file may be used under the terms of Open CASCADE
  15 // commercial license or contractual agreement.
  16
  17 #ifndef _Poly_Polygon3D_HeaderFile
  18 #define _Poly_Polygon3D_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_Type.hxx>
  22
  23 #include <Standard_Real.hxx>
  24 #include <TColgp_Array1OfPnt.hxx>
  25 #include <TColStd_HArray1OfReal.hxx>
  26 #include <MMgt_TShared.hxx>
  27 #include <TColStd_Array1OfReal.hxx>
  28 #include <Standard_Integer.hxx>
  29 #include <Standard_Boolean.hxx>
  30 class Standard_NullObject;
  31
  32
  33 class Poly_Polygon3D;
  34 DEFINE_STANDARD_HANDLE(Poly_Polygon3D, MMgt_TShared)
  35
  36 //! This class Provides a polygon in 3D space. It is generally an approximate representation of a curve.
  37 //! A Polygon3D is defined by a table of nodes. Each node is
  38 //! a 3D point. If the polygon is closed, the point of closure is
  39 //! repeated at the end of the table of nodes.
  40 //! If the polygon is an approximate representation of a curve,
  41 //! you can associate with each of its nodes the value of the
  42 //! parameter of the corresponding point on the curve.
  43 class Poly_Polygon3D : public MMgt_TShared
  44 {
  45
  46 public:
  47
  48
  49   //! onstructs a 3D polygon defined by the table of points, Nodes.
  50   Standard_EXPORT Poly_Polygon3D(const TColgp_Array1OfPnt& Nodes);
  51
  52   //! Constructs a 3D polygon defined by
  53   //! the table of points, Nodes, and the parallel table of
  54   //! parameters, Parameters, where each value of the table
  55   //! Parameters is the parameter of the corresponding point
  56   //! on the curve approximated by the constructed polygon.
  57   //! Warning
  58   //! Both the Nodes and Parameters tables must have the
  59   //! same bounds. This property is not checked at construction time.
  60   Standard_EXPORT Poly_Polygon3D(const TColgp_Array1OfPnt& Nodes, const TColStd_Array1OfReal& Parameters);
  61
  62   //! Returns the deflection of this polygon
  63   Standard_EXPORT Standard_Real Deflection() const;
  64
  65   //! Sets the deflection of this polygon to D. See more on deflection in Poly_Polygon2D
  66   Standard_EXPORT void Deflection (const Standard_Real D);
  67
  68   //! Returns the number of nodes in this polygon.
  69   //! Note: If the polygon is closed, the point of closure is
  70   //! repeated at the end of its table of nodes. Thus, on a closed
  71   //! triangle the function NbNodes returns 4.
  72     Standard_Integer NbNodes() const;
  73
  74   //! Returns the table of nodes for this polygon.
  75   Standard_EXPORT const TColgp_Array1OfPnt& Nodes() const;
  76
  77   //! Returns the table of the parameters associated with each node in this polygon.
  78   //! HasParameters function checks if   parameters are associated with the nodes of this polygon.
  79   Standard_EXPORT Standard_Boolean HasParameters() const;
  80
  81   //! Returns true if parameters are associated with the nodes
  82   //! in this polygon.
  83   Standard_EXPORT const TColStd_Array1OfReal& Parameters() const;
  84
  85   //! Returns the table of the parameters associated with each node in this polygon.
  86   //! ChangeParameters function returnes the  array as shared. Therefore if the table is selected by
  87   //! reference you can, by simply modifying it, directly modify
  88   //! the data structure of this polygon.
  89   Standard_EXPORT TColStd_Array1OfReal& ChangeParameters() const;
  90
  91
  92
  93
  94   DEFINE_STANDARD_RTTI(Poly_Polygon3D,MMgt_TShared)
  95
  96 protected:
  97
  98
  99
 100
 101 private:
 102
 103
 104   Standard_Real myDeflection;
 105   TColgp_Array1OfPnt myNodes;
 106   Handle(TColStd_HArray1OfReal) myParameters;
 107
 108
 109 };
 110
 111
 112 #include <Poly_Polygon3D.lxx>
 113
 114
 115
 116
 117
 118 #endif // _Poly_Polygon3D_HeaderFile