include/opencascade/Vrml_Cylinder.hxx

0001 // Created on: 1996-12-25
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_Cylinder_HeaderFile
0018 #define _Vrml_Cylinder_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <Vrml_CylinderParts.hxx>
0025 #include <Standard_Real.hxx>
0026 #include <Standard_OStream.hxx>
0027
0028 //! defines a Cylinder node of VRML specifying geometry shapes.
0029 //! This  node  represents  a  simple  capped  cylinder  centred  around the  y-axis.
0030 //! By  default ,  the  cylinder  is  centred  at  (0,0,0)
0031 //! and  has  size  of  -1  to  +1  in  the  all  three  dimensions.
0032 //! The  cylinder  has  three  parts:
0033 //! the  sides,  the  top  (y=+1)  and  the  bottom (y=-1)
0034 class Vrml_Cylinder
0035 {
0036 public:
0037   DEFINE_STANDARD_ALLOC
0038
0039   Standard_EXPORT Vrml_Cylinder(const Vrml_CylinderParts aParts  = Vrml_CylinderALL,
0040                                 const Standard_Real      aRadius = 1,
0041                                 const Standard_Real      aHeight = 2);
0042
0043   Standard_EXPORT void SetParts(const Vrml_CylinderParts aParts);
0044
0045   Standard_EXPORT Vrml_CylinderParts Parts() const;
0046
0047   Standard_EXPORT void SetRadius(const Standard_Real aRadius);
0048
0049   Standard_EXPORT Standard_Real Radius() const;
0050
0051   Standard_EXPORT void SetHeight(const Standard_Real aHeight);
0052
0053   Standard_EXPORT Standard_Real Height() const;
0054
0055   Standard_EXPORT Standard_OStream& Print(Standard_OStream& anOStream) const;
0056
0057 protected:
0058 private:
0059   Vrml_CylinderParts myParts;
0060   Standard_Real      myRadius;
0061   Standard_Real      myHeight;
0062 };
0063
0064 #endif // _Vrml_Cylinder_HeaderFile