include/opencascade/IGESSolid_PlaneSurface.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_PlaneSurface_HeaderFile
0018 #define _IGESSolid_PlaneSurface_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <IGESData_IGESEntity.hxx>
0024 class IGESGeom_Point;
0025 class IGESGeom_Direction;
0026
0027 //! defines PlaneSurface, Type <190> Form Number <0,1>
0028 //! in package IGESSolid
0029 //! A plane surface entity is defined by a point on the
0030 //! surface and a normal to it.
0031 class IGESSolid_PlaneSurface : public IGESData_IGESEntity
0032 {
0033
0034 public:
0035   Standard_EXPORT IGESSolid_PlaneSurface();
0036
0037   //! This method is used to set the fields of the class
0038   //! PlaneSurface
0039   //! - aLocation : the point on the surface
0040   //! - aNormal   : the surface normal direction
0041   //! - refdir    : the reference direction (default NULL) for
0042   //! unparameterised curves
0043   Standard_EXPORT void Init(const occ::handle<IGESGeom_Point>&     aLocation,
0044                             const occ::handle<IGESGeom_Direction>& aNormal,
0045                             const occ::handle<IGESGeom_Direction>& refdir);
0046
0047   //! returns the point on the surface
0048   Standard_EXPORT occ::handle<IGESGeom_Point> LocationPoint() const;
0049
0050   //! returns the normal to the surface
0051   Standard_EXPORT occ::handle<IGESGeom_Direction> Normal() const;
0052
0053   //! returns the reference direction (for parameterised curve)
0054   //! returns NULL for unparameterised curve
0055   Standard_EXPORT occ::handle<IGESGeom_Direction> ReferenceDir() const;
0056
0057   //! returns True if parameterised, else False
0058   Standard_EXPORT bool IsParametrised() const;
0059
0060   DEFINE_STANDARD_RTTIEXT(IGESSolid_PlaneSurface, IGESData_IGESEntity)
0061
0062 private:
0063   occ::handle<IGESGeom_Point>     theLocationPoint;
0064   occ::handle<IGESGeom_Direction> theNormal;
0065   occ::handle<IGESGeom_Direction> theRefDir;
0066 };
0067
0068 #endif // _IGESSolid_PlaneSurface_HeaderFile