
#################
LoadSubtreeConfig
#################

.. js:class:: LoadSubtreeConfig

   Configuration for all ``loadSubtree`` functions in the [[Model]] class.
   
   
   Index
   =====
   
   .. rubric:: Constructors
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:func:`~LoadSubtreeConfig.constructor`
   
   .. rubric:: Properties
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:data:`~LoadSubtreeConfig.additionalMatrix`
   * :js:data:`~LoadSubtreeConfig.allowMissingExternalModels`
   * :js:data:`~LoadSubtreeConfig.attachInvisibly`
   * :js:data:`~LoadSubtreeConfig.ignoreBimRelationships`
   * :js:data:`~LoadSubtreeConfig.ignoreCadViews`
   * :js:data:`~LoadSubtreeConfig.ignoreFilters`
   * :js:data:`~LoadSubtreeConfig.ignoreGenericTypes`
   * :js:data:`~LoadSubtreeConfig.ignoreLayers`
   * :js:data:`~LoadSubtreeConfig.implicitlyLoadXmlExternalModels`
   
   .. rubric:: Methods
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:meth:`~LoadSubtreeConfig.copy`
   
   




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

.. js:method:: LoadSubtreeConfig.constructor

   .. rst-class:: sig-pretty-signature
   
      | LoadSubtreeConfig(): :js:class:`~LoadSubtreeConfig`
   
   **Returns**\ : :js:class:`~LoadSubtreeConfig`
   





Properties
==========

.. js:data:: LoadSubtreeConfig.additionalMatrix

   .. rst-class:: sig-pretty-signature
   
      | additionalMatrix: (*None* \| :js:class:`~Matrix`\ )
   
   Optional matrix to get multiplied into the net attachment matrix.
   



.. js:data:: LoadSubtreeConfig.allowMissingExternalModels

   .. rst-class:: sig-pretty-signature
   
      | allowMissingExternalModels: *boolean*
   
   Controls whether or not missing models are ignored or cause an error.
   



.. js:data:: LoadSubtreeConfig.attachInvisibly

   .. rst-class:: sig-pretty-signature
   
      | attachInvisibly: *boolean*
   
   If true, then models are attached with all geometry turned invisible. If exist, default CAD configuration and CAD view will not be activated.
   



.. js:data:: LoadSubtreeConfig.ignoreBimRelationships

   .. rst-class:: sig-pretty-signature
   
      | ignoreBimRelationships: *boolean*
   
   If true BIM relationships will not be loaded. This can reduce memory consumption
   



.. js:data:: LoadSubtreeConfig.ignoreCadViews

   .. rst-class:: sig-pretty-signature
   
      | ignoreCadViews: *boolean*
   
   If true CAD views will not be loaded. This can reduce memory consumption
   



.. js:data:: LoadSubtreeConfig.ignoreFilters

   .. rst-class:: sig-pretty-signature
   
      | ignoreFilters: *boolean*
   
   If true filters will not be loaded. This can reduce memory consumption
   



.. js:data:: LoadSubtreeConfig.ignoreGenericTypes

   .. rst-class:: sig-pretty-signature
   
      | ignoreGenericTypes: *boolean*
   
   If true generic types (IFC types) will not be loaded. This can reduce memory consumption
   



.. js:data:: LoadSubtreeConfig.ignoreLayers

   .. rst-class:: sig-pretty-signature
   
      | ignoreLayers: *boolean*
   
   If true layers will not be loaded. This can reduce memory consumption
   



.. js:data:: LoadSubtreeConfig.implicitlyLoadXmlExternalModels

   .. rst-class:: sig-pretty-signature
   
      | implicitlyLoadXmlExternalModels: *boolean*
   
   If true, then external models found in XML files will be implicitly loaded. Otherwise [[Model.requestNodes]] must be called to load the external models.
   





Methods
=======

.. js:method:: LoadSubtreeConfig.copy

   .. rst-class:: sig-pretty-signature
   
      | copy(): :js:class:`~LoadSubtreeConfig`
   
   **Returns**\ : :js:class:`~LoadSubtreeConfig`
   





