MeshInstanceData
- class Communicator.MeshInstanceData()
Object representing a Mesh instance that will be created by the client at run time. This class allows for the specification of instance specific properties of a mesh.
Constructors
Methods
Constructors
- MeshInstanceData.constructor([meshId[, matrix[, instanceName[, faceColor[, lineColor[, pointColor[, creationFlags]]]]]]])
Creates a new MeshInstanceData object.
- Arguments
- Return type
Methods
clear
- MeshInstanceData.clear()
Resets all fields of this object.
- Return type
void
copy
- MeshInstanceData.copy()
Creates a copy of this MeshInstanceData.
- Return type
- Returns
Copy of this MeshInstanceData object.
getCreationFlags
- MeshInstanceData.getCreationFlags()
Gets the mesh instance creation flags (SuppressCameraScale, DoNotExplode, DoNotLight…)
- Return type
- Returns
the mesh instance creation flags (null if none set)
getFaceColor
getInstanceName
- MeshInstanceData.getInstanceName()
Gets the name that will be applied to the instance.
- Return type
string | null
- Returns
the instance name.
getLineColor
getLineOpacity
- MeshInstanceData.getLineOpacity()
Gets the line opacity value for this instance.
- Return type
number
- Returns
the line opacity value for this instance.
getMatrix
getMeshId
getMeshKey
getOpacity
- MeshInstanceData.getOpacity()
Gets the face opacity value for this instance.
- Return type
number
- Returns
the face opacity value for this instance.
getOverlayIndex
- MeshInstanceData.getOverlayIndex()
Gets the overlay index for this instance.
- Return type
- Returns
the overlay index for this instance.
getPointColor
getPointOpacity
- MeshInstanceData.getPointOpacity()
Gets the point opacity value for this instance.
- Return type
number
- Returns
the point opacity value for this instance.
getTransparency
- MeshInstanceData.getTransparency()
- Deprecated
use
getOpacity
instead.- Return type
number
setCreationFlags
- MeshInstanceData.setCreationFlags(flags)
Sets the mesh instance creation flags (SuppressCameraScale, DoNotExplode, DoNotLight…)
- Arguments
flags (MeshInstanceCreationFlags) – creation flags
- Return type
void
setFaceColor
setInstanceName
- MeshInstanceData.setInstanceName(instanceName)
Sets the name that will be assigned to this instance. This name will be visible when querying the model hierarchy.
- Arguments
instanceName (
string()
) – the name to assign to this instance.
- Return type
void
setLineColor
setLineOpacity
- MeshInstanceData.setLineOpacity(lineOpacity)
Sets the line opacity for this instance.
- Arguments
lineOpacity (
number()
) – opacity value to set.
- Return type
void
setMatrix
setMeshId
setMeshKey
setOpacity
- MeshInstanceData.setOpacity(faceOpacity)
Sets the face opacity for this instance.
- Arguments
faceOpacity (
number()
) – opacity value to set.
- Return type
void
setOverlayIndex
- MeshInstanceData.setOverlayIndex(overlayIndex)
Sets the overlay index for this instance.
- Arguments
overlayIndex (OverlayIndex) – overlay index to set.
- Return type
void
setPointColor
setPointOpacity
- MeshInstanceData.setPointOpacity(pointOpacity)
Sets the point opacity for this instance.
- Arguments
pointOpacity (
number()
) – opacity value to set.
- Return type
void
setTransparency
- MeshInstanceData.setTransparency(transparency)
- Deprecated
use
setOpacity
instead.- Arguments
transparency (
number()
) –
- Return type
void