.. role:: ts-api-decorator

#####################
MeshInstanceInterface
#####################

.. js:module:: Sc
   :noindex:

.. container:: ts-api-section

   .. js:class:: MeshInstanceInterface



.. container:: api-index-section

   .. rubric:: Methods

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

   * :js:meth:`~Sc.MeshInstanceInterface.clearAllElementHighlight`
   * :js:meth:`~Sc.MeshInstanceInterface.clearAllElementVisible`
   * :js:meth:`~Sc.MeshInstanceInterface.clearAllElementXRay`
   * :js:meth:`~Sc.MeshInstanceInterface.clearElementColors`
   * :js:meth:`~Sc.MeshInstanceInterface.clearElementHighlight`
   * :js:meth:`~Sc.MeshInstanceInterface.clearElementVisible`
   * :js:meth:`~Sc.MeshInstanceInterface.clearElementXRay`
   * :js:meth:`~Sc.MeshInstanceInterface.computeMinimalBodyBodyDistance`
   * :js:meth:`~Sc.MeshInstanceInterface.computeMinimalFaceFaceDistance`
   * :js:meth:`~Sc.MeshInstanceInterface.computeMinimalFaceLineDistance`
   * :js:meth:`~Sc.MeshInstanceInterface.computeMinimalFaceRayDistance`
   * :js:meth:`~Sc.MeshInstanceInterface.create`
   * :js:meth:`~Sc.MeshInstanceInterface.destroy`
   * :js:meth:`~Sc.MeshInstanceInterface.discardAnonymousMatrix`
   * :js:meth:`~Sc.MeshInstanceInterface.getAlwaysDraw`
   * :js:meth:`~Sc.MeshInstanceInterface.getCappingMeshData`
   * :js:meth:`~Sc.MeshInstanceInterface.getColor`
   * :js:meth:`~Sc.MeshInstanceInterface.getCullingVector`
   * :js:meth:`~Sc.MeshInstanceInterface.getDoNotCut`
   * :js:meth:`~Sc.MeshInstanceInterface.getDoNotExplode`
   * :js:meth:`~Sc.MeshInstanceInterface.getDoNotLight`
   * :js:meth:`~Sc.MeshInstanceInterface.getDoNotOutlineHighlight`
   * :js:meth:`~Sc.MeshInstanceInterface.getDoNotSelect`
   * :js:meth:`~Sc.MeshInstanceInterface.getDoNotUseVertexColors`
   * :js:meth:`~Sc.MeshInstanceInterface.getDrawnWorldSpaceBounding`
   * :js:meth:`~Sc.MeshInstanceInterface.getEffectiveColor`
   * :js:meth:`~Sc.MeshInstanceInterface.getEffectiveElementColor`
   * :js:meth:`~Sc.MeshInstanceInterface.getEffectiveOpacity`
   * :js:meth:`~Sc.MeshInstanceInterface.getElementColor`
   * :js:meth:`~Sc.MeshInstanceInterface.getElementHighlighted`
   * :js:meth:`~Sc.MeshInstanceInterface.getElementVisible`
   * :js:meth:`~Sc.MeshInstanceInterface.getElementXRay`
   * :js:meth:`~Sc.MeshInstanceInterface.getExcludeBounding`
   * :js:meth:`~Sc.MeshInstanceInterface.getFaceElementBounding`
   * :js:meth:`~Sc.MeshInstanceInterface.getFacesVisible`
   * :js:meth:`~Sc.MeshInstanceInterface.getHighlighted`
   * :js:meth:`~Sc.MeshInstanceInterface.getLayerCount`
   * :js:meth:`~Sc.MeshInstanceInterface.getLineElementBounding`
   * :js:meth:`~Sc.MeshInstanceInterface.getLinesVisible`
   * :js:meth:`~Sc.MeshInstanceInterface.getMatrix`
   * :js:meth:`~Sc.MeshInstanceInterface.getMeshData`
   * :js:meth:`~Sc.MeshInstanceInterface.getMetallicRoughness`
   * :js:meth:`~Sc.MeshInstanceInterface.getObjectSpaceBounding`
   * :js:meth:`~Sc.MeshInstanceInterface.getOpacity`
   * :js:meth:`~Sc.MeshInstanceInterface.getOverrideSceneVisibility`
   * :js:meth:`~Sc.MeshInstanceInterface.getPointElementBounding`
   * :js:meth:`~Sc.MeshInstanceInterface.getPointsVisible`
   * :js:meth:`~Sc.MeshInstanceInterface.getScreenOriented`
   * :js:meth:`~Sc.MeshInstanceInterface.getScreenSpace`
   * :js:meth:`~Sc.MeshInstanceInterface.getScreenSpaceStretched`
   * :js:meth:`~Sc.MeshInstanceInterface.getSuppressCameraScale`
   * :js:meth:`~Sc.MeshInstanceInterface.getWorldSpaceBounding`
   * :js:meth:`~Sc.MeshInstanceInterface.hasDepthRange`
   * :js:meth:`~Sc.MeshInstanceInterface.hasTransparency`
   * :js:meth:`~Sc.MeshInstanceInterface.linesToIncidentFaces`
   * :js:meth:`~Sc.MeshInstanceInterface.matrixPreMultiply`
   * :js:meth:`~Sc.MeshInstanceInterface.reifyAnonymousMatrix`
   * :js:meth:`~Sc.MeshInstanceInterface.setAlwaysDraw`
   * :js:meth:`~Sc.MeshInstanceInterface.setAmbientColor`
   * :js:meth:`~Sc.MeshInstanceInterface.setAmbientMix`
   * :js:meth:`~Sc.MeshInstanceInterface.setAnonymousMatrices`
   * :js:meth:`~Sc.MeshInstanceInterface.setAnonymousMatrix`
   * :js:meth:`~Sc.MeshInstanceInterface.setColor`
   * :js:meth:`~Sc.MeshInstanceInterface.setCullingVector`
   * :js:meth:`~Sc.MeshInstanceInterface.setDepthRange`
   * :js:meth:`~Sc.MeshInstanceInterface.setDoNotCut`
   * :js:meth:`~Sc.MeshInstanceInterface.setDoNotExplode`
   * :js:meth:`~Sc.MeshInstanceInterface.setDoNotLight`
   * :js:meth:`~Sc.MeshInstanceInterface.setDoNotOutlineHighlight`
   * :js:meth:`~Sc.MeshInstanceInterface.setDoNotReset`
   * :js:meth:`~Sc.MeshInstanceInterface.setDoNotSelect`
   * :js:meth:`~Sc.MeshInstanceInterface.setDoNotUseVertexColors`
   * :js:meth:`~Sc.MeshInstanceInterface.setDoNotXRay`
   * :js:meth:`~Sc.MeshInstanceInterface.setElementColor`
   * :js:meth:`~Sc.MeshInstanceInterface.setElementHighlighted`
   * :js:meth:`~Sc.MeshInstanceInterface.setElementVisible`
   * :js:meth:`~Sc.MeshInstanceInterface.setElementXRay`
   * :js:meth:`~Sc.MeshInstanceInterface.setEmissiveColor`
   * :js:meth:`~Sc.MeshInstanceInterface.setExcludeBounding`
   * :js:meth:`~Sc.MeshInstanceInterface.setFacesVisible`
   * :js:meth:`~Sc.MeshInstanceInterface.setHighlighted`
   * :js:meth:`~Sc.MeshInstanceInterface.setLinePattern`
   * :js:meth:`~Sc.MeshInstanceInterface.setLinesVisible`
   * :js:meth:`~Sc.MeshInstanceInterface.setMatrix`
   * :js:meth:`~Sc.MeshInstanceInterface.setMeshLevel`
   * :js:meth:`~Sc.MeshInstanceInterface.setMetallicRoughness`
   * :js:meth:`~Sc.MeshInstanceInterface.setOpacity`
   * :js:meth:`~Sc.MeshInstanceInterface.setOverlayId`
   * :js:meth:`~Sc.MeshInstanceInterface.setOverrideSceneVisibility`
   * :js:meth:`~Sc.MeshInstanceInterface.setPointsVisible`
   * :js:meth:`~Sc.MeshInstanceInterface.setScreenOriented`
   * :js:meth:`~Sc.MeshInstanceInterface.setScreenSpace`
   * :js:meth:`~Sc.MeshInstanceInterface.setScreenSpaceStretched`
   * :js:meth:`~Sc.MeshInstanceInterface.setSpecularColor`
   * :js:meth:`~Sc.MeshInstanceInterface.setSpecularIntensity`
   * :js:meth:`~Sc.MeshInstanceInterface.setStreamCutoffScale`
   * :js:meth:`~Sc.MeshInstanceInterface.setSuppressCameraScale`
   * :js:meth:`~Sc.MeshInstanceInterface.setTexture`
   * :js:meth:`~Sc.MeshInstanceInterface.setVisible`
   * :js:meth:`~Sc.MeshInstanceInterface.setXRay`
   * :js:meth:`~Sc.MeshInstanceInterface.synchronizeVisibilities`
   * :js:meth:`~Sc.MeshInstanceInterface.unsetColor`
   * :js:meth:`~Sc.MeshInstanceInterface.unsetCullingVector`
   * :js:meth:`~Sc.MeshInstanceInterface.unsetDepthRange`
   * :js:meth:`~Sc.MeshInstanceInterface.unsetElementColor`
   * :js:meth:`~Sc.MeshInstanceInterface.unsetEmissiveColor`
   * :js:meth:`~Sc.MeshInstanceInterface.unsetLinePattern`
   * :js:meth:`~Sc.MeshInstanceInterface.unsetMatrix`
   * :js:meth:`~Sc.MeshInstanceInterface.unsetMetallicRoughness`
   * :js:meth:`~Sc.MeshInstanceInterface.unsetOpacity`
   * :js:meth:`~Sc.MeshInstanceInterface.unsetSpecularColor`
   * :js:meth:`~Sc.MeshInstanceInterface.unsetSpecularIntensity`
   * :js:meth:`~Sc.MeshInstanceInterface.unsetTexture`





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

Methods
=======

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

clearAllElementHighlight
------------------------

.. js:method:: MeshInstanceInterface.clearAllElementHighlight( incs)

   :param incs: None
   :type incs: InstanceIncs


   :rtype: void

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

clearAllElementVisible
----------------------

.. js:method:: MeshInstanceInterface.clearAllElementVisible( incs)

   :param incs: None
   :type incs: InstanceIncs


   :rtype: void

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

clearAllElementXRay
-------------------

.. js:method:: MeshInstanceInterface.clearAllElementXRay( incs)

   :param incs: None
   :type incs: InstanceIncs


   :rtype: void

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

clearElementColors
------------------

.. js:method:: MeshInstanceInterface.clearElementColors( incs, elementType)

   :param incs: None
   :type incs: InstanceIncs
   :param elementType: None
   :type elementType: ElementType


   :rtype: void

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

clearElementHighlight
---------------------

.. js:method:: MeshInstanceInterface.clearElementHighlight( incs, elementType)

   :param incs: None
   :type incs: InstanceIncs
   :param elementType: None
   :type elementType: ElementType


   :rtype: void

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

clearElementVisible
-------------------

.. js:method:: MeshInstanceInterface.clearElementVisible( incs, elementType)

   :param incs: None
   :type incs: InstanceIncs
   :param elementType: None
   :type elementType: ElementType


   :rtype: void

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

clearElementXRay
----------------

.. js:method:: MeshInstanceInterface.clearElementXRay( incs, elementType)

   :param incs: None
   :type incs: InstanceIncs
   :param elementType: None
   :type elementType: ElementType


   :rtype: void

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

computeMinimalBodyBodyDistance
------------------------------

.. js:method:: MeshInstanceInterface.computeMinimalBodyBodyDistance( index, inc1, inc2)

   :param index: None
   :type index: ViewKey
   :param inc1: None
   :type inc1: InstanceInc
   :param inc2: None
   :type inc2: InstanceInc


   :rtype: Promise <FaceFaceDistanceObject>

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

computeMinimalFaceFaceDistance
------------------------------

.. js:method:: MeshInstanceInterface.computeMinimalFaceFaceDistance( index, inc1, faceIndex1, inc2, faceIndex2)

   :param index: None
   :type index: ViewKey
   :param inc1: None
   :type inc1: InstanceInc
   :param faceIndex1: None
   :type faceIndex1: number
   :param inc2: None
   :type inc2: InstanceInc
   :param faceIndex2: None
   :type faceIndex2: number


   :rtype: Promise <FaceFaceDistanceObject>

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

computeMinimalFaceLineDistance
------------------------------

.. js:method:: MeshInstanceInterface.computeMinimalFaceLineDistance( index, inc, faceIndex, ray)

   :param index: None
   :type index: ViewKey
   :param inc: None
   :type inc: InstanceInc
   :param faceIndex: None
   :type faceIndex: number
   :param ray: None
   :type ray: IRay


   :rtype: Promise <FaceFaceDistanceObject>

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

computeMinimalFaceRayDistance
-----------------------------

.. js:method:: MeshInstanceInterface.computeMinimalFaceRayDistance( index, inc, faceIndex, ray)

   :param index: None
   :type index: ViewKey
   :param inc: None
   :type inc: InstanceInc
   :param faceIndex: None
   :type faceIndex: number
   :param ray: None
   :type ray: IRay


   :rtype: Promise <FaceFaceDistanceObject>

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

create
------

.. js:method:: MeshInstanceInterface.create( meshId, matrixInc, faceColor, lineColor, pointColor[, flags[, overlayIndex[, viewKey]]])

   :param meshId: None
   :type meshId: MeshId
   :param matrixInc: None
   :type matrixInc: MatrixInc
   :param faceColor: None
   :type faceColor: Vector4
   :param lineColor: None
   :type lineColor: Vector4
   :param pointColor: None
   :type pointColor: Vector4
   :param flags: :ts-api-decorator:`optional` None
   :type flags: number
   :param overlayIndex: :ts-api-decorator:`optional` None
   :type overlayIndex: number
   :param viewKey: :ts-api-decorator:`optional` None
   :type viewKey: ViewKey


   :rtype: Promise <InstanceInc>

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

destroy
-------

.. js:method:: MeshInstanceInterface.destroy( incs)

   :param incs: None
   :type incs: InstanceIncs


   :rtype: Promise <void>

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

discardAnonymousMatrix
----------------------

.. js:method:: MeshInstanceInterface.discardAnonymousMatrix( incs)

   :param incs: None
   :type incs: InstanceIncs


   :rtype: Promise <void>

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

getAlwaysDraw
-------------

.. js:method:: MeshInstanceInterface.getAlwaysDraw( incs)

   :param incs: None
   :type incs: InstanceIncs


   :rtype: Promise <[boolean]>

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

getCappingMeshData
------------------

.. js:method:: MeshInstanceInterface.getCappingMeshData( incs)

   :param incs: None
   :type incs: InstanceIncs


   :rtype: Promise <MeshIds>

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

getColor
--------

.. js:method:: MeshInstanceInterface.getColor( incs, elementType)

   :param incs: None
   :type incs: InstanceIncs
   :param elementType: None
   :type elementType: ElementType


   :rtype: Promise <[null | Vector3]>

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

getCullingVector
----------------

.. js:method:: MeshInstanceInterface.getCullingVector( incs)

   :param incs: None
   :type incs: InstanceIncs


   :rtype: Promise <[CullingVector]>

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

getDoNotCut
-----------

.. js:method:: MeshInstanceInterface.getDoNotCut( incs)

   :param incs: None
   :type incs: InstanceIncs


   :rtype: Promise <[boolean]>

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

getDoNotExplode
---------------

.. js:method:: MeshInstanceInterface.getDoNotExplode( incs)

   :param incs: None
   :type incs: InstanceIncs


   :rtype: Promise <[boolean]>

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

getDoNotLight
-------------

.. js:method:: MeshInstanceInterface.getDoNotLight( incs)

   :param incs: None
   :type incs: InstanceIncs


   :rtype: Promise <[boolean]>

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

getDoNotOutlineHighlight
------------------------

.. js:method:: MeshInstanceInterface.getDoNotOutlineHighlight( incs)

   :param incs: None
   :type incs: InstanceIncs


   :rtype: Promise <[boolean]>

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

getDoNotSelect
--------------

.. js:method:: MeshInstanceInterface.getDoNotSelect( incs)

   :param incs: None
   :type incs: InstanceIncs


   :rtype: Promise <[boolean]>

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

getDoNotUseVertexColors
-----------------------

.. js:method:: MeshInstanceInterface.getDoNotUseVertexColors( incs)

   :param incs: None
   :type incs: InstanceIncs


   :rtype: Promise <[boolean]>

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

getDrawnWorldSpaceBounding
--------------------------

.. js:method:: MeshInstanceInterface.getDrawnWorldSpaceBounding( viewKey)

   :param viewKey: None
   :type viewKey: ViewKey


   :rtype: Promise <IBox>

.. js:method:: MeshInstanceInterface.getDrawnWorldSpaceBounding( incs, viewKey)
   :noindex:

   :param incs: None
   :type incs: InstanceIncs
   :param viewKey: None
   :type viewKey: ViewKey


   :rtype: Promise <IBox>

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

getEffectiveColor
-----------------

.. js:method:: MeshInstanceInterface.getEffectiveColor( incs, elementType)

   :param incs: None
   :type incs: InstanceIncs
   :param elementType: None
   :type elementType: ElementType


   :rtype: Promise <[Vector3]>

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

getEffectiveElementColor
------------------------

.. js:method:: MeshInstanceInterface.getEffectiveElementColor( incs, viewKey, elementType, index)

   :param incs: None
   :type incs: InstanceIncs
   :param viewKey: None
   :type viewKey: ViewKey
   :param elementType: None
   :type elementType: ElementType
   :param index: None
   :type index: number


   :rtype: Promise <[Vector3]>

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

getEffectiveOpacity
-------------------

.. js:method:: MeshInstanceInterface.getEffectiveOpacity( incs, elementType)

   :param incs: None
   :type incs: InstanceIncs
   :param elementType: None
   :type elementType: ElementType


   :rtype: Promise <[number]>

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

getElementColor
---------------

.. js:method:: MeshInstanceInterface.getElementColor( incs, elementType, index)

   :param incs: None
   :type incs: InstanceIncs
   :param elementType: None
   :type elementType: ElementType
   :param index: None
   :type index: number


   :rtype: Promise <[null | Vector3]>

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

getElementHighlighted
---------------------

.. js:method:: MeshInstanceInterface.getElementHighlighted( incs, elementType, elementIndex)

   :param incs: None
   :type incs: InstanceIncs
   :param elementType: None
   :type elementType: ElementType
   :param elementIndex: None
   :type elementIndex: number


   :rtype: Promise <[boolean]>

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

getElementVisible
-----------------

.. js:method:: MeshInstanceInterface.getElementVisible( incs, elementType, elementIndex)

   :param incs: None
   :type incs: InstanceIncs
   :param elementType: None
   :type elementType: ElementType
   :param elementIndex: None
   :type elementIndex: number


   :rtype: Promise <[boolean]>

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

getElementXRay
--------------

.. js:method:: MeshInstanceInterface.getElementXRay( incs, elementType, elementIndex)

   :param incs: None
   :type incs: InstanceIncs
   :param elementType: None
   :type elementType: ElementType
   :param elementIndex: None
   :type elementIndex: number


   :rtype: Promise <[boolean]>

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

getExcludeBounding
------------------

.. js:method:: MeshInstanceInterface.getExcludeBounding( incs)

   :param incs: None
   :type incs: InstanceIncs


   :rtype: Promise <[boolean]>

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

getFaceElementBounding
----------------------

.. js:method:: MeshInstanceInterface.getFaceElementBounding( elementIndices, inc)

   :param elementIndices: None
   :type elementIndices: [number]
   :param inc: None
   :type inc: InstanceInc


   :rtype: Promise <IBox>

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

getFacesVisible
---------------

.. js:method:: MeshInstanceInterface.getFacesVisible( incs)

   :param incs: None
   :type incs: InstanceIncs


   :rtype: Promise <[boolean]>

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

getHighlighted
--------------

.. js:method:: MeshInstanceInterface.getHighlighted( incs)

   :param incs: None
   :type incs: InstanceIncs


   :rtype: Promise <[boolean]>

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

getLayerCount
-------------

.. js:method:: MeshInstanceInterface.getLayerCount()



   :rtype: number

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

getLineElementBounding
----------------------

.. js:method:: MeshInstanceInterface.getLineElementBounding( elementIndices, inc)

   :param elementIndices: None
   :type elementIndices: [number]
   :param inc: None
   :type inc: InstanceInc


   :rtype: Promise <IBox>

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

getLinesVisible
---------------

.. js:method:: MeshInstanceInterface.getLinesVisible( incs)

   :param incs: None
   :type incs: InstanceIncs


   :rtype: Promise <[boolean]>

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

getMatrix
---------

.. js:method:: MeshInstanceInterface.getMatrix( incs, layer)

   :param incs: None
   :type incs: InstanceIncs
   :param layer: None
   :type layer: number


   :rtype: Promise <MatrixIncs>

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

getMeshData
-----------

.. js:method:: MeshInstanceInterface.getMeshData( incs)

   :param incs: None
   :type incs: InstanceIncs


   :rtype: Promise <MeshIds>

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

getMetallicRoughness
--------------------

.. js:method:: MeshInstanceInterface.getMetallicRoughness( incs)

   :param incs: None
   :type incs: InstanceIncs


   :rtype: Promise <[number]>

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

getObjectSpaceBounding
----------------------

.. js:method:: MeshInstanceInterface.getObjectSpaceBounding( incs)

   :param incs: None
   :type incs: InstanceIncs


   :rtype: Promise <[IBox]>

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

getOpacity
----------

.. js:method:: MeshInstanceInterface.getOpacity( incs, elementType)

   :param incs: None
   :type incs: InstanceIncs
   :param elementType: None
   :type elementType: ElementType


   :rtype: [null | number]

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

getOverrideSceneVisibility
--------------------------

.. js:method:: MeshInstanceInterface.getOverrideSceneVisibility( incs)

   :param incs: None
   :type incs: InstanceIncs


   :rtype: Promise <[boolean]>

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

getPointElementBounding
-----------------------

.. js:method:: MeshInstanceInterface.getPointElementBounding( elementIndices, inc)

   :param elementIndices: None
   :type elementIndices: [number]
   :param inc: None
   :type inc: InstanceInc


   :rtype: Promise <IBox>

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

getPointsVisible
----------------

.. js:method:: MeshInstanceInterface.getPointsVisible( incs)

   :param incs: None
   :type incs: InstanceIncs


   :rtype: Promise <[boolean]>

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

getScreenOriented
-----------------

.. js:method:: MeshInstanceInterface.getScreenOriented( incs)

   :param incs: None
   :type incs: InstanceIncs


   :rtype: Promise <[boolean]>

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

getScreenSpace
--------------

.. js:method:: MeshInstanceInterface.getScreenSpace( incs)

   :param incs: None
   :type incs: InstanceIncs


   :rtype: Promise <[boolean]>

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

getScreenSpaceStretched
-----------------------

.. js:method:: MeshInstanceInterface.getScreenSpaceStretched( incs)

   :param incs: None
   :type incs: InstanceIncs


   :rtype: Promise <[boolean]>

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

getSuppressCameraScale
----------------------

.. js:method:: MeshInstanceInterface.getSuppressCameraScale( incs)

   :param incs: None
   :type incs: InstanceIncs


   :rtype: Promise <[boolean]>

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

getWorldSpaceBounding
---------------------

.. js:method:: MeshInstanceInterface.getWorldSpaceBounding( incs, ignoreInvisible, includeExcluded, tightBounding)

   :param incs: None
   :type incs: InstanceIncs
   :param ignoreInvisible: None
   :type ignoreInvisible: boolean
   :param includeExcluded: None
   :type includeExcluded: boolean
   :param tightBounding: None
   :type tightBounding: boolean


   :rtype: Promise <IBox>

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

hasDepthRange
-------------

.. js:method:: MeshInstanceInterface.hasDepthRange( incs)

   :param incs: None
   :type incs: InstanceIncs


   :rtype: Promise <[boolean]>

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

hasTransparency
---------------

.. js:method:: MeshInstanceInterface.hasTransparency( incs, elementType)

   :param incs: None
   :type incs: InstanceIncs
   :param elementType: None
   :type elementType: ElementType


   :rtype: Promise <[boolean]>

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

linesToIncidentFaces
--------------------

.. js:method:: MeshInstanceInterface.linesToIncidentFaces( elementIndices, inc)

   :param elementIndices: None
   :type elementIndices: [number]
   :param inc: None
   :type inc: InstanceInc


   :rtype: Promise <[number]>

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

matrixPreMultiply
-----------------

.. js:method:: MeshInstanceInterface.matrixPreMultiply( incs, matrix)

   :param incs: None
   :type incs: InstanceIncs
   :param matrix: None
   :type matrix: Matrix16


   :rtype: Promise <void>

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

reifyAnonymousMatrix
--------------------

.. js:method:: MeshInstanceInterface.reifyAnonymousMatrix( incs)

   :param incs: None
   :type incs: InstanceIncs


   :rtype: Promise <MatrixIncs>

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

setAlwaysDraw
-------------

.. js:method:: MeshInstanceInterface.setAlwaysDraw( incs, value)

   :param incs: None
   :type incs: InstanceIncs
   :param value: None
   :type value: boolean


   :rtype: void

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

setAmbientColor
---------------

.. js:method:: MeshInstanceInterface.setAmbientColor( incs, elementType, color)

   :param incs: None
   :type incs: InstanceIncs
   :param elementType: None
   :type elementType: ElementType
   :param color: None
   :type color: Vector3


   :rtype: void

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

setAmbientMix
-------------

.. js:method:: MeshInstanceInterface.setAmbientMix( incs, elementType, value)

   :param incs: None
   :type incs: InstanceIncs
   :param elementType: None
   :type elementType: ElementType
   :param value: None
   :type value: number


   :rtype: void

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

setAnonymousMatrices
--------------------

.. js:method:: MeshInstanceInterface.setAnonymousMatrices( incs, matrices)

   :param incs: None
   :type incs: InstanceIncs
   :param matrices: None
   :type matrices: [number]


   :rtype: void

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

setAnonymousMatrix
------------------

.. js:method:: MeshInstanceInterface.setAnonymousMatrix( incs, matrix)

   :param incs: None
   :type incs: InstanceIncs
   :param matrix: None
   :type matrix: Matrix16


   :rtype: void

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

setColor
--------

.. js:method:: MeshInstanceInterface.setColor( incs, elementType, color)

   :param incs: None
   :type incs: InstanceIncs
   :param elementType: None
   :type elementType: ElementType
   :param color: None
   :type color: Vector3


   :rtype: void

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

setCullingVector
----------------

.. js:method:: MeshInstanceInterface.setCullingVector( incs, space, vector, toleranceDegrees)

   :param incs: None
   :type incs: InstanceIncs
   :param space: None
   :type space: CullingVectorSpace
   :param vector: None
   :type vector: Vector3
   :param toleranceDegrees: None
   :type toleranceDegrees: number


   :rtype: void

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

setDepthRange
-------------

.. js:method:: MeshInstanceInterface.setDepthRange( incs, min, max)

   :param incs: None
   :type incs: InstanceIncs
   :param min: None
   :type min: number
   :param max: None
   :type max: number


   :rtype: void

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

setDoNotCut
-----------

.. js:method:: MeshInstanceInterface.setDoNotCut( incs, doNotCut)

   :param incs: None
   :type incs: InstanceIncs
   :param doNotCut: None
   :type doNotCut: boolean


   :rtype: void

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

setDoNotExplode
---------------

.. js:method:: MeshInstanceInterface.setDoNotExplode( incs, doNotExplode)

   :param incs: None
   :type incs: InstanceIncs
   :param doNotExplode: None
   :type doNotExplode: boolean


   :rtype: void

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

setDoNotLight
-------------

.. js:method:: MeshInstanceInterface.setDoNotLight( incs, value)

   :param incs: None
   :type incs: InstanceIncs
   :param value: None
   :type value: boolean


   :rtype: void

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

setDoNotOutlineHighlight
------------------------

.. js:method:: MeshInstanceInterface.setDoNotOutlineHighlight( incs, value)

   :param incs: None
   :type incs: InstanceIncs
   :param value: None
   :type value: boolean


   :rtype: void

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

setDoNotReset
-------------

.. js:method:: MeshInstanceInterface.setDoNotReset( incs, doNotReset)

   :param incs: None
   :type incs: InstanceIncs
   :param doNotReset: None
   :type doNotReset: boolean


   :rtype: void

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

setDoNotSelect
--------------

.. js:method:: MeshInstanceInterface.setDoNotSelect( incs, doNotSelect)

   :param incs: None
   :type incs: InstanceIncs
   :param doNotSelect: None
   :type doNotSelect: boolean


   :rtype: void

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

setDoNotUseVertexColors
-----------------------

.. js:method:: MeshInstanceInterface.setDoNotUseVertexColors( incs, value)

   :param incs: None
   :type incs: InstanceIncs
   :param value: None
   :type value: boolean


   :rtype: void

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

setDoNotXRay
------------

.. js:method:: MeshInstanceInterface.setDoNotXRay( incs, value)

   :param incs: None
   :type incs: InstanceIncs
   :param value: None
   :type value: boolean


   :rtype: void

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

setElementColor
---------------

.. js:method:: MeshInstanceInterface.setElementColor( incs, elementType, elementOffset, elementCount, color)

   :param incs: None
   :type incs: InstanceIncs
   :param elementType: None
   :type elementType: ElementType
   :param elementOffset: None
   :type elementOffset: number
   :param elementCount: None
   :type elementCount: number
   :param color: None
   :type color: Vector3


   :rtype: void

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

setElementHighlighted
---------------------

.. js:method:: MeshInstanceInterface.setElementHighlighted( incs, elementType, elementIndex, elementCount, value)

   :param incs: None
   :type incs: InstanceIncs
   :param elementType: None
   :type elementType: ElementType
   :param elementIndex: None
   :type elementIndex: number
   :param elementCount: None
   :type elementCount: number
   :param value: None
   :type value: boolean


   :rtype: void

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

setElementVisible
-----------------

.. js:method:: MeshInstanceInterface.setElementVisible( incs, elementType, elementIndex, elementCount, value)

   :param incs: None
   :type incs: InstanceIncs
   :param elementType: None
   :type elementType: ElementType
   :param elementIndex: None
   :type elementIndex: number
   :param elementCount: None
   :type elementCount: number
   :param value: None
   :type value: boolean


   :rtype: void

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

setElementXRay
--------------

.. js:method:: MeshInstanceInterface.setElementXRay( incs, elementType, elementIndex, elementCount, value)

   :param incs: None
   :type incs: InstanceIncs
   :param elementType: None
   :type elementType: ElementType
   :param elementIndex: None
   :type elementIndex: number
   :param elementCount: None
   :type elementCount: number
   :param value: None
   :type value: boolean


   :rtype: void

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

setEmissiveColor
----------------

.. js:method:: MeshInstanceInterface.setEmissiveColor( incs, elementType, color)

   :param incs: None
   :type incs: InstanceIncs
   :param elementType: None
   :type elementType: ElementType
   :param color: None
   :type color: Vector3


   :rtype: void

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

setExcludeBounding
------------------

.. js:method:: MeshInstanceInterface.setExcludeBounding( incs, value)

   :param incs: None
   :type incs: InstanceIncs
   :param value: None
   :type value: boolean


   :rtype: void

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

setFacesVisible
---------------

.. js:method:: MeshInstanceInterface.setFacesVisible( incs, visible)

   :param incs: None
   :type incs: InstanceIncs
   :param visible: None
   :type visible: boolean


   :rtype: void

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

setHighlighted
--------------

.. js:method:: MeshInstanceInterface.setHighlighted( incs, highlighted)

   :param incs: None
   :type incs: InstanceIncs
   :param highlighted: None
   :type highlighted: boolean


   :rtype: void

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

setLinePattern
--------------

.. js:method:: MeshInstanceInterface.setLinePattern( incs, pattern, patternLength, patternLengthUnit)

   :param incs: None
   :type incs: InstanceIncs
   :param pattern: None
   :type pattern: [number] | Uint8Array
   :param patternLength: None
   :type patternLength: number
   :param patternLengthUnit: None
   :type patternLengthUnit: LinePatternLengthUnit


   :rtype: void

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

setLinesVisible
---------------

.. js:method:: MeshInstanceInterface.setLinesVisible( incs, visible)

   :param incs: None
   :type incs: InstanceIncs
   :param visible: None
   :type visible: boolean


   :rtype: void

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

setMatrix
---------

.. js:method:: MeshInstanceInterface.setMatrix( incs, layer, matrixInc)

   :param incs: None
   :type incs: InstanceIncs
   :param layer: None
   :type layer: number
   :param matrixInc: None
   :type matrixInc: MatrixInc


   :rtype: Promise <void>

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

setMeshLevel
------------

.. js:method:: MeshInstanceInterface.setMeshLevel( incs, meshLevel)

   :param incs: None
   :type incs: InstanceIncs
   :param meshLevel: None
   :type meshLevel: number


   :rtype: void

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

setMetallicRoughness
--------------------

.. js:method:: MeshInstanceInterface.setMetallicRoughness( incs, metallicFactor, roughnessFactor)

   :param incs: None
   :type incs: InstanceIncs
   :param metallicFactor: None
   :type metallicFactor: number
   :param roughnessFactor: None
   :type roughnessFactor: number


   :rtype: void

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

setOpacity
----------

.. js:method:: MeshInstanceInterface.setOpacity( incs, elementType, opacity)

   :param incs: None
   :type incs: InstanceIncs
   :param elementType: None
   :type elementType: ElementType
   :param opacity: None
   :type opacity: number


   :rtype: void

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

setOverlayId
------------

.. js:method:: MeshInstanceInterface.setOverlayId( incs, viewKey, index)

   :param incs: None
   :type incs: InstanceIncs
   :param viewKey: None
   :type viewKey: ViewKey
   :param index: None
   :type index: number


   :rtype: void

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

setOverrideSceneVisibility
--------------------------

.. js:method:: MeshInstanceInterface.setOverrideSceneVisibility( incs, overrideSceneVisibility)

   :param incs: None
   :type incs: InstanceIncs
   :param overrideSceneVisibility: None
   :type overrideSceneVisibility: boolean


   :rtype: void

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

setPointsVisible
----------------

.. js:method:: MeshInstanceInterface.setPointsVisible( incs, visible)

   :param incs: None
   :type incs: InstanceIncs
   :param visible: None
   :type visible: boolean


   :rtype: void

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

setScreenOriented
-----------------

.. js:method:: MeshInstanceInterface.setScreenOriented( incs, value)

   :param incs: None
   :type incs: InstanceIncs
   :param value: None
   :type value: boolean


   :rtype: void

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

setScreenSpace
--------------

.. js:method:: MeshInstanceInterface.setScreenSpace( incs, value)

   :param incs: None
   :type incs: InstanceIncs
   :param value: None
   :type value: boolean


   :rtype: void

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

setScreenSpaceStretched
-----------------------

.. js:method:: MeshInstanceInterface.setScreenSpaceStretched( incs, value)

   :param incs: None
   :type incs: InstanceIncs
   :param value: None
   :type value: boolean


   :rtype: void

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

setSpecularColor
----------------

.. js:method:: MeshInstanceInterface.setSpecularColor( incs, elementType, color)

   :param incs: None
   :type incs: InstanceIncs
   :param elementType: None
   :type elementType: ElementType
   :param color: None
   :type color: Vector3


   :rtype: void

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

setSpecularIntensity
--------------------

.. js:method:: MeshInstanceInterface.setSpecularIntensity( incs, elementType, value)

   :param incs: None
   :type incs: InstanceIncs
   :param elementType: None
   :type elementType: ElementType
   :param value: None
   :type value: number


   :rtype: void

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

setStreamCutoffScale
--------------------

.. js:method:: MeshInstanceInterface.setStreamCutoffScale( value)

   :param value: None
   :type value: number


   :rtype: void

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

setSuppressCameraScale
----------------------

.. js:method:: MeshInstanceInterface.setSuppressCameraScale( incs, suppressCameraScale)

   :param incs: None
   :type incs: InstanceIncs
   :param suppressCameraScale: None
   :type suppressCameraScale: boolean


   :rtype: void

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

setTexture
----------

.. js:method:: MeshInstanceInterface.setTexture( incs, elementType, imageId, matrix, tiling, interpolation, mipMapping, parameterization, modifiers)

   :param incs: None
   :type incs: InstanceIncs
   :param elementType: None
   :type elementType: ElementType
   :param imageId: None
   :type imageId: ImageId
   :param matrix: None
   :type matrix: Matrix16
   :param tiling: None
   :type tiling: TextureTiling
   :param interpolation: None
   :type interpolation: TextureInterpolation
   :param mipMapping: None
   :type mipMapping: TextureMipMapping
   :param parameterization: None
   :type parameterization: TextureParameterization
   :param modifiers: None
   :type modifiers: TextureModifier


   :rtype: Promise <void>

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

setVisible
----------

.. js:method:: MeshInstanceInterface.setVisible( incs, visible, onlyDemanded)

   :param incs: None
   :type incs: InstanceIncs
   :param visible: None
   :type visible: boolean
   :param onlyDemanded: None
   :type onlyDemanded: boolean


   :rtype: void

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

setXRay
-------

.. js:method:: MeshInstanceInterface.setXRay( incs, value)

   :param incs: None
   :type incs: InstanceIncs
   :param value: None
   :type value: boolean


   :rtype: void

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

synchronizeVisibilities
-----------------------

.. js:method:: MeshInstanceInterface.synchronizeVisibilities( incs, visible)

   :param incs: None
   :type incs: InstanceIncs
   :param visible: None
   :type visible: boolean


   :rtype: void

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

unsetColor
----------

.. js:method:: MeshInstanceInterface.unsetColor( incs, elementType)

   :param incs: None
   :type incs: InstanceIncs
   :param elementType: None
   :type elementType: ElementType


   :rtype: void

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

unsetCullingVector
------------------

.. js:method:: MeshInstanceInterface.unsetCullingVector( incs)

   :param incs: None
   :type incs: InstanceIncs


   :rtype: void

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

unsetDepthRange
---------------

.. js:method:: MeshInstanceInterface.unsetDepthRange( incs)

   :param incs: None
   :type incs: InstanceIncs


   :rtype: void

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

unsetElementColor
-----------------

.. js:method:: MeshInstanceInterface.unsetElementColor( incs, elementType, elementOffset, elementCount)

   :param incs: None
   :type incs: InstanceIncs
   :param elementType: None
   :type elementType: ElementType
   :param elementOffset: None
   :type elementOffset: number
   :param elementCount: None
   :type elementCount: number


   :rtype: void

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

unsetEmissiveColor
------------------

.. js:method:: MeshInstanceInterface.unsetEmissiveColor( incs, elementType)

   :param incs: None
   :type incs: InstanceIncs
   :param elementType: None
   :type elementType: ElementType


   :rtype: void

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

unsetLinePattern
----------------

.. js:method:: MeshInstanceInterface.unsetLinePattern( incs)

   :param incs: None
   :type incs: InstanceIncs


   :rtype: void

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

unsetMatrix
-----------

.. js:method:: MeshInstanceInterface.unsetMatrix( incs, layer)

   :param incs: None
   :type incs: InstanceIncs
   :param layer: None
   :type layer: number


   :rtype: Promise <void>

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

unsetMetallicRoughness
----------------------

.. js:method:: MeshInstanceInterface.unsetMetallicRoughness( incs)

   :param incs: None
   :type incs: InstanceIncs


   :rtype: void

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

unsetOpacity
------------

.. js:method:: MeshInstanceInterface.unsetOpacity( incs, elementType)

   :param incs: None
   :type incs: InstanceIncs
   :param elementType: None
   :type elementType: ElementType


   :rtype: void

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

unsetSpecularColor
------------------

.. js:method:: MeshInstanceInterface.unsetSpecularColor( incs, elementType)

   :param incs: None
   :type incs: InstanceIncs
   :param elementType: None
   :type elementType: ElementType


   :rtype: void

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

unsetSpecularIntensity
----------------------

.. js:method:: MeshInstanceInterface.unsetSpecularIntensity( incs, elementType)

   :param incs: None
   :type incs: InstanceIncs
   :param elementType: None
   :type elementType: ElementType


   :rtype: void

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

unsetTexture
------------

.. js:method:: MeshInstanceInterface.unsetTexture( incs, elementType)

   :param incs: None
   :type incs: InstanceIncs
   :param elementType: None
   :type elementType: ElementType


   :rtype: void

