include/opencascade/IGESSolid_CylindricalSurface.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_CylindricalSurface_HeaderFile
0018 #define _IGESSolid_CylindricalSurface_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
0028 class IGESSolid_CylindricalSurface;
0029 DEFINE_STANDARD_HANDLE(IGESSolid_CylindricalSurface, IGESData_IGESEntity)
0030
0031 //! defines CylindricalSurface, Type <192> Form Number <0,1>
0032 //! in package IGESSolid
0033 class IGESSolid_CylindricalSurface : public IGESData_IGESEntity
0034 {
0035
0036 public:
0037
0038
0039   Standard_EXPORT IGESSolid_CylindricalSurface();
0040
0041   //! This method is used to set the fields of the class
0042   //! CylindricalSurface
0043   //! - aLocation : the location of the point on axis
0044   //! - anAxis    : the direction of the axis
0045   //! - aRadius   : the radius at the axis point
0046   //! - aRefdir   : the reference direction (parametrised surface)
0047   //! default NULL (unparametrised surface)
0048   Standard_EXPORT void Init (const Handle(IGESGeom_Point)& aLocation, const Handle(IGESGeom_Direction)& anAxis, const Standard_Real aRadius, const Handle(IGESGeom_Direction)& aRefdir);
0049
0050   //! returns the point on the axis
0051   Standard_EXPORT Handle(IGESGeom_Point) LocationPoint() const;
0052
0053   //! returns the direction on the axis
0054   Standard_EXPORT Handle(IGESGeom_Direction) Axis() const;
0055
0056   //! returns the radius at the axis point
0057   Standard_EXPORT Standard_Real Radius() const;
0058
0059   //! returns whether the surface is parametrised or not
0060   Standard_EXPORT Standard_Boolean IsParametrised() const;
0061
0062   //! returns the reference direction only for parametrised surface
0063   //! else returns NULL
0064   Standard_EXPORT Handle(IGESGeom_Direction) ReferenceDir() const;
0065
0066
0067
0068
0069   DEFINE_STANDARD_RTTIEXT(IGESSolid_CylindricalSurface,IGESData_IGESEntity)
0070
0071 protected:
0072
0073
0074
0075
0076 private:
0077
0078
0079   Handle(IGESGeom_Point) theLocationPoint;
0080   Handle(IGESGeom_Direction) theAxis;
0081   Standard_Real theRadius;
0082   Handle(IGESGeom_Direction) theRefDir;
0083
0084
0085 };
0086
0087
0088
0089
0090
0091
0092
0093 #endif // _IGESSolid_CylindricalSurface_HeaderFile