.. role:: ts-api-decorator

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

.. js:module:: cee.geo
   :noindex:

.. container:: ts-api-section

   .. js:class:: PartSettings

      PartSettings defines properties that control how the part is rendered and behaves.



.. container:: api-index-section

   .. rubric:: Accessors

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

   * :js:attr:`~cee.geo.PartSettings.color`
   * :js:attr:`~cee.geo.PartSettings.eyeLift`
   * :js:attr:`~cee.geo.PartSettings.highlight`
   * :js:attr:`~cee.geo.PartSettings.intersectable`
   * :js:attr:`~cee.geo.PartSettings.lineWidth`
   * :js:attr:`~cee.geo.PartSettings.opacity`
   * :js:attr:`~cee.geo.PartSettings.polygonOffset`
   * :js:attr:`~cee.geo.PartSettings.specularIntensity`
   * :js:attr:`~cee.geo.PartSettings.texture`
   * :js:attr:`~cee.geo.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.eyeLift()



      The eye lift mode to use for this part


      :rtype: EyeLift

   .. js:function:: PartSettings.eyeLift( mode)

      :param mode: None
      :type mode: EyeLift


      :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.intersectable()



      Specifies if the part should be considered by picking (``rayIntersect()``) or not


      :rtype: boolean

   .. js:function:: PartSettings.intersectable( intersectable)

      :param intersectable: None
      :type intersectable: boolean


      :rtype: void



.. container:: ts-api-section

   .. js:function:: PartSettings.lineWidth()



      The line width in pixels for line meshes

      Note that setting the width to values greater than 1, will trigger generation and rendering of thick
      lines which can significantly reduce update and rendering performance.


      :rtype: number

   .. js:function:: PartSettings.lineWidth( lineWidth)

      :param lineWidth: None
      :type lineWidth: number


      :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.polygonOffset()



      The polygon offset mode to use for this part


      :rtype: PolygonOffset

   .. js:function:: PartSettings.polygonOffset( mode)

      :param mode: None
      :type mode: PolygonOffset


      :rtype: void



.. container:: ts-api-section

   .. js:function:: PartSettings.specularIntensity()



      The intensity of the specular highlight of the part

      Note that the part's default value for specularIntensity is undefined in which case the global
      default specular intensity will be used. Specify this value to override the default setting.


      :rtype: number

   .. js:function:: PartSettings.specularIntensity( intensity)

      :param intensity: None
      :type intensity: number


      :rtype: void



.. container:: ts-api-section

   .. js:function:: PartSettings.texture()



      Texture to use for this part. If no texture is defined, null is returned.

      Note that using textures requires that the mesh type is MeshIndexedTriangles and that you have
      specified texture coordinates in the mesh.


      :rtype: Texture

   .. js:function:: PartSettings.texture( texture)

      :param texture: None
      :type texture: Texture


      :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



