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


##################
RaySelectionConfig
##################

.. js:class:: Sc.RaySelectionConfig

   
   Index
   =====
   
   .. rubric:: Properties
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:data:`~Sc.RaySelectionConfig.bimMask`
   * :js:data:`~Sc.RaySelectionConfig.cullSuboptimalEntities`
   * :js:data:`~Sc.RaySelectionConfig.enableOcclusionChecks`
   * :js:data:`~Sc.RaySelectionConfig.enableProximityFaces`
   * :js:data:`~Sc.RaySelectionConfig.ignoreCappingGeometry`
   * :js:data:`~Sc.RaySelectionConfig.ignoreOverlays`
   * :js:data:`~Sc.RaySelectionConfig.maxWorldDistance`
   * :js:data:`~Sc.RaySelectionConfig.oneEntityPerTypePerInstance`
   * :js:data:`~Sc.RaySelectionConfig.rejectionBitsAll`
   * :js:data:`~Sc.RaySelectionConfig.rejectionBitsAny`
   * :js:data:`~Sc.RaySelectionConfig.requiredBitsAll`
   * :js:data:`~Sc.RaySelectionConfig.requiredBitsAny`
   * :js:data:`~Sc.RaySelectionConfig.respectDepthRange`
   * :js:data:`~Sc.RaySelectionConfig.respectVisibility`
   * :js:data:`~Sc.RaySelectionConfig.restrictLinesAndPointsToSelectedFaceInstances`
   * :js:data:`~Sc.RaySelectionConfig.restrictToOverlays`
   * :js:data:`~Sc.RaySelectionConfig.returnElementBounding`
   
   




Properties
==========

.. js:data:: Sc.RaySelectionConfig.bimMask

   .. rst-class:: clio-flags
   
      :clio-optional:`optional`
   
   .. rst-class:: sig-pretty-signature
   
      | bimMask: :js:data:`BimMask <Sc.BimMask>`
   



.. js:data:: Sc.RaySelectionConfig.cullSuboptimalEntities

   .. rst-class:: clio-flags
   
      :clio-optional:`optional`
   
   .. rst-class:: sig-pretty-signature
   
      | cullSuboptimalEntities: *boolean*
   
   If true, selection will try to return only the most relevant entities.
   
   A face is considered suboptimal if any of the following hold:
   
   
   - The face is behind another selected face.
   - The face is selected by proximity and another face is selected at closer proximity.
   
   A line is considered suboptimal if:
   
   
   - The line is selected by proximity and another line is selected at closer proximity.
   
   A point is considered suboptimal if:
   
   
   - The point is selected by proximity and another point is selected at closer proximity.
   



.. js:data:: Sc.RaySelectionConfig.enableOcclusionChecks

   .. rst-class:: clio-flags
   
      :clio-optional:`optional`
   
   .. rst-class:: sig-pretty-signature
   
      | enableOcclusionChecks: *boolean*
   



.. js:data:: Sc.RaySelectionConfig.enableProximityFaces

   .. rst-class:: clio-flags
   
      :clio-optional:`optional`
   
   .. rst-class:: sig-pretty-signature
   
      | enableProximityFaces: *boolean*
   



.. js:data:: Sc.RaySelectionConfig.ignoreCappingGeometry

   .. rst-class:: clio-flags
   
      :clio-optional:`optional`
   
   .. rst-class:: sig-pretty-signature
   
      | ignoreCappingGeometry: *boolean*
   



.. js:data:: Sc.RaySelectionConfig.ignoreOverlays

   .. rst-class:: clio-flags
   
      :clio-optional:`optional`
   
   .. rst-class:: sig-pretty-signature
   
      | ignoreOverlays: *boolean*
   



.. js:data:: Sc.RaySelectionConfig.maxWorldDistance

   .. rst-class:: clio-flags
   
      :clio-optional:`optional`
   
   .. rst-class:: sig-pretty-signature
   
      | maxWorldDistance: *number*
   



.. js:data:: Sc.RaySelectionConfig.oneEntityPerTypePerInstance

   .. rst-class:: clio-flags
   
      :clio-optional:`optional`
   
   .. rst-class:: sig-pretty-signature
   
      | oneEntityPerTypePerInstance: *boolean*
   



.. js:data:: Sc.RaySelectionConfig.rejectionBitsAll

   .. rst-class:: clio-flags
   
      :clio-optional:`optional`
   
   .. rst-class:: sig-pretty-signature
   
      | rejectionBitsAll: *number*
   



.. js:data:: Sc.RaySelectionConfig.rejectionBitsAny

   .. rst-class:: clio-flags
   
      :clio-optional:`optional`
   
   .. rst-class:: sig-pretty-signature
   
      | rejectionBitsAny: *number*
   



.. js:data:: Sc.RaySelectionConfig.requiredBitsAll

   .. rst-class:: clio-flags
   
      :clio-optional:`optional`
   
   .. rst-class:: sig-pretty-signature
   
      | requiredBitsAll: *number*
   



.. js:data:: Sc.RaySelectionConfig.requiredBitsAny

   .. rst-class:: clio-flags
   
      :clio-optional:`optional`
   
   .. rst-class:: sig-pretty-signature
   
      | requiredBitsAny: *number*
   



.. js:data:: Sc.RaySelectionConfig.respectDepthRange

   .. rst-class:: clio-flags
   
      :clio-optional:`optional`
   
   .. rst-class:: sig-pretty-signature
   
      | respectDepthRange: *boolean*
   



.. js:data:: Sc.RaySelectionConfig.respectVisibility

   .. rst-class:: clio-flags
   
      :clio-optional:`optional`
   
   .. rst-class:: sig-pretty-signature
   
      | respectVisibility: *boolean*
   



.. js:data:: Sc.RaySelectionConfig.restrictLinesAndPointsToSelectedFaceInstances

   .. rst-class:: clio-flags
   
      :clio-optional:`optional`
   
   .. rst-class:: sig-pretty-signature
   
      | restrictLinesAndPointsToSelectedFaceInstances: *boolean*
   



.. js:data:: Sc.RaySelectionConfig.restrictToOverlays

   .. rst-class:: clio-flags
   
      :clio-optional:`optional`
   
   .. rst-class:: sig-pretty-signature
   
      | restrictToOverlays: *boolean*
   



.. js:data:: Sc.RaySelectionConfig.returnElementBounding

   .. rst-class:: clio-flags
   
      :clio-optional:`optional`
   
   .. rst-class:: sig-pretty-signature
   
      | returnElementBounding: *boolean*
   





