.. role:: ts-api-decorator

.. _LinePatternLengthUnit:

#####################
LinePatternLengthUnit
#####################

.. container:: ts-api-section

   Specifies the units in which the length of a [[LinePattern]] is measured.



.. container:: api-index-section

   .. rubric:: Enumeration Members

   .. rst-class:: api-index-list-item api-kind-enummember api-parent-kind-enum

   * :ref:`LinePatternLengthUnit.Object`
   * :ref:`LinePatternLengthUnit.ProportionOfScreenHeight`
   * :ref:`LinePatternLengthUnit.ProportionOfScreenWidth`
   * :ref:`LinePatternLengthUnit.World`





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

Enumeration Members
===================

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

.. _LinePatternLengthUnit.Object:

Object
------

Object space units before applying modelling matrices.

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

.. _LinePatternLengthUnit.ProportionOfScreenHeight:

ProportionOfScreenHeight
------------------------

A proportion of the height of the canvas, where ``1`` means the full height.

When this unit is used, the line pattern will appear the same regardless
of zoom or distance from the camera. However, this requires extra
calculation for each vertex in the line, which makes it less
performant than other units.

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

.. _LinePatternLengthUnit.ProportionOfScreenWidth:

ProportionOfScreenWidth
-----------------------

A proportion of the width of the canvas, where ``1`` means the full width.

When this unit is used, the line pattern will appear the same regardless
of zoom or distance from the camera. However, this requires extra
calculation for each vertex in the line, which makes it less
performant than other units.

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

.. _LinePatternLengthUnit.World:

World
-----

Object space units after applying modelling matrices.

