include/opencascade/IGESSolid_ConicalSurface.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_ConicalSurface_HeaderFile
0018 #define _IGESSolid_ConicalSurface_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 ConicalSurface, Type <194> Form Number <0,1>
0028 //! in package IGESSolid
0029 //! The right circular conical surface is defined by a
0030 //! point on the axis on the cone, the direction of the axis
0031 //! of the cone, the radius of the cone at the axis point and
0032 //! the cone semi-angle.
0033 class IGESSolid_ConicalSurface : public IGESData_IGESEntity
0034 {
0035
0036 public:
0037   Standard_EXPORT IGESSolid_ConicalSurface();
0038
0039   //! This method is used to set the fields of the class
0040   //! ConicalSurface
0041   //! - aLocation : Location of the point on axis
0042   //! - anAxis    : Direction of the axis
0043   //! - aRadius   : Radius at axis point
0044   //! - anAngle   : Value of semi-angle in degrees (0<angle<90)
0045   //! - aRefdir   : Reference direction (parametrised surface)
0046   //! Null if unparametrised surface.
0047   Standard_EXPORT void Init(const occ::handle<IGESGeom_Point>&     aLocation,
0048                             const occ::handle<IGESGeom_Direction>& anAxis,
0049                             const double                           aRadius,
0050                             const double                           anAngle,
0051                             const occ::handle<IGESGeom_Direction>& aRefdir);
0052
0053   //! returns the location of the point on the axis
0054   Standard_EXPORT occ::handle<IGESGeom_Point> LocationPoint() const;
0055
0056   //! returns the direction of the axis
0057   Standard_EXPORT occ::handle<IGESGeom_Direction> Axis() const;
0058
0059   //! returns the radius at the axis point
0060   Standard_EXPORT double Radius() const;
0061
0062   //! returns the semi-angle value
0063   Standard_EXPORT double SemiAngle() const;
0064
0065   //! returns the reference direction of the conical surface in case
0066   //! of parametrised surface. For unparametrised surface it returns
0067   //! NULL.
0068   Standard_EXPORT occ::handle<IGESGeom_Direction> ReferenceDir() const;
0069
0070   //! returns True if Form no is 1 else false
0071   Standard_EXPORT bool IsParametrised() const;
0072
0073   DEFINE_STANDARD_RTTIEXT(IGESSolid_ConicalSurface, IGESData_IGESEntity)
0074
0075 private:
0076   occ::handle<IGESGeom_Point>     theLocationPoint;
0077   occ::handle<IGESGeom_Direction> theAxis;
0078   double                          theRadius;
0079   double                          theAngle;
0080   occ::handle<IGESGeom_Direction> theRefDir;
0081 };
0082
0083 #endif // _IGESSolid_ConicalSurface_HeaderFile