include/opencascade/IGESSolid_ConeFrustum.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_ConeFrustum_HeaderFile
0018 #define _IGESSolid_ConeFrustum_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <gp_XYZ.hxx>
0024 #include <IGESData_IGESEntity.hxx>
0025 class gp_Pnt;
0026 class gp_Dir;
0027
0028 //! defines ConeFrustum, Type <156> Form Number <0>
0029 //! in package IGESSolid
0030 //! The Cone Frustum is defined by the center of the
0031 //! larger circular face of the frustum, its radius, a unit
0032 //! vector in the axis direction, a height in this direction
0033 //! and a second circular face with radius which is lesser
0034 //! than the first face.
0035 class IGESSolid_ConeFrustum : public IGESData_IGESEntity
0036 {
0037
0038 public:
0039   Standard_EXPORT IGESSolid_ConeFrustum();
0040
0041   //! This method is used to set the fields of the class
0042   //! ConeFrustum
0043   //! - Ht     : the Height of cone
0044   //! - R1     : Radius of the larger face
0045   //! - R2     : Radius of the smaller face (default 0)
0046   //! - Center : Center of the larger face (default (0,0,0))
0047   //! - anAxis : Unit vector in axis direction (default (0,0,1))
0048   Standard_EXPORT void Init(const double  Ht,
0049                             const double  R1,
0050                             const double  R2,
0051                             const gp_XYZ& Center,
0052                             const gp_XYZ& anAxis);
0053
0054   //! returns the height of the cone frustum
0055   Standard_EXPORT double Height() const;
0056
0057   //! returns the radius of the larger face of the cone frustum
0058   Standard_EXPORT double LargerRadius() const;
0059
0060   //! returns the radius of the second face of the cone frustum
0061   Standard_EXPORT double SmallerRadius() const;
0062
0063   //! returns the center of the larger face of the cone frustum
0064   Standard_EXPORT gp_Pnt FaceCenter() const;
0065
0066   //! returns the center of the larger face of the cone frustum
0067   //! after applying TransformationMatrix
0068   Standard_EXPORT gp_Pnt TransformedFaceCenter() const;
0069
0070   //! returns the direction of the axis of the cone frustum
0071   Standard_EXPORT gp_Dir Axis() const;
0072
0073   //! returns the direction of the axis of the cone frustum
0074   //! after applying TransformationMatrix
0075   Standard_EXPORT gp_Dir TransformedAxis() const;
0076
0077   DEFINE_STANDARD_RTTIEXT(IGESSolid_ConeFrustum, IGESData_IGESEntity)
0078
0079 private:
0080   double theHeight;
0081   double theR1;
0082   double theR2;
0083   gp_XYZ theFaceCenter;
0084   gp_XYZ theAxis;
0085 };
0086
0087 #endif // _IGESSolid_ConeFrustum_HeaderFile