
###########
FloorConfig
###########

.. js:class:: Bim.FloorConfig

   Distance configuration used when BIM mode is enabled. See also: [[CameraWalkBaseOperator.enableBimMode]].
   
   
   Index
   =====
   
   .. rubric:: Properties
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:data:`~Bim.FloorConfig.avatarOffset`
   * :js:data:`~Bim.FloorConfig.maxClimbHeight`
   * :js:data:`~Bim.FloorConfig.maxFallDistance`
   * :js:data:`~Bim.FloorConfig.negligibleClimbHeight`
   
   




Properties
==========

.. js:data:: Bim.FloorConfig.avatarOffset

   .. rst-class:: sig-pretty-signature
   
      | avatarOffset: *number*
   
   The offset from the floor used for the avatar.
   



.. js:data:: Bim.FloorConfig.maxClimbHeight

   .. rst-class:: sig-pretty-signature
   
      | maxClimbHeight: *number*
   
   The maximum gain in height the avatar is allowed to scale.
   



.. js:data:: Bim.FloorConfig.maxFallDistance

   .. rst-class:: sig-pretty-signature
   
      | maxFallDistance: *number*
   
   The maximum distance the avatar can fall.
   



.. js:data:: Bim.FloorConfig.negligibleClimbHeight

   .. rst-class:: sig-pretty-signature
   
      | negligibleClimbHeight: *number*
   
   Any gain in height less than this distance does not cause the avatar to buoy upward.
   





