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
0029 class IGESSolid_ConeFrustum;
0030 DEFINE_STANDARD_HANDLE(IGESSolid_ConeFrustum, IGESData_IGESEntity)
0031
0032 //! defines ConeFrustum, Type <156> Form Number <0>
0033 //! in package IGESSolid
0034 //! The Cone Frustum is defined by the center of the
0035 //! larger circular face of the frustum, its radius, a unit
0036 //! vector in the axis direction, a height in this direction
0037 //! and a second circular face with radius which is lesser
0038 //! than the first face.
0039 class IGESSolid_ConeFrustum : public IGESData_IGESEntity
0040 {
0041
0042 public:
0043
0044
0045   Standard_EXPORT IGESSolid_ConeFrustum();
0046
0047   //! This method is used to set the fields of the class
0048   //! ConeFrustum
0049   //! - Ht     : the Height of cone
0050   //! - R1     : Radius of the larger face
0051   //! - R2     : Radius of the smaller face (default 0)
0052   //! - Center : Center of the larger face (default (0,0,0))
0053   //! - anAxis : Unit vector in axis direction (default (0,0,1))
0054   Standard_EXPORT void Init (const Standard_Real Ht, const Standard_Real R1, const Standard_Real R2, const gp_XYZ& Center, const gp_XYZ& anAxis);
0055
0056   //! returns the height of the cone frustum
0057   Standard_EXPORT Standard_Real Height() const;
0058
0059   //! returns the radius of the larger face of the cone frustum
0060   Standard_EXPORT Standard_Real LargerRadius() const;
0061
0062   //! returns the radius of the second face of the cone frustum
0063   Standard_EXPORT Standard_Real SmallerRadius() const;
0064
0065   //! returns the center of the larger face of the cone frustum
0066   Standard_EXPORT gp_Pnt FaceCenter() const;
0067
0068   //! returns the center of the larger face of the cone frustum
0069   //! after applying TransformationMatrix
0070   Standard_EXPORT gp_Pnt TransformedFaceCenter() const;
0071
0072   //! returns the direction of the axis of the cone frustum
0073   Standard_EXPORT gp_Dir Axis() const;
0074
0075   //! returns the direction of the axis of the cone frustum
0076   //! after applying TransformationMatrix
0077   Standard_EXPORT gp_Dir TransformedAxis() const;
0078
0079
0080
0081
0082   DEFINE_STANDARD_RTTIEXT(IGESSolid_ConeFrustum,IGESData_IGESEntity)
0083
0084 protected:
0085
0086
0087
0088
0089 private:
0090
0091
0092   Standard_Real theHeight;
0093   Standard_Real theR1;
0094   Standard_Real theR2;
0095   gp_XYZ theFaceCenter;
0096   gp_XYZ theAxis;
0097
0098
0099 };
0100
0101
0102
0103
0104
0105
0106
0107 #endif // _IGESSolid_ConeFrustum_HeaderFile