.. role:: ts-api-decorator

###########
GroundPlane
###########

.. container:: ts-api-section

   .. js:class:: GroundPlane

      Defines the invisible ground plane onto which simple shadows
      are projected.

      See [[View.setGroundPlane]].



.. container:: api-index-section

   .. rubric:: Properties

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

   * :js:attr:`~GroundPlane.followViewAxes`
   * :js:attr:`~GroundPlane.normal`
   * :js:attr:`~GroundPlane.position`





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

Properties
==========

.. container:: ts-api-section

   .. js:attribute:: GroundPlane.followViewAxes

      :type: boolean :ts-api-decorator:`optional`

      If ``true``, the model's view axes will affect how the normal is
      interpreted. A normal of ``[0,0,1]`` will be aligned with the model's
      up-vector.



.. container:: ts-api-section

   .. js:attribute:: GroundPlane.normal

      :type: Point3

      The normal of the plane.



.. container:: ts-api-section

   .. js:attribute:: GroundPlane.position

      :type: Point3 :ts-api-decorator:`optional`

      Any point on the plane. If ``undefined``, the plane will be positioned
      at the furthest extent of the model's bounding box.



