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

.. js:class:: cee.geo.PartSettings

   PartSettings defines properties that control how the part is rendered and behaves.
   
   
   Index
   =====
   
   .. rubric:: Accessors
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:func:`~cee.geo.PartSettings.color`
   * :js:func:`~cee.geo.PartSettings.eyeLift`
   * :js:func:`~cee.geo.PartSettings.highlight`
   * :js:func:`~cee.geo.PartSettings.intersectable`
   * :js:func:`~cee.geo.PartSettings.lineWidth`
   * :js:func:`~cee.geo.PartSettings.opacity`
   * :js:func:`~cee.geo.PartSettings.polygonOffset`
   * :js:func:`~cee.geo.PartSettings.specularIntensity`
   * :js:func:`~cee.geo.PartSettings.texture`
   * :js:func:`~cee.geo.PartSettings.visible`
   
   



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

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


.. js:method:: cee.geo.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.geo.PartSettings.eyeLift

      .. rst-class:: sig-pretty-signature
      
         | *get* eyeLift(): :js:data:`EyeLift <cee.EyeLift>`
      
      The eye lift mode to use for this part
      
      **Returns**\ : :js:data:`EyeLift <cee.EyeLift>`
      
      .. rst-class:: sig-pretty-signature
      
         | *set* eyeLift(**mode**\ : :js:data:`EyeLift <cee.EyeLift>`\ ): *void*
      
      **Parameters**
      
      
         **mode**\ : :js:data:`EyeLift <cee.EyeLift>`
      
      
      **Returns**\ : *void*
      



.. js:method:: cee.geo.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.geo.PartSettings.intersectable

      .. rst-class:: sig-pretty-signature
      
         | *get* intersectable(): *boolean*
      
      Specifies if the part should be considered by picking (``rayIntersect()``\ ) or not
      
      **Returns**\ : *boolean*
      
      .. rst-class:: sig-pretty-signature
      
         | *set* intersectable(**intersectable**\ : *boolean*\ ): *void*
      
      **Parameters**
      
      
         **intersectable**\ : *boolean*
      
      
      **Returns**\ : *void*
      



.. js:method:: cee.geo.PartSettings.lineWidth

      .. rst-class:: sig-pretty-signature
      
         | *get* lineWidth(): *number*
      
      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.
      
      **Returns**\ : *number*
      
      .. rst-class:: sig-pretty-signature
      
         | *set* lineWidth(**lineWidth**\ : *number*\ ): *void*
      
      **Parameters**
      
      
         **lineWidth**\ : *number*
      
      
      **Returns**\ : *void*
      



.. js:method:: cee.geo.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.geo.PartSettings.polygonOffset

      .. rst-class:: sig-pretty-signature
      
         | *get* polygonOffset(): :js:data:`PolygonOffset <cee.geo.PolygonOffset>`
      
      The polygon offset mode to use for this part
      
      **Returns**\ : :js:data:`PolygonOffset <cee.geo.PolygonOffset>`
      
      .. rst-class:: sig-pretty-signature
      
         | *set* polygonOffset(**mode**\ : :js:data:`PolygonOffset <cee.geo.PolygonOffset>`\ ): *void*
      
      **Parameters**
      
      
         **mode**\ : :js:data:`PolygonOffset <cee.geo.PolygonOffset>`
      
      
      **Returns**\ : *void*
      



.. js:method:: cee.geo.PartSettings.specularIntensity

      .. rst-class:: sig-pretty-signature
      
         | *get* specularIntensity(): *number*
      
      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.
      
      **Returns**\ : *number*
      
      .. rst-class:: sig-pretty-signature
      
         | *set* specularIntensity(**intensity**\ : *number*\ ): *void*
      
      **Parameters**
      
      
         **intensity**\ : *number*
      
      
      **Returns**\ : *void*
      



.. js:method:: cee.geo.PartSettings.texture

      .. rst-class:: sig-pretty-signature
      
         | *get* texture(): :js:class:`Texture <cee.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.
      
      **Returns**\ : :js:class:`Texture <cee.Texture>`
      
      .. rst-class:: sig-pretty-signature
      
         | *set* texture(**texture**\ : :js:class:`Texture <cee.Texture>`\ ): *void*
      
      **Parameters**
      
      
         **texture**\ : :js:class:`Texture <cee.Texture>`
      
      
      **Returns**\ : *void*
      



.. js:method:: cee.geo.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*
      




