.. role:: clio-readonly
   :class: clio-flag clio-flag-readonly


#####
Model
#####

.. js:class:: cee.Model

   Common interface for all models.
   
   
   Index
   =====
   
   .. rubric:: Constructors
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:func:`~cee.Model.constructor`
   
   .. rubric:: Properties
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:data:`~cee.Model.name`
   
   .. rubric:: Methods
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:meth:`~cee.Model.getBoundingBox`
   * :js:meth:`~cee.Model.getDefaultCameraConfig`
   
   



.. rst-class:: kind-group kind-constructors

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


.. js:method:: cee.Model.constructor

      .. rst-class:: sig-pretty-signature
      
         | Model(): :js:class:`Model <cee.Model>`
      
      **Returns**\ : :js:class:`Model <cee.Model>`
      



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

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


.. js:data:: cee.Model.name

      .. rst-class:: clio-flags
      
         :clio-readonly:`readonly`
      
      .. rst-class:: sig-pretty-signature
      
         | name: *string*
      
      Name of the model.
      
      Mainly used for debugging.
      



.. rst-class:: kind-group kind-methods

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


.. js:method:: cee.Model.getBoundingBox

      .. rst-class:: sig-pretty-signature
      
         | getBoundingBox(**options**\ : :js:class:`ModelBoundingBoxOptions <cee.ModelBoundingBoxOptions>`\ ): :js:class:`BoundingBox <cee.BoundingBox>`
      
      Returns the current :js:class:`BoundingBox <cee.BoundingBox>` (in world coordinates) of the model.
      
      When called without any parameters this method will return the current bounding box of the model, including only visible parts/objects. For models that support it, the full bounding box can may queried by specifying the optional :js:class:`ModelBoundingBoxOptions <cee.ModelBoundingBoxOptions>` and setting :js:data:`ModelBoundingBoxOptions.includeHiddenParts <cee.ModelBoundingBoxOptions.includeHiddenParts>` to true.
      
      **Parameters**
      
      
         **options**\ : :js:class:`ModelBoundingBoxOptions <cee.ModelBoundingBoxOptions>`
      
      
      **Returns**\ : :js:class:`BoundingBox <cee.BoundingBox>`
      



.. js:method:: cee.Model.getDefaultCameraConfig

      .. rst-class:: sig-pretty-signature
      
         | getDefaultCameraConfig(): :js:class:`CameraConfig <cee.CameraConfig>`
      
      Can return an optional default camera configuration for this model.
      
      If a model returns a default camera config, any views displaying the model may utilize the information to do first-time setup of their camera. The camera config will not have any effect on views where the camera has already been set by the user. If multiple models are shown in the same view, the first model with a default camera config will take precedence.
      
      **Returns**\ : :js:class:`CameraConfig <cee.CameraConfig>`
      




