MaterialMeshVisual
ClassInherits from BaseMeshVisual and provides access to the Material used in the rendering process.
- Available on all platforms
Since Lens Scripting v304
Index
Properties
Methods
Example
// @input Component.MaterialMeshVisual visual
// Set the material's main color to red
script.visual.mainPass.baseColor = new vec4(1, 0, 0, 1);
Extends
Extended by
PostEffectVisualText3DRetouchVisualRenderMeshVisualImageGaussianSplattingVisualFaceMaskVisualFaceInsetVisualEyeColorVisualClothVisualSpriteVisual
Properties
enabled
enabled:
boolean
If disabled, the Component will stop enacting its behavior.
Default Value
true
Inherited from
extentsTarget
extentsTarget:
ScreenTransform
When a ScreenTransform is present on this SceneObject,
and extentsTarget is a child of this SceneObject, extentsTarget will be repositioned to match the exact
area this MeshVisual is being rendered. Very useful for Image and Text components.
Default Value
null
Inherited from
horizontalAlignment
horizontalAlignment:
HorizontalAlignment
When a ScreenTransform is attached to the same SceneObject, this controls how the mesh will be positioned horizontally depending on stretchMode.
Default Value
HorizontalAlignment.Center
Inherited from
BaseMeshVisual.horizontalAlignment
isBeingDestroyed
readonlyisBeingDestroyed:boolean
Returns true if this Component is currently being destroyed. Becomes true as soon as
destruction begins via Component#destroy or destruction of its owning SceneObject,
before any OnDestroyEvent callbacks fire.
Since
Lens Scripting Version 364
Example
if (!script.isBeingDestroyed) {
// Component is still fully alive
}
Inherited from
BaseMeshVisual.isBeingDestroyed
isEnabledInHierarchy
readonlyisEnabledInHierarchy:boolean
Returns true if this Component, its SceneObject, and all of that SceneObjects parents are enabled.
Inherited from
BaseMeshVisual.isEnabledInHierarchy
mainMaterial
mainMaterial:
Material
Returns the first Material.
Since
Lens Scripting Version 304
Default Value
null
mainPass
mainPass:
Pass
Returns the mainPass of the mainMaterial.
Since
Lens Scripting Version 304
Default Value
null
materials
materials:
Material[]
Get the array of materials used by the MaterialMeshVisual.
Since
Lens Scripting Version 304
Default Value
[]
meshShadowMode
meshShadowMode:
MeshShadowMode
None = 0, Caster = 1, Receiver = 2
Default Value
MeshShadowMode.None
Inherited from
propertyOverrides
readonlypropertyOverrides:PropertyOverrides
Overrides the property on the material, without affecting other visuals referencing the same material. See PropertyOverrides.
Since
Lens Scripting Version 304
renderOrder
renderOrder:
number
The order in which the visual should be rendered.
Since
Lens Scripting Version 323
Default Value
0
Inherited from
sceneObject
readonlysceneObject:SceneObject
The SceneObject this component is on.
Inherited from
shadowColor
shadowColor:
vec4
Affects the color of shadows being cast by this MeshVisual. The color of the cast shadow is a mix between shadowColor and the material's base texture color. The alpha value of shadowColor controls the mixing of these two colors, with 0 = shadowColor and 1 = shadowColor * textureColor.
Default Value
(1, 1, 1, 1)
Inherited from
shadowDensity
shadowDensity:
number
Density of shadows cast by this MeshVisual.
Default Value
1
Inherited from
stretchMode
stretchMode:
StretchMode
When a ScreenTransform is attached to the same SceneObject, this controls how the mesh will be stretched relative to the ScreenTransform's boundaries.
Default Value
StretchMode.Stretch
Inherited from
uniqueIdentifier
readonlyuniqueIdentifier:string
Since
Lens Scripting Version 176
Inherited from
BaseMeshVisual.uniqueIdentifier
verticalAlignment
verticalAlignment:
VerticalAlignment
When a ScreenTransform is attached to the same SceneObject, this controls how the mesh will be positioned vertically depending on stretchMode.
Default Value
VerticalAlignment.Center
Inherited from
BaseMeshVisual.verticalAlignment
Accessors
mainPassOverrides
Get Signature
get mainPassOverrides():
PassPropertyOverrides
Overrides the mainPass on the material, without affecting other visuals referencing the same material. Reads give a PassPropertyOverrides. See PropertyOverrides.
Since
Lens Scripting Version 304
Default Value
{}
Returns
Set Signature
set mainPassOverrides(
value):void
Parameters
| Parameter | Type |
|---|---|
value | PassPropertyOverrides | {[key: string]: any; } |
Returns
void
Methods
addMaterial()
addMaterial(
material):void
Adds a Material to use for rendering.
Parameters
| Parameter | Type |
|---|---|
material | Material |
Returns
void
Since
Lens Scripting Version 304
clearMaterials()
clearMaterials():
void
Clears all Materials.
Returns
void
Since
Lens Scripting Version 304
destroy()
destroy():
void
Destroys the component.
Returns
void
Inherited from
getMaterial()
getMaterial(
index):Material
Returns the Material at index index.
Parameters
| Parameter | Type |
|---|---|
index | number |
Returns
Since
Lens Scripting Version 304
getMaterialsCount()
getMaterialsCount():
number
Returns the number of Materials used for rendering.
Returns
number
Since
Lens Scripting Version 304
getRenderOrder()
getRenderOrder():
number
Returns the order of this Visual in the render queue.
Returns
number
Inherited from
getSceneObject()
getSceneObject():
SceneObject
Returns the SceneObject the component is attached to.
Returns
Inherited from
getTransform()
getTransform():
Transform
Returns the Transform this component is attached to.
Returns
Inherited from
getTypeName()
staticgetTypeName():TypeName<MaterialMeshVisual>
Returns the fully-qualified JavaScript type name for this class (for example, "Component.Camera"). This is a static accessor (no instance required) and returns the same value as the instance getTypeName().
Returns
TypeName<MaterialMeshVisual>
Since
Lens Scripting Version 304
Overrides
getTypeName()
getTypeName():
string
Returns the name of this object's type.
Returns
string
Inherited from
isOfType()
isOfType(
type):boolean
Returns true if the object matches or derives from the passed in type.
Parameters
| Parameter | Type |
|---|---|
type | string |
Returns
boolean
Inherited from
isSame()
isSame(
other):boolean
Returns true if this object is the same as other. Useful for checking if two references point to the same thing.
Parameters
| Parameter | Type |
|---|---|
other | ScriptObject |
Returns
boolean
Inherited from
localAabbMax()
localAabbMax():
vec3
Range maximum of the local-space axis-aligned bounding box (AABB) of the visual.
Returns
Since
Lens Scripting Version 156
Inherited from
localAabbMin()
localAabbMin():
vec3
Range minimum of the local-space axis-aligned bounding box (AABB) of the visual.
Returns
Since
Lens Scripting Version 156
Inherited from
setRenderOrder()
setRenderOrder(
value):void
Sets the order of this Visual in the render queue.
Parameters
| Parameter | Type |
|---|---|
value | number |
Returns
void
Inherited from
snap()
snap(
camera):void
Projects screen positions from camera's view onto the mesh's UVs.
If the MeshVisual's material uses the same texture as the camera input, the MeshVisual will look identical to the part of the screen it covers.
Parameters
| Parameter | Type |
|---|---|
camera | Camera |
Returns
void
Inherited from
worldAabbMax()
worldAabbMax():
vec3
Range maximum of the world-space axis-aligned bounding box (AABB) of the visual.
Returns
Since
Lens Scripting Version 156
Inherited from
worldAabbMin()
worldAabbMin():
vec3
Range minimum of the world-space axis-aligned bounding box (AABB) of the visual.
Returns
Since
Lens Scripting Version 156