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
0029 //! defines a Cylinder node of VRML specifying geometry shapes.
0030 //! This  node  represents  a  simple  capped  cylinder  centred  around the  y-axis.
0031 //! By  default ,  the  cylinder  is  centred  at  (0,0,0)
0032 //! and  has  size  of  -1  to  +1  in  the  all  three  dimensions.
0033 //! The  cylinder  has  three  parts:
0034 //! the  sides,  the  top  (y=+1)  and  the  bottom (y=-1)
0035 class Vrml_Cylinder
0036 {
0037 public:
0038
0039   DEFINE_STANDARD_ALLOC
0040
0041
0042   Standard_EXPORT Vrml_Cylinder(const Vrml_CylinderParts aParts = Vrml_CylinderALL, const Standard_Real aRadius = 1, const Standard_Real aHeight = 2);
0043
0044   Standard_EXPORT void SetParts (const Vrml_CylinderParts aParts);
0045
0046   Standard_EXPORT Vrml_CylinderParts Parts() const;
0047
0048   Standard_EXPORT void SetRadius (const Standard_Real aRadius);
0049
0050   Standard_EXPORT Standard_Real Radius() const;
0051
0052   Standard_EXPORT void SetHeight (const Standard_Real aHeight);
0053
0054   Standard_EXPORT Standard_Real Height() const;
0055
0056   Standard_EXPORT Standard_OStream& Print (Standard_OStream& anOStream) const;
0057
0058
0059
0060
0061 protected:
0062
0063
0064
0065
0066
0067 private:
0068
0069
0070
0071   Vrml_CylinderParts myParts;
0072   Standard_Real myRadius;
0073   Standard_Real myHeight;
0074
0075
0076 };
0077
0078
0079
0080
0081
0082
0083
0084 #endif // _Vrml_Cylinder_HeaderFile