
############
PartSettings
############

.. js:class:: cee.usg.PartSettings

   Settings describing how to render a :js:class:`Part <cee.usg.Part>` in a :js:class:`Geometry <cee.usg.Geometry>`\ .
   
   
   Index
   =====
   
   .. rubric:: Accessors
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:func:`~cee.usg.PartSettings.color`
   * :js:func:`~cee.usg.PartSettings.displacementVisible`
   * :js:func:`~cee.usg.PartSettings.drawStyle`
   * :js:func:`~cee.usg.PartSettings.fringesVisible`
   * :js:func:`~cee.usg.PartSettings.highlight`
   * :js:func:`~cee.usg.PartSettings.opacity`
   * :js:func:`~cee.usg.PartSettings.smooth`
   * :js:func:`~cee.usg.PartSettings.vectorsVisible`
   * :js:func:`~cee.usg.PartSettings.visible`
   
   



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

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


.. js:method:: cee.usg.PartSettings.color

      .. rst-class:: sig-pretty-signature
      
         | *get* color(): :js:class:`Color3Like <cee.Color3Like>`
      
      The color of the part. Note that the returned color cannot be modified.
      
      **Returns**\ : :js:class:`Color3Like <cee.Color3Like>`
      
      .. rst-class:: sig-pretty-signature
      
         | *set* color(**color**\ : :js:class:`Color3Like <cee.Color3Like>`\ ): *void*
      
      **Parameters**
      
      
         **color**\ : :js:class:`Color3Like <cee.Color3Like>`
      
      
      **Returns**\ : *void*
      



.. js:method:: cee.usg.PartSettings.displacementVisible

      .. rst-class:: sig-pretty-signature
      
         | *get* displacementVisible(): *boolean*
      
      If true (default), displacements will be used (if present) for the part
      
      **Returns**\ : *boolean*
      
      .. rst-class:: sig-pretty-signature
      
         | *set* displacementVisible(**visible**\ : *boolean*\ ): *void*
      
      **Parameters**
      
      
         **visible**\ : *boolean*
      
      
      **Returns**\ : *void*
      



.. js:method:: cee.usg.PartSettings.drawStyle

      .. rst-class:: sig-pretty-signature
      
         | *get* drawStyle(): :js:data:`DrawStyle <cee.usg.DrawStyle>`
      
      The specification of how to render the part
      
      **Returns**\ : :js:data:`DrawStyle <cee.usg.DrawStyle>`
      
      .. rst-class:: sig-pretty-signature
      
         | *set* drawStyle(**drawStyle**\ : :js:data:`DrawStyle <cee.usg.DrawStyle>`\ ): *void*
      
      **Parameters**
      
      
         **drawStyle**\ : :js:data:`DrawStyle <cee.usg.DrawStyle>`
      
      
      **Returns**\ : *void*
      



.. js:method:: cee.usg.PartSettings.fringesVisible

      .. rst-class:: sig-pretty-signature
      
         | *get* fringesVisible(): *boolean*
      
      If true (default), scalar fringes will be shown on the part if present in the state. If false, no scalar will be shown even if the result is present.
      
      **Returns**\ : *boolean*
      
      .. rst-class:: sig-pretty-signature
      
         | *set* fringesVisible(**visible**\ : *boolean*\ ): *void*
      
      **Parameters**
      
      
         **visible**\ : *boolean*
      
      
      **Returns**\ : *void*
      



.. js:method:: cee.usg.PartSettings.highlight

      .. rst-class:: sig-pretty-signature
      
         | *get* highlight(): *boolean*
      
      Whether the part should be highlighted.
      
      **Returns**\ : *boolean*
      
      .. rst-class:: sig-pretty-signature
      
         | *set* highlight(**highlight**\ : *boolean*\ ): *void*
      
      **Parameters**
      
      
         **highlight**\ : *boolean*
      
      
      **Returns**\ : *void*
      



.. js:method:: cee.usg.PartSettings.opacity

      .. rst-class:: sig-pretty-signature
      
         | *get* opacity(): *number*
      
      The opacity of the part.
      
      1.0 is fully opaque, 0.0 is fully transparent (invisible).
      
      **Returns**\ : *number*
      
      .. rst-class:: sig-pretty-signature
      
         | *set* opacity(**opacity**\ : *number*\ ): *void*
      
      **Parameters**
      
      
         **opacity**\ : *number*
      
      
      **Returns**\ : *void*
      



.. js:method:: cee.usg.PartSettings.smooth

      .. rst-class:: sig-pretty-signature
      
         | *get* smooth(): *boolean*
      
      Flag controlling the shading model of the part.
      
      If true, smooth shading will be used for the part, where it is rendered with a smoothed out surface with a per pixel lighting. If false, a flat shading rendering will be applied where the surface of an element is rendered with the same color.
      
      Note: Flat shading requires each element to have unique vertices, so it will be slower and use more memory (both normal and GPU).
      
      **Returns**\ : *boolean*
      
      .. rst-class:: sig-pretty-signature
      
         | *set* smooth(**smooth**\ : *boolean*\ ): *void*
      
      **Parameters**
      
      
         **smooth**\ : *boolean*
      
      
      **Returns**\ : *void*
      



.. js:method:: cee.usg.PartSettings.vectorsVisible

      .. rst-class:: sig-pretty-signature
      
         | *get* vectorsVisible(): *boolean*
      
      If true (default), vector results will be shown on the part if present in the state. If false, no vector result will be shown even if the result is present.
      
      **Returns**\ : *boolean*
      
      .. rst-class:: sig-pretty-signature
      
         | *set* vectorsVisible(**visible**\ : *boolean*\ ): *void*
      
      **Parameters**
      
      
         **visible**\ : *boolean*
      
      
      **Returns**\ : *void*
      



.. js:method:: cee.usg.PartSettings.visible

      .. rst-class:: sig-pretty-signature
      
         | *get* visible(): *boolean*
      
      The visibility of the part
      
      **Returns**\ : *boolean*
      
      .. rst-class:: sig-pretty-signature
      
         | *set* visible(**visible**\ : *boolean*\ ): *void*
      
      **Parameters**
      
      
         **visible**\ : *boolean*
      
      
      **Returns**\ : *void*
      




