PassPropertyOverrides
ClassOverrides the properties of one material pass on a single visual, without affecting other visuals that use the same material.
- Available on all platforms
Since Lens Scripting v304
Overrides the properties of one material pass on a single visual, without affecting other visuals that use the same material. Used with MaterialMeshVisual.
Set a property by assigning to it. Remove one property with delete, or by assigning undefined or null.
After a delete, 'name' in overrides is still true and reading the name gives undefined. Assigning the
name again sets it again. See PropertyOverrides for the Lens Scripting version each form needs.
Object.keys() on this object returns an empty array and spreading it copies nothing, so build a replacement
object from your Lens's own state.
Index
Methods
Example
//@input Component.MaterialMeshVisual visual
const overrides = script.visual.mainPassOverrides;
overrides.baseColor = new vec4(1, 0, 0, 1);
overrides.baseColor = undefined; // removes baseColor
overrides.baseColor = new vec4(0, 1, 0, 1);
delete overrides.baseColor; // removes baseColor
Extends
Indexable
[
index:string]:any
Methods
getTypeName()
staticgetTypeName():TypeName<PassPropertyOverrides>
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<PassPropertyOverrides>
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