include/opencascade/IGESSolid_VertexList.hxx

0001 // Created on: 1993-01-09
0002 // Created by: CKY / Contract Toubro-Larsen ( SIVA )
0003 // Copyright (c) 1993-1999 Matra Datavision
0004 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016
0017 #ifndef _IGESSolid_VertexList_HeaderFile
0018 #define _IGESSolid_VertexList_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <gp_XYZ.hxx>
0024 #include <NCollection_Array1.hxx>
0025 #include <NCollection_HArray1.hxx>
0026 #include <IGESData_IGESEntity.hxx>
0027 #include <Standard_Integer.hxx>
0028 class gp_Pnt;
0029
0030 //! defines VertexList, Type <502> Form Number <1>
0031 //! in package IGESSolid
0032 //! A vertex is a point in R3. A vertex is the bound of an
0033 //! edge and can participate in the bounds of a face.
0034 //! It contains one or more vertices.
0035 class IGESSolid_VertexList : public IGESData_IGESEntity
0036 {
0037
0038 public:
0039   Standard_EXPORT IGESSolid_VertexList();
0040
0041   //! This method is used to set the fields of the class
0042   //! VertexList
0043   //! - vertices : the vertices in the list
0044   Standard_EXPORT void Init(const occ::handle<NCollection_HArray1<gp_XYZ>>& vertices);
0045
0046   //! return the number of vertices in the list
0047   Standard_EXPORT int NbVertices() const;
0048
0049   //! returns the num'th vertex in the list
0050   //! raises exception if num <= 0 or num > NbVertices()
0051   Standard_EXPORT gp_Pnt Vertex(const int num) const;
0052
0053   DEFINE_STANDARD_RTTIEXT(IGESSolid_VertexList, IGESData_IGESEntity)
0054
0055 private:
0056   occ::handle<NCollection_HArray1<gp_XYZ>> theVertices;
0057 };
0058
0059 #endif // _IGESSolid_VertexList_HeaderFile