src/IGESSolid/IGESSolid_ConicalSurface.hxx

   1 // Created on: 1993-01-09
   2 // Created by: CKY / Contract Toubro-Larsen ( SIVA )
   3 // Copyright (c) 1993-1999 Matra Datavision
   4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
   5 //
   6 // This file is part of Open CASCADE Technology software library.
   7 //
   8 // This library is free software; you can redistribute it and/or modify it under
   9 // the terms of the GNU Lesser General Public License version 2.1 as published
  10 // by the Free Software Foundation, with special exception defined in the file
  11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  12 // distribution for complete text of the license and disclaimer of any warranty.
  13 //
  14 // Alternatively, this file may be used under the terms of Open CASCADE
  15 // commercial license or contractual agreement.
  16
  17 #ifndef _IGESSolid_ConicalSurface_HeaderFile
  18 #define _IGESSolid_ConicalSurface_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_Type.hxx>
  22
  23 #include <Standard_Real.hxx>
  24 #include <IGESData_IGESEntity.hxx>
  25 #include <Standard_Boolean.hxx>
  26 class IGESGeom_Point;
  27 class IGESGeom_Direction;
  28
  29
  30 class IGESSolid_ConicalSurface;
  31 DEFINE_STANDARD_HANDLE(IGESSolid_ConicalSurface, IGESData_IGESEntity)
  32
  33 //! defines ConicalSurface, Type <194> Form Number <0,1>
  34 //! in package IGESSolid
  35 //! The right circular conical surface is defined by a
  36 //! point on the axis on the cone, the direction of the axis
  37 //! of the cone, the radius of the cone at the axis point and
  38 //! the cone semi-angle.
  39 class IGESSolid_ConicalSurface : public IGESData_IGESEntity
  40 {
  41
  42 public:
  43
  44
  45   Standard_EXPORT IGESSolid_ConicalSurface();
  46
  47   //! This method is used to set the fields of the class
  48   //! ConicalSurface
  49   //! - aLocation : Location of the point on axis
  50   //! - anAxis    : Direction of the axis
  51   //! - aRadius   : Radius at axis point
  52   //! - anAngle   : Value of semi-angle in degrees (0<angle<90)
  53   //! - aRefdir   : Reference direction (parametrised surface)
  54   //! Null if unparametrised surface.
  55   Standard_EXPORT void Init (const Handle(IGESGeom_Point)& aLocation, const Handle(IGESGeom_Direction)& anAxis, const Standard_Real aRadius, const Standard_Real anAngle, const Handle(IGESGeom_Direction)& aRefdir);
  56
  57   //! returns the location of the point on the axis
  58   Standard_EXPORT Handle(IGESGeom_Point) LocationPoint() const;
  59
  60   //! returns the direction of the axis
  61   Standard_EXPORT Handle(IGESGeom_Direction) Axis() const;
  62
  63   //! returns the radius at the axis point
  64   Standard_EXPORT Standard_Real Radius() const;
  65
  66   //! returns the semi-angle value
  67   Standard_EXPORT Standard_Real SemiAngle() const;
  68
  69   //! returns the reference direction of the conical surface in case
  70   //! of parametrised surface. For unparametrised surface it returns
  71   //! NULL.
  72   Standard_EXPORT Handle(IGESGeom_Direction) ReferenceDir() const;
  73
  74   //! returns True if Form no is 1 else false
  75   Standard_EXPORT Standard_Boolean IsParametrised() const;
  76
  77
  78
  79
  80   DEFINE_STANDARD_RTTIEXT(IGESSolid_ConicalSurface,IGESData_IGESEntity)
  81
  82 protected:
  83
  84
  85
  86
  87 private:
  88
  89
  90   Handle(IGESGeom_Point) theLocationPoint;
  91   Handle(IGESGeom_Direction) theAxis;
  92   Standard_Real theRadius;
  93   Standard_Real theAngle;
  94   Handle(IGESGeom_Direction) theRefDir;
  95
  96
  97 };
  98
  99
 100
 101
 102
 103
 104
 105 #endif // _IGESSolid_ConicalSurface_HeaderFile