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


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

.. js:class:: wv.Sc.RaySelectionConfig

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



.. rst-class:: kind-group kind-properties

.. rubric:: Properties
   :class: kind-group-title


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

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



.. js:data:: wv.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:: wv.Sc.RaySelectionConfig.enableOcclusionChecks

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



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

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



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

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



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

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



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

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



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

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



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

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



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

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



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

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



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

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



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

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



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

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



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

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



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

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



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

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




