.. role:: ts-api-decorator

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

.. js:module:: cee.ug
   :noindex:

.. container:: ts-api-section

   .. js:class:: ModelSettings

      Various settings for the RemoteModel.



.. container:: api-index-section

   .. rubric:: Accessors

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

   * :js:attr:`~cee.ug.ModelSettings.modelColorSource`
   * :js:attr:`~cee.ug.ModelSettings.transformationMatrix`
   * :js:attr:`~cee.ug.ModelSettings.useFirstOrderElementNodesOnly`



.. container:: api-index-section

   .. rubric:: Methods

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

   * :js:meth:`~cee.ug.ModelSettings.getAsProperties`
   * :js:meth:`~cee.ug.ModelSettings.setFromProperties`





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

Accessors
=========

.. container:: ts-api-section

   .. js:function:: ModelSettings.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).


      :rtype: ModelColorSource

   .. js:function:: ModelSettings.modelColorSource( colorSource)

      :param colorSource: None
      :type colorSource: ModelColorSource


      :rtype: void



.. container:: ts-api-section

   .. js:function:: ModelSettings.transformationMatrix()



      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.


      :rtype: Mat4

   .. js:function:: ModelSettings.transformationMatrix( transformationMatrix)

      :param transformationMatrix: None
      :type transformationMatrix: Mat4


      :rtype: void



.. container:: ts-api-section

   .. js:function:: ModelSettings.useFirstOrderElementNodesOnly()



      When enabled, only the first order element nodes will be considered. 
      For example, Quad8 is visualized as Quad4, dropping the mid-nodes.


      :rtype: boolean

   .. js:function:: ModelSettings.useFirstOrderElementNodesOnly( useFirstOrderElementNodesOnly)

      :param useFirstOrderElementNodesOnly: None
      :type useFirstOrderElementNodesOnly: boolean


      :rtype: void



Methods
=======

.. rst-class:: ts-api-section

getAsProperties
---------------

.. js:method:: ModelSettings.getAsProperties()



   Gets the settings for this object as a Plain Old JavaScript Object (POJO).


   :rtype: ModelSettingsProperties

.. rst-class:: ts-api-section

setFromProperties
-----------------

.. js:method:: ModelSettings.setFromProperties( props)

   :param props: None
   :type props: Partial <ModelSettingsProperties>


   Applies the settings in the given properties object to this scalar settings


   :rtype: void

