.. role:: ts-api-decorator

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

.. container:: ts-api-section

   .. js:class:: IncrementalPickConfig



.. container:: api-index-section

   .. rubric:: Constructors

   .. rst-class:: api-index-list-item api-kind-constructor api-parent-kind-class

   * :js:meth:`~IncrementalPickConfig.constructor`



.. container:: api-index-section

   .. rubric:: Properties

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

   * :js:attr:`~IncrementalPickConfig.allowFaces`
   * :js:attr:`~IncrementalPickConfig.allowLines`
   * :js:attr:`~IncrementalPickConfig.allowPoints`
   * :js:attr:`~IncrementalPickConfig.bimMask`
   * :js:attr:`~IncrementalPickConfig.forceEffectiveSceneVisibilityMask`
   * :js:attr:`~IncrementalPickConfig.forceEffectiveVisibilityMask`
   * :js:attr:`~IncrementalPickConfig.ignoreCuttingSections`
   * :js:attr:`~IncrementalPickConfig.ignoreUnrequestedInstances`
   * :js:attr:`~IncrementalPickConfig.mustBeFullyContained`
   * :js:attr:`~IncrementalPickConfig.onlyStreamedInstances`
   * :js:attr:`~IncrementalPickConfig.respectVisibility`





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

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

.. container:: ts-api-section

   .. js:function:: IncrementalPickConfig.constructor( selectionMask)

      :param selectionMask: None
      :type selectionMask: SelectionMask


      :rtype: IncrementalPickConfig



Properties
==========

.. container:: ts-api-section

   .. js:attribute:: IncrementalPickConfig.allowFaces

      :type: boolean

      Configures whether or not faces are considered for selection.



.. container:: ts-api-section

   .. js:attribute:: IncrementalPickConfig.allowLines

      :type: boolean

      Configures whether or not lines are considered for selection.



.. container:: ts-api-section

   .. js:attribute:: IncrementalPickConfig.allowPoints

      :type: boolean

      Configures whether or not points are considered for selection.



.. container:: ts-api-section

   .. js:attribute:: IncrementalPickConfig.bimMask

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

      If set, selection will be restricted to geometry of the specified BIM types.



.. container:: ts-api-section

   .. js:attribute:: IncrementalPickConfig.forceEffectiveSceneVisibilityMask

      :type: 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.



.. container:: ts-api-section

   .. js:attribute:: IncrementalPickConfig.forceEffectiveVisibilityMask

      :type: 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.



.. container:: ts-api-section

   .. js:attribute:: IncrementalPickConfig.ignoreCuttingSections

      :type: boolean

      Configures whether or not cutting sections are ignored during selection.



.. container:: ts-api-section

   .. js:attribute:: IncrementalPickConfig.ignoreUnrequestedInstances

      :type: 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.



.. container:: ts-api-section

   .. js:attribute:: IncrementalPickConfig.mustBeFullyContained

      :type: boolean

      Configures whether or not items must be fully contained in the selection volume to be selection candidates.



.. container:: ts-api-section

   .. js:attribute:: IncrementalPickConfig.onlyStreamedInstances

      :type: 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.



.. container:: ts-api-section

   .. js:attribute:: IncrementalPickConfig.respectVisibility

      :type: boolean

      Configures whether or not visibility is respected when performing a selection.



