.. role:: ts-api-decorator

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

.. js:module:: Sc
   :noindex:

.. container:: ts-api-section

   .. js:class:: RaySelectionConfig



.. container:: api-index-section

   .. rubric:: Properties

   .. rst-class:: api-index-list-item api-kind-property api-parent-kind-interface

   * :js:attr:`~Sc.RaySelectionConfig.bimMask`
   * :js:attr:`~Sc.RaySelectionConfig.cullSuboptimalEntities`
   * :js:attr:`~Sc.RaySelectionConfig.enableOcclusionChecks`
   * :js:attr:`~Sc.RaySelectionConfig.enableProximityFaces`
   * :js:attr:`~Sc.RaySelectionConfig.ignoreCappingGeometry`
   * :js:attr:`~Sc.RaySelectionConfig.ignoreOverlays`
   * :js:attr:`~Sc.RaySelectionConfig.maxWorldDistance`
   * :js:attr:`~Sc.RaySelectionConfig.oneEntityPerTypePerInstance`
   * :js:attr:`~Sc.RaySelectionConfig.rejectionBitsAll`
   * :js:attr:`~Sc.RaySelectionConfig.rejectionBitsAny`
   * :js:attr:`~Sc.RaySelectionConfig.requiredBitsAll`
   * :js:attr:`~Sc.RaySelectionConfig.requiredBitsAny`
   * :js:attr:`~Sc.RaySelectionConfig.respectDepthRange`
   * :js:attr:`~Sc.RaySelectionConfig.respectVisibility`
   * :js:attr:`~Sc.RaySelectionConfig.restrictLinesAndPointsToSelectedFaceInstances`
   * :js:attr:`~Sc.RaySelectionConfig.restrictToOverlays`
   * :js:attr:`~Sc.RaySelectionConfig.returnElementBounding`





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

Properties
==========

.. container:: ts-api-section

   .. js:attribute:: RaySelectionConfig.bimMask

      :type: BimMask :ts-api-decorator:`optional`





.. container:: ts-api-section

   .. js:attribute:: RaySelectionConfig.cullSuboptimalEntities

      :type: boolean :ts-api-decorator:`optional`

      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.



.. container:: ts-api-section

   .. js:attribute:: RaySelectionConfig.enableOcclusionChecks

      :type: boolean :ts-api-decorator:`optional`





.. container:: ts-api-section

   .. js:attribute:: RaySelectionConfig.enableProximityFaces

      :type: boolean :ts-api-decorator:`optional`





.. container:: ts-api-section

   .. js:attribute:: RaySelectionConfig.ignoreCappingGeometry

      :type: boolean :ts-api-decorator:`optional`





.. container:: ts-api-section

   .. js:attribute:: RaySelectionConfig.ignoreOverlays

      :type: boolean :ts-api-decorator:`optional`





.. container:: ts-api-section

   .. js:attribute:: RaySelectionConfig.maxWorldDistance

      :type: number :ts-api-decorator:`optional`





.. container:: ts-api-section

   .. js:attribute:: RaySelectionConfig.oneEntityPerTypePerInstance

      :type: boolean :ts-api-decorator:`optional`





.. container:: ts-api-section

   .. js:attribute:: RaySelectionConfig.rejectionBitsAll

      :type: number :ts-api-decorator:`optional`





.. container:: ts-api-section

   .. js:attribute:: RaySelectionConfig.rejectionBitsAny

      :type: number :ts-api-decorator:`optional`





.. container:: ts-api-section

   .. js:attribute:: RaySelectionConfig.requiredBitsAll

      :type: number :ts-api-decorator:`optional`





.. container:: ts-api-section

   .. js:attribute:: RaySelectionConfig.requiredBitsAny

      :type: number :ts-api-decorator:`optional`





.. container:: ts-api-section

   .. js:attribute:: RaySelectionConfig.respectDepthRange

      :type: boolean :ts-api-decorator:`optional`





.. container:: ts-api-section

   .. js:attribute:: RaySelectionConfig.respectVisibility

      :type: boolean :ts-api-decorator:`optional`





.. container:: ts-api-section

   .. js:attribute:: RaySelectionConfig.restrictLinesAndPointsToSelectedFaceInstances

      :type: boolean :ts-api-decorator:`optional`





.. container:: ts-api-section

   .. js:attribute:: RaySelectionConfig.restrictToOverlays

      :type: boolean :ts-api-decorator:`optional`





.. container:: ts-api-section

   .. js:attribute:: RaySelectionConfig.returnElementBounding

      :type: boolean :ts-api-decorator:`optional`





