.. role:: ts-api-decorator

#########
Floorplan
#########

.. container:: ts-api-section

   .. js:module:: Floorplan




.. toctree::
   :titlesonly:
   :hidden:

   /api_ref/viewing/enum/Floorplan.FloorplanAutoActivation
   /api_ref/viewing/classes/Floorplan.FloorplanConfig
   /api_ref/viewing/classes/Floorplan.FloorplanManager

.. container:: api-index-section

   .. rubric:: Enumerations

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

   * :ref:`Floorplan.FloorplanAutoActivation`



.. container:: api-index-section

   .. rubric:: Classes

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

   * :js:class:`~Floorplan.FloorplanConfig`
   * :js:class:`~Floorplan.FloorplanManager`



.. container:: api-index-section

   .. rubric:: Functions

   .. rst-class:: api-index-list-item api-kind-function api-parent-kind-namespace

   * :js:func:`~Floorplan.clamp`
   * :js:func:`~Floorplan.isPointInBox`
   * :js:func:`~Floorplan.isPointInBoxOnlyZ`
   * :js:func:`~Floorplan.multiplyMatrices`





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

Functions
=========

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

clamp
-----

.. js:function:: clamp( value, min, max)

   :param value: None
   :type value: number
   :param min: None
   :type min: number
   :param max: None
   :type max: number


   Clamps a number to lie within the given min/max values


   :rtype: number

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

isPointInBox
------------

.. js:function:: isPointInBox( point, box)

   :param point: None
   :type point: Point3
   :param box: None
   :type box: Box


   TODO: Put this somewhere? Do we already have this somewhere?
   Determine if the point lies within the bounding box


   :rtype: boolean

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

isPointInBoxOnlyZ
-----------------

.. js:function:: isPointInBoxOnlyZ( point, box)

   :param point: None
   :type point: Point3
   :param box: None
   :type box: Box


   TODO: Put this somewhere?
   Determine if the point lies within the z-bounds of the box


   :rtype: boolean

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

multiplyMatrices
----------------

.. js:function:: multiplyMatrices( matrices)

   :param matrices: None
   :type matrices: [Matrix]


   Multiplies all given matrices in order.

   TODO: SCW: Ordering: Reevaluate after COM-679 is complete. Adjust ordering to match, or
     remove this function if new Matrix4 class supports >2 arguments.


   :rtype: Matrix

