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