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


#####################
IncrementalPickConfig
#####################

.. js:class:: IncrementalPickConfig

   
   Index
   =====
   
   .. rubric:: Constructors
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:func:`~IncrementalPickConfig.constructor`
   
   .. rubric:: Properties
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:data:`~IncrementalPickConfig.allowFaces`
   * :js:data:`~IncrementalPickConfig.allowLines`
   * :js:data:`~IncrementalPickConfig.allowPoints`
   * :js:data:`~IncrementalPickConfig.bimMask`
   * :js:data:`~IncrementalPickConfig.forceEffectiveSceneVisibilityMask`
   * :js:data:`~IncrementalPickConfig.forceEffectiveVisibilityMask`
   * :js:data:`~IncrementalPickConfig.ignoreCuttingSections`
   * :js:data:`~IncrementalPickConfig.ignoreUnrequestedInstances`
   * :js:data:`~IncrementalPickConfig.mustBeFullyContained`
   * :js:data:`~IncrementalPickConfig.onlyStreamedInstances`
   * :js:data:`~IncrementalPickConfig.respectVisibility`
   
   




Constructors
============

.. js:method:: IncrementalPickConfig.constructor

   .. rst-class:: sig-pretty-signature
   
      | IncrementalPickConfig(**selectionMask**\ : :js:data:`~SelectionMask`\ ?): :js:class:`~IncrementalPickConfig`
   
   **Parameters**
   
      **selectionMask**\ : :js:data:`~SelectionMask` = SelectionMask.All
   
   
   **Returns**\ : :js:class:`~IncrementalPickConfig`
   





Properties
==========

.. js:data:: IncrementalPickConfig.allowFaces

   .. rst-class:: sig-pretty-signature
   
      | allowFaces: *boolean*
   
   Configures whether or not faces are considered for selection.
   



.. js:data:: IncrementalPickConfig.allowLines

   .. rst-class:: sig-pretty-signature
   
      | allowLines: *boolean*
   
   Configures whether or not lines are considered for selection.
   



.. js:data:: IncrementalPickConfig.allowPoints

   .. rst-class:: sig-pretty-signature
   
      | allowPoints: *boolean*
   
   Configures whether or not points are considered for selection.
   



.. js:data:: IncrementalPickConfig.bimMask

   .. rst-class:: clio-flags
   
      :clio-optional:`optional`
   
   .. rst-class:: sig-pretty-signature
   
      | bimMask: :js:data:`BimMask <Sc.BimMask>`
   
   If set, selection will be restricted to geometry of the specified BIM types.
   



.. js:data:: IncrementalPickConfig.forceEffectiveSceneVisibilityMask

   .. rst-class:: sig-pretty-signature
   
      | forceEffectiveSceneVisibilityMask: :js:data:`~SelectionMask`
   
   For each element type bit in this mask, if the bit is on, then scene visibility is treated as if that element type is visible during selection.
   



.. js:data:: IncrementalPickConfig.forceEffectiveVisibilityMask

   .. rst-class:: sig-pretty-signature
   
      | forceEffectiveVisibilityMask: :js:data:`~SelectionMask`
   
   For each element type bit in this mask, if the bit is on, then scene visibility and geometry visibility are treated as if that element type is visible during selection.
   



.. js:data:: IncrementalPickConfig.ignoreCuttingSections

   .. rst-class:: sig-pretty-signature
   
      | ignoreCuttingSections: *boolean*
   
   Configures whether or not cutting sections are ignored during selection.
   



.. js:data:: IncrementalPickConfig.ignoreUnrequestedInstances

   .. rst-class:: sig-pretty-signature
   
      | ignoreUnrequestedInstances: *boolean*
   
   This config option only applies for [[StreamingMode.OnDemand]] viewer sessions. If true, then in nodes that are not requested will not be selected. If false, then non-requested nodes can be selected.
   



.. js:data:: IncrementalPickConfig.mustBeFullyContained

   .. rst-class:: sig-pretty-signature
   
      | mustBeFullyContained: *boolean*
   
   Configures whether or not items must be fully contained in the selection volume to be selection candidates.
   



.. js:data:: IncrementalPickConfig.onlyStreamedInstances

   .. rst-class:: sig-pretty-signature
   
      | onlyStreamedInstances: *boolean*
   
   If false, instances that have not yet been streamed will be processed. If true, instances that have not yet been streamed will be ignored.
   



.. js:data:: IncrementalPickConfig.respectVisibility

   .. rst-class:: sig-pretty-signature
   
      | respectVisibility: *boolean*
   
   Configures whether or not visibility is respected when performing a selection.
   





