include/opencascade/IGESSolid_Loop.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_Loop_HeaderFile
0018 #define _IGESSolid_Loop_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <TColStd_HArray1OfInteger.hxx>
0024 #include <IGESData_HArray1OfIGESEntity.hxx>
0025 #include <IGESData_IGESEntity.hxx>
0026 #include <Standard_Integer.hxx>
0027 class IGESBasic_HArray1OfHArray1OfInteger;
0028 class IGESBasic_HArray1OfHArray1OfIGESEntity;
0029
0030
0031 class IGESSolid_Loop;
0032 DEFINE_STANDARD_HANDLE(IGESSolid_Loop, IGESData_IGESEntity)
0033
0034 //! defines Loop, Type <508> Form Number <1>
0035 //! in package IGESSolid
0036 //! A Loop entity specifies a bound of a face. It represents
0037 //! a connected collection of face boundaries, seams, and
0038 //! poles of a single face.
0039 //!
0040 //! From IGES-5.3, a Loop can be free with Form Number 0,
0041 //! else it is a bound of a face (it is the default)
0042 class IGESSolid_Loop : public IGESData_IGESEntity
0043 {
0044
0045 public:
0046
0047
0048   Standard_EXPORT IGESSolid_Loop();
0049
0050   //! This method is used to set the fields of the class Loop
0051   //! - types              : 0 = Edge; 1 = Vertex
0052   //! - edges              : Pointer to the EdgeList or VertexList
0053   //! - index              : Index of the edge into the EdgeList
0054   //! VertexList entity
0055   //! - orient             : Orientation flag of the edge
0056   //! - nbParameterCurves  : the number of parameter space curves
0057   //! for each edge
0058   //! - isoparametricFlags : the isoparametric flag of the
0059   //! parameter space curve
0060   //! - curves             : the parameter space curves
0061   //! raises exception if length of types, edges, index, orient and
0062   //! nbParameterCurves do not match or the length of
0063   //! isoparametricFlags and curves do not match
0064   Standard_EXPORT void Init (const Handle(TColStd_HArray1OfInteger)& types, const Handle(IGESData_HArray1OfIGESEntity)& edges, const Handle(TColStd_HArray1OfInteger)& index, const Handle(TColStd_HArray1OfInteger)& orient, const Handle(TColStd_HArray1OfInteger)& nbParameterCurves, const Handle(IGESBasic_HArray1OfHArray1OfInteger)& isoparametricFlags, const Handle(IGESBasic_HArray1OfHArray1OfIGESEntity)& curves);
0065
0066   //! Tells if a Loop is a Bound (FN 1) else it is free (FN 0)
0067   Standard_EXPORT Standard_Boolean IsBound() const;
0068
0069   //! Sets or Unset the Bound Status (from Form Number)
0070   //! Default is True
0071   Standard_EXPORT void SetBound (const Standard_Boolean bound);
0072
0073   //! returns the number of edge tuples
0074   Standard_EXPORT Standard_Integer NbEdges() const;
0075
0076   //! returns the type of Index'th edge (0 = Edge, 1 = Vertex)
0077   //! raises exception if Index <= 0 or Index > NbEdges()
0078   Standard_EXPORT Standard_Integer EdgeType (const Standard_Integer Index) const;
0079
0080   //! return the EdgeList or VertexList corresponding to the Index
0081   //! raises exception if Index <= 0 or Index > NbEdges()
0082   Standard_EXPORT Handle(IGESData_IGESEntity) Edge (const Standard_Integer Index) const;
0083
0084   //! returns the orientation flag corresponding to Index'th edge
0085   //! raises exception if Index <= 0 or Index > NbEdges()
0086   Standard_EXPORT Standard_Boolean Orientation (const Standard_Integer Index) const;
0087
0088   //! return the number of parameter space curves associated with
0089   //! Index'th Edge
0090   //! raises exception if Index <= 0 or Index > NbEdges()
0091   Standard_EXPORT Standard_Integer NbParameterCurves (const Standard_Integer Index) const;
0092
0093   Standard_EXPORT Standard_Boolean IsIsoparametric (const Standard_Integer EdgeIndex, const Standard_Integer CurveIndex) const;
0094
0095   //! returns the CurveIndex'th parameter space curve associated with
0096   //! EdgeIndex'th edge
0097   //! raises exception if EdgeIndex <= 0 or EdgeIndex > NbEdges() or
0098   //! if CurveIndex <= 0 or CurveIndex > NbParameterCurves(EdgeIndex)
0099   Standard_EXPORT Handle(IGESData_IGESEntity) ParametricCurve (const Standard_Integer EdgeIndex, const Standard_Integer CurveIndex) const;
0100
0101   //! raises exception If num <= 0 or num > NbEdges()
0102   Standard_EXPORT Standard_Integer ListIndex (const Standard_Integer num) const;
0103
0104
0105
0106
0107   DEFINE_STANDARD_RTTIEXT(IGESSolid_Loop,IGESData_IGESEntity)
0108
0109 protected:
0110
0111
0112
0113
0114 private:
0115
0116
0117   Handle(TColStd_HArray1OfInteger) theTypes;
0118   Handle(IGESData_HArray1OfIGESEntity) theEdges;
0119   Handle(TColStd_HArray1OfInteger) theIndex;
0120   Handle(TColStd_HArray1OfInteger) theOrientationFlags;
0121   Handle(TColStd_HArray1OfInteger) theNbParameterCurves;
0122   Handle(IGESBasic_HArray1OfHArray1OfInteger) theIsoparametricFlags;
0123   Handle(IGESBasic_HArray1OfHArray1OfIGESEntity) theCurves;
0124
0125
0126 };
0127
0128
0129
0130
0131
0132
0133
0134 #endif // _IGESSolid_Loop_HeaderFile