.. role:: ts-api-decorator

##############
ArrowGenerator
##############

.. js:module:: cee.utils
   :noindex:

.. container:: ts-api-section

   .. js:class:: ArrowGenerator

      Helper class to tesselate an arrow



.. container:: api-index-section

   .. rubric:: Constructors

   .. rst-class:: api-index-list-item api-kind-constructor api-parent-kind-class

   * :js:meth:`~cee.utils.ArrowGenerator.constructor`



.. container:: api-index-section

   .. rubric:: Properties

   .. rst-class:: api-index-list-item api-kind-property api-parent-kind-class

   * :js:attr:`~cee.utils.ArrowGenerator.m_indices`
   * :js:attr:`~cee.utils.ArrowGenerator.m_vertices`



.. container:: api-index-section

   .. rubric:: Methods

   .. rst-class:: api-index-list-item api-kind-method api-parent-kind-class

   * :js:meth:`~cee.utils.ArrowGenerator.configure`
   * :js:meth:`~cee.utils.ArrowGenerator.fillVerticesIndices`
   * :js:meth:`~cee.utils.ArrowGenerator.generate`
   * :js:meth:`~cee.utils.ArrowGenerator.generateReverse`
   * :js:meth:`~cee.utils.ArrowGenerator.getIndices`
   * :js:meth:`~cee.utils.ArrowGenerator.getVertices`
   * :js:meth:`~cee.utils.ArrowGenerator.getVerticesNumber`





------------

Constructors
============

.. container:: ts-api-section

   .. js:function:: ArrowGenerator.constructor()



      :rtype: ArrowGenerator



Properties
==========

.. container:: ts-api-section

   .. js:attribute:: ArrowGenerator.m_indices

      :type: [number]





.. container:: ts-api-section

   .. js:attribute:: ArrowGenerator.m_vertices

      :type: [Vec3]





Methods
=======

.. rst-class:: ts-api-section

configure
---------

.. js:method:: ArrowGenerator.configure( config)

   :param config: None
   :type config: ArrowGeneratorConfig


   Specify the arrow by providing its relative proportions.


   :rtype: void

.. rst-class:: ts-api-section

fillVerticesIndices
-------------------

.. js:method:: ArrowGenerator.fillVerticesIndices( vertices, indices)

   :param vertices: The vertices in the format x,y,z,x,y,z,...
   :type vertices: Float32Array
   :param indices: The indices for the vertices
   :type indices: [number]


   Fills the members ``m_vertices`` and ``m_indices`` of this class.


   :rtype: void

.. rst-class:: ts-api-section

generate
--------

.. js:method:: ArrowGenerator.generate()



   Generate the arrow


   :rtype: void

.. rst-class:: ts-api-section

generateReverse
---------------

.. js:method:: ArrowGenerator.generateReverse()



   Generate the reverse arrow, with the arrow head pointing into the origin.


   :rtype: void

.. rst-class:: ts-api-section

getIndices
----------

.. js:method:: ArrowGenerator.getIndices()



   Get the indices of triangles needed to render the solid object


   :rtype: [number]

.. rst-class:: ts-api-section

getVertices
-----------

.. js:method:: ArrowGenerator.getVertices()



   Get the vertices of the solid object as Vec3


   :rtype: [Vec3]

.. rst-class:: ts-api-section

getVerticesNumber
-----------------

.. js:method:: ArrowGenerator.getVerticesNumber()



   Get the vertices of the solid object as a number array with <x,y,z,x,y,z,...>


   :rtype: [number]

