.. role:: clio-optional
   :class: clio-flag clio-flag-optional


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

.. js:class:: GroundPlane

   Defines the invisible ground plane onto which simple shadows are projected.
   
   See [[View.setGroundPlane]].
   
   
   Index
   =====
   
   .. rubric:: Properties
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:data:`~GroundPlane.followViewAxes`
   * :js:data:`~GroundPlane.normal`
   * :js:data:`~GroundPlane.position`
   
   




Properties
==========

.. js:data:: GroundPlane.followViewAxes

   .. rst-class:: clio-flags
   
      :clio-optional:`optional`
   
   .. rst-class:: sig-pretty-signature
   
      | followViewAxes: *boolean*
   
   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.
   



.. js:data:: GroundPlane.normal

   .. rst-class:: sig-pretty-signature
   
      | normal: :js:class:`~Point3`
   
   The normal of the plane.
   



.. js:data:: GroundPlane.position

   .. rst-class:: clio-flags
   
      :clio-optional:`optional`
   
   .. rst-class:: sig-pretty-signature
   
      | position: :js:class:`~Point3`
   
   Any point on the plane. If ``undefined``\ , the plane will be positioned at the furthest extent of the model's bounding box.
   





