include/opencascade/Vrml_Cone.hxx

0001 // Created on: 1996-12-24
0002 // Created by: Alexander BRIVIN
0003 // Copyright (c) 1996-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 _Vrml_Cone_HeaderFile
0018 #define _Vrml_Cone_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <Vrml_ConeParts.hxx>
0025 #include <Standard_Real.hxx>
0026 #include <Standard_OStream.hxx>
0027
0028 //! defines a Cone node of VRML specifying geometry shapes.
0029 //! This node represents a simple cone, whose central axis is aligned
0030 //! with the y-axis. By default, the cone is centred at (0,0,0)
0031 //! and has size of -1 to +1 in the all three directions.
0032 //! the cone has a radius of 1 at the bottom and height of 2,
0033 //! with its apex at 1 and its bottom at -1. The cone has two parts:
0034 //! the sides and the bottom
0035 class Vrml_Cone
0036 {
0037 public:
0038   DEFINE_STANDARD_ALLOC
0039
0040   Standard_EXPORT Vrml_Cone(const Vrml_ConeParts aParts        = Vrml_ConeALL,
0041                             const double         aBottomRadius = 1,
0042                             const double         aHeight       = 2);
0043
0044   Standard_EXPORT void SetParts(const Vrml_ConeParts aParts);
0045
0046   Standard_EXPORT Vrml_ConeParts Parts() const;
0047
0048   Standard_EXPORT void SetBottomRadius(const double aBottomRadius);
0049
0050   Standard_EXPORT double BottomRadius() const;
0051
0052   Standard_EXPORT void SetHeight(const double aHeight);
0053
0054   Standard_EXPORT double Height() const;
0055
0056   Standard_EXPORT Standard_OStream& Print(Standard_OStream& anOStream) const;
0057
0058 private:
0059   Vrml_ConeParts myParts;
0060   double         myBottomRadius;
0061   double         myHeight;
0062 };
0063
0064 #endif // _Vrml_Cone_HeaderFile