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


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

.. js:class:: wv.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:`~wv.GroundPlane.normal`
   * :js:data:`~wv.GroundPlane.followViewAxes`
   * :js:data:`~wv.GroundPlane.position`
   
   



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

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


.. js:data:: wv.GroundPlane.normal

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



.. js:data:: wv.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:: wv.GroundPlane.position

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




