Skip to main content

Editor.Components.CameraClearDepth

Class

The same entity as in Lens Scripting.

Index

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

readonly id: Uuid

The unique id of the entity.

Inherited from

EntityStructure.id


input

input: Texture

Texture to use when mode is set to Texture.


meta

readonly meta: Meta

Metadata associated with this entity, providing access to its unique identifier and other descriptive properties.

Inherited from

EntityStructure.meta


mode

mode: Mode

How depth clearing is performed.


type

readonly type: string

The entity's type.

Inherited from

EntityStructure.type


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()

static getMeta(): Meta

Returns metadata about this type.

Returns

Meta

Inherited from

EntityStructure.getMeta


getOwnedEntities()

getOwnedEntities(): Entity[]

A list of entities which has a reference to this entity.

Returns

Entity[]

Inherited from

EntityStructure.getOwnedEntities


getTypeName()

static getTypeName(): string

Returns the type name of this class.

Returns

string

Overrides

EntityStructure.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

EntityStructure.getTypeName


isOfType()

isOfType(type): boolean

Returns true if the object is of the specified type.

Parameters

ParameterType
typestring

Returns

boolean

Inherited from

EntityStructure.isOfType


isSame()

isSame(other): boolean

Returns true if this object refers to the same instance as the given object.

Parameters

ParameterType
otherScriptObject

Returns

boolean

Inherited from

EntityStructure.isSame


staticMeta()

static staticMeta(): Meta

Return metadata for CameraClearDepth.

Returns

Meta

See also

Editor.Components.Camera.

Nested types

Enumerations

EnumerationDescription
ModeThe same entity as in Lens Scripting.