0031773: Visualization - add Prs3d_ToolTorus

[occt.git] / src / Prs3d / Prs3d_ToolCylinder.hxx

// Created on: 2016-02-04
// Created by: Anastasia BORISOVA
// Copyright (c) 2016 OPEN CASCADE SAS
//
// This file is part of Open CASCADE Technology software library.
//
// This library is free software; you can redistribute it and/or modify it under
// the terms of the GNU Lesser General Public License version 2.1 as published
// by the Free Software Foundation, with special exception defined in the file
// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
// distribution for complete text of the license and disclaimer of any warranty.
//
// Alternatively, this file may be used under the terms of Open CASCADE
// commercial license or contractual agreement.

#ifndef _Prs3d_ToolCylinder_HeaderFile
#define _Prs3d_ToolCylinder_HeaderFile

#include <Prs3d_ToolQuadric.hxx>

//! Standard presentation algorithm that outputs graphical primitives for cylindrical surface.
class Prs3d_ToolCylinder : public Prs3d_ToolQuadric
{
public:

  //! Generate primitives for 3D quadric surface and return a filled array.
  //! @param theBottomRad [in] cylinder bottom radius
  //! @param theTopRad    [in] cylinder top radius
  //! @param theHeight    [in] cylinder height
  //! @param theNbSlices  [in] number of slices within U parameter
  //! @param theNbStacks  [in] number of stacks within V parameter
  //! @param theTrsf      [in] optional transformation to apply
  //! @return generated triangulation
  Standard_EXPORT static Handle(Graphic3d_ArrayOfTriangles) Create (const Standard_Real    theBottomRad,
                                                                    const Standard_Real    theTopRad,
                                                                    const Standard_Real    theHeight,
                                                                    const Standard_Integer theNbSlices,
                                                                    const Standard_Integer theNbStacks,
                                                                    const gp_Trsf&         theTrsf);
public:

  //! Initializes the algorithm creating a cylinder.
  //! @param theBottomRad [in] cylinder bottom radius
  //! @param theTopRad    [in] cylinder top radius
  //! @param theHeight    [in] cylinder height
  //! @param theNbSlices  [in] number of slices within U parameter
  //! @param theNbStacks  [in] number of stacks within V parameter
  Standard_EXPORT Prs3d_ToolCylinder (const Standard_Real    theBottomRad,
                                      const Standard_Real    theTopRad,
                                      const Standard_Real    theHeight,
                                      const Standard_Integer theNbSlices,
                                      const Standard_Integer theNbStacks);

protected:

  //! Computes vertex at given parameter location of the surface.
  Standard_EXPORT virtual gp_Pnt Vertex (const Standard_Real theU, const Standard_Real theV) const Standard_OVERRIDE;

  //! Computes normal at given parameter location of the surface.
  Standard_EXPORT virtual gp_Dir Normal (const Standard_Real theU, const Standard_Real theV) const Standard_OVERRIDE;

protected:

  Standard_Real myBottomRadius; //!< cylinder bottom radius
  Standard_Real myTopRadius;    //!< cylinder top radius
  Standard_Real myHeight;       //!< cylinder height

};

#endif // _Prs3d_ToolCylinder_HeaderFile