# Floorplan

Enumerations

- FloorplanAutoActivation

Classes

- `FloorplanConfig()`

- `FloorplanManager()`

Functions

- `clamp()`

- `isPointInBox()`

- `isPointInBoxOnlyZ()`

- `multiplyMatrices()`

## Functions

### clamp

Floorplan.clamp(value, min, max)
  Arguments

    - value (`number()`) – None

    - min (`number()`) – None

    - max (`number()`) – None

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

  Return type

    number

### isPointInBox

Floorplan.isPointInBox(point, box)
  Arguments

    - point (`Point3()`) – None

    - box (`Box()`) – None

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

  Return type

    boolean

### isPointInBoxOnlyZ

Floorplan.isPointInBoxOnlyZ(point, box)
  Arguments

    - point (`Point3()`) – None

    - box (`Box()`) – None

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

  Return type

    boolean

### multiplyMatrices

Floorplan.multiplyMatrices(matrices)
  Arguments

    - matrices (`[Matrix]()`) – None

  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.

  Return type

    Matrix