.. role:: clio-inherited
   :class: clio-flag clio-flag-inherited


#################
CylinderGenerator
#################

.. js:class:: cee.utils.CylinderGenerator

   Helper class to tesselate a cylinder with closed caps.
   
   Useful when result values need to be mapped onto a set of 3D points defining a cylinder. See the method ``createCuttingSolid`` in the example in Examples/DemoAppUg on how to do that.
   
   
   Index
   =====
   
   .. rubric:: Constructors
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:func:`~cee.utils.CylinderGenerator.constructor`
   
   .. rubric:: Properties
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:data:`~cee.utils.CylinderGenerator.m_indices`
   * :js:data:`~cee.utils.CylinderGenerator.m_vertices`
   
   .. rubric:: Methods
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:meth:`~cee.utils.CylinderGenerator.configure`
   * :js:meth:`~cee.utils.CylinderGenerator.fillVerticesIndices`
   * :js:meth:`~cee.utils.CylinderGenerator.generate`
   * :js:meth:`~cee.utils.CylinderGenerator.getIndices`
   * :js:meth:`~cee.utils.CylinderGenerator.getVertices`
   * :js:meth:`~cee.utils.CylinderGenerator.getVerticesNumber`
   
   



.. rst-class:: kind-group kind-constructors

.. rubric:: Constructors
   :class: kind-group-title


.. js:method:: cee.utils.CylinderGenerator.constructor

      .. rst-class:: sig-pretty-signature
      
         | CylinderGenerator(): :js:class:`CylinderGenerator <cee.utils.CylinderGenerator>`
      
      **Returns**\ : :js:class:`CylinderGenerator <cee.utils.CylinderGenerator>`
      



.. rst-class:: kind-group kind-properties

.. rubric:: Properties
   :class: kind-group-title


.. js:data:: cee.utils.CylinderGenerator.m_indices

      .. rst-class:: clio-flags
      
         :clio-inherited:`inherited`
      
      .. rst-class:: sig-pretty-signature
      
         | m_indices: *number*\ []
      



.. js:data:: cee.utils.CylinderGenerator.m_vertices

      .. rst-class:: clio-flags
      
         :clio-inherited:`inherited`
      
      .. rst-class:: sig-pretty-signature
      
         | m_vertices: :js:class:`Vec3 <cee.Vec3>`\ []
      



.. rst-class:: kind-group kind-methods

.. rubric:: Methods
   :class: kind-group-title


.. js:method:: cee.utils.CylinderGenerator.configure

      .. rst-class:: sig-pretty-signature
      
         | configure(**config**\ : :js:class:`CylinderGeneratorConfig <cee.utils.CylinderGeneratorConfig>`\ ): *void*
      
      Sets up the cylinder parameters.
      
      **Parameters**
      
      
         **config**\ : :js:class:`CylinderGeneratorConfig <cee.utils.CylinderGeneratorConfig>`
      
      
      **Returns**\ : *void*
      



.. js:method:: cee.utils.CylinderGenerator.fillVerticesIndices

      .. rst-class:: clio-flags
      
         :clio-inherited:`inherited`
      
      .. rst-class:: sig-pretty-signature
      
         | fillVerticesIndices(**vertices**\ : *Float32Array*\ , **indices**\ : *number*\ []): *void*
      
      Fills the members ``m_vertices`` and ``m_indices`` of this class.
      
      **Parameters**
      
      
         **vertices**\ : *Float32Array*
      
      
            The vertices in the format x,y,z,x,y,z,...
      
      
         **indices**\ : *number*\ []
      
      
            The indices for the vertices
      
      
      
      **Returns**\ : *void*
      



.. js:method:: cee.utils.CylinderGenerator.generate

      .. rst-class:: sig-pretty-signature
      
         | generate(): *void*
      
      Generates the cylinder, using the previously provided configuration.
      
      **Returns**\ : *void*
      



.. js:method:: cee.utils.CylinderGenerator.getIndices

      .. rst-class:: clio-flags
      
         :clio-inherited:`inherited`
      
      .. rst-class:: sig-pretty-signature
      
         | getIndices(): *number*\ []
      
      Get the indices of triangles needed to render the solid object
      
      **Returns**\ : *number*\ []
      



.. js:method:: cee.utils.CylinderGenerator.getVertices

      .. rst-class:: clio-flags
      
         :clio-inherited:`inherited`
      
      .. rst-class:: sig-pretty-signature
      
         | getVertices(): :js:class:`Vec3 <cee.Vec3>`\ []
      
      Get the vertices of the solid object as Vec3
      
      **Returns**\ : :js:class:`Vec3 <cee.Vec3>`\ []
      



.. js:method:: cee.utils.CylinderGenerator.getVerticesNumber

      .. rst-class:: clio-flags
      
         :clio-inherited:`inherited`
      
      .. rst-class:: sig-pretty-signature
      
         | getVerticesNumber(): *number*\ []
      
      Get the vertices of the solid object as a number array with <x,y,z,x,y,z,...>
      
      **Returns**\ : *number*\ []
      




