
#############
ModelSettings
#############

.. js:class:: cee.ug.ModelSettings

   Various settings for the RemoteModel.
   
   
   Index
   =====
   
   .. rubric:: Accessors
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:func:`~cee.ug.ModelSettings.modelColorSource`
   * :js:func:`~cee.ug.ModelSettings.transformationMatrix`
   * :js:func:`~cee.ug.ModelSettings.useFirstOrderElementNodesOnly`
   
   .. rubric:: Methods
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:meth:`~cee.ug.ModelSettings.getAsProperties`
   * :js:meth:`~cee.ug.ModelSettings.setFromProperties`
   
   



.. rst-class:: kind-group kind-accessors

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


.. js:method:: cee.ug.ModelSettings.modelColorSource

      .. rst-class:: sig-pretty-signature
      
         | *get* modelColorSource(): :js:data:`ModelColorSource <cee.ug.ModelColorSource>`
      
      Specify how to color the parts if no fringesResults are used.
      
      This will determine how to color each face of the model if no fringesResults are used. Default is PART (use part colors).
      
      **Returns**\ : :js:data:`ModelColorSource <cee.ug.ModelColorSource>`
      
      .. rst-class:: sig-pretty-signature
      
         | *set* modelColorSource(**colorSource**\ : :js:data:`ModelColorSource <cee.ug.ModelColorSource>`\ ): *void*
      
      **Parameters**
      
      
         **colorSource**\ : :js:data:`ModelColorSource <cee.ug.ModelColorSource>`
      
      
      **Returns**\ : *void*
      



.. js:method:: cee.ug.ModelSettings.transformationMatrix

      .. rst-class:: sig-pretty-signature
      
         | *get* transformationMatrix(): :js:class:`Mat4 <cee.Mat4>`
      
      The transformation matrix to use for this model.
      
      If specified, all parts in the model will be transformed by this matrix. This can be useful for scene composition. The default is null.
      
      **Returns**\ : :js:class:`Mat4 <cee.Mat4>`
      
      .. rst-class:: sig-pretty-signature
      
         | *set* transformationMatrix(**transformationMatrix**\ : :js:class:`Mat4 <cee.Mat4>`\ ): *void*
      
      **Parameters**
      
      
         **transformationMatrix**\ : :js:class:`Mat4 <cee.Mat4>`
      
      
      **Returns**\ : *void*
      



.. js:method:: cee.ug.ModelSettings.useFirstOrderElementNodesOnly

      .. rst-class:: sig-pretty-signature
      
         | *get* useFirstOrderElementNodesOnly(): *boolean*
      
      When enabled, only the first order element nodes will be considered. For example, Quad8 is visualized as Quad4, dropping the mid-nodes.
      
      **Returns**\ : *boolean*
      
      .. rst-class:: sig-pretty-signature
      
         | *set* useFirstOrderElementNodesOnly(**useFirstOrderElementNodesOnly**\ : *boolean*\ ): *void*
      
      **Parameters**
      
      
         **useFirstOrderElementNodesOnly**\ : *boolean*
      
      
      **Returns**\ : *void*
      



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

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


.. js:method:: cee.ug.ModelSettings.getAsProperties

      .. rst-class:: sig-pretty-signature
      
         | getAsProperties(): :js:class:`ModelSettingsProperties <cee.ug.ModelSettingsProperties>`
      
      Gets the settings for this object as a Plain Old JavaScript Object (POJO).
      
      **Returns**\ : :js:class:`ModelSettingsProperties <cee.ug.ModelSettingsProperties>`
      



.. js:method:: cee.ug.ModelSettings.setFromProperties

      .. rst-class:: sig-pretty-signature
      
         | setFromProperties(**props**\ : *Partial*\ ): *void*
      
      Applies the settings in the given properties object to this scalar settings
      
      **Parameters**
      
      
         **props**\ : *Partial*
      
      
      **Returns**\ : *void*
      




