.. role:: ts-api-decorator

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

.. js:module:: cee.usg
   :noindex:

.. container:: ts-api-section

   .. js:class:: PartSettings

      Settings describing how to render a ``Part`` in a ``Geometry``.



.. container:: api-index-section

   .. rubric:: Accessors

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

   * :js:attr:`~cee.usg.PartSettings.color`
   * :js:attr:`~cee.usg.PartSettings.displacementVisible`
   * :js:attr:`~cee.usg.PartSettings.drawStyle`
   * :js:attr:`~cee.usg.PartSettings.fringesVisible`
   * :js:attr:`~cee.usg.PartSettings.highlight`
   * :js:attr:`~cee.usg.PartSettings.opacity`
   * :js:attr:`~cee.usg.PartSettings.smooth`
   * :js:attr:`~cee.usg.PartSettings.vectorsVisible`
   * :js:attr:`~cee.usg.PartSettings.visible`





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

Accessors
=========

.. container:: ts-api-section

   .. js:function:: PartSettings.color()



      The color of the part. Note that the returned color cannot be modified.


      :rtype: Color3Like

   .. js:function:: PartSettings.color( color)

      :param color: None
      :type color: Color3Like


      :rtype: void



.. container:: ts-api-section

   .. js:function:: PartSettings.displacementVisible()



      If true (default), displacements will be used (if present) for the part


      :rtype: boolean

   .. js:function:: PartSettings.displacementVisible( visible)

      :param visible: None
      :type visible: boolean


      :rtype: void



.. container:: ts-api-section

   .. js:function:: PartSettings.drawStyle()



      The specification of how to render the part


      :rtype: DrawStyle

   .. js:function:: PartSettings.drawStyle( drawStyle)

      :param drawStyle: None
      :type drawStyle: DrawStyle


      :rtype: void



.. container:: ts-api-section

   .. js:function:: PartSettings.fringesVisible()



      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.


      :rtype: boolean

   .. js:function:: PartSettings.fringesVisible( visible)

      :param visible: None
      :type visible: boolean


      :rtype: void



.. container:: ts-api-section

   .. js:function:: PartSettings.highlight()



      Whether the part should be highlighted.


      :rtype: boolean

   .. js:function:: PartSettings.highlight( highlight)

      :param highlight: None
      :type highlight: boolean


      :rtype: void



.. container:: ts-api-section

   .. js:function:: PartSettings.opacity()



      The opacity of the part.

      1.0 is fully opaque, 0.0 is fully transparent (invisible).


      :rtype: number

   .. js:function:: PartSettings.opacity( opacity)

      :param opacity: None
      :type opacity: number


      :rtype: void



.. container:: ts-api-section

   .. js:function:: PartSettings.smooth()



      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).


      :rtype: boolean

   .. js:function:: PartSettings.smooth( smooth)

      :param smooth: None
      :type smooth: boolean


      :rtype: void



.. container:: ts-api-section

   .. js:function:: PartSettings.vectorsVisible()



      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.


      :rtype: boolean

   .. js:function:: PartSettings.vectorsVisible( visible)

      :param visible: None
      :type visible: boolean


      :rtype: void



.. container:: ts-api-section

   .. js:function:: PartSettings.visible()



      The visibility of the part


      :rtype: boolean

   .. js:function:: PartSettings.visible( visible)

      :param visible: None
      :type visible: boolean


      :rtype: void



