Editor.Components.CameraClearDepth
ClassThe same entity as in Lens Scripting.
Index
Properties
Methods
Example
const model = this.pluginSystem.findInterface(Editor.Model.IModel) as Editor.Model.IModel;
const scene = model.project.scene;
// Get the main camera and configure depth clearing
const cam = scene.mainCamera;
if (Editor.isNull(cam)) return;
const cd = cam.clearDepth;
// Clear depth to a specific value each frame
cd.mode = Editor.Components.CameraClearDepth.Mode.Value;
cd.value = 1.0;
console.log(`ClearDepth: mode=Value, value=${cd.value}`);
// Disable depth clearing
cd.mode = Editor.Components.CameraClearDepth.Mode.None;
console.log(`ClearDepth: mode=None (${cd.mode})`);
Extends
Properties
id
readonlyid:Uuid
The unique id of the entity.
Inherited from
input
input:
Texture
Texture to use when mode is set to Texture.
meta
readonlymeta:Meta
Metadata associated with this entity, providing access to its unique identifier and other descriptive properties.
Inherited from
mode
mode:
Mode
How depth clearing is performed.
type
readonlytype:string
The entity's type.
Inherited from
value
value:
number
Depth value to clear to when mode is set to Value.
Methods
getDirectlyReferencedEntities()
getDirectlyReferencedEntities():
Entity[]
A list of entities which this entity has a reference to.
Returns
Entity[]
Inherited from
EntityStructure.getDirectlyReferencedEntities
getMeta()
staticgetMeta():Meta
Returns metadata about this type.
Returns
Inherited from
getOwnedEntities()
getOwnedEntities():
Entity[]
A list of entities which has a reference to this entity.
Returns
Entity[]
Inherited from
EntityStructure.getOwnedEntities
getTypeName()
staticgetTypeName():string
Returns the type name of this class.
Returns
string
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 is of the specified type.
Parameters
| Parameter | Type |
|---|---|
type | string |
Returns
boolean
Inherited from
isSame()
isSame(
other):boolean
Returns true if this object refers to the same instance as the given object.
Parameters
| Parameter | Type |
|---|---|
other | ScriptObject |
Returns
boolean
Inherited from
staticMeta()
staticstaticMeta():Meta
Return metadata for CameraClearDepth.
Returns
See also
Nested types
Enumerations
| Enumeration | Description |
|---|---|
| Mode | The same entity as in Lens Scripting. |