Skip to main content

Editor.Components.CameraClearColor

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 its clear color
const cam = scene.mainCamera;
if (Editor.isNull(cam)) return;

const cc = cam.clearColor;

// Set to clear with a solid color (sky blue)
cc.mode = Editor.Components.CameraClearColor.Mode.Color;
cc.color = new vec4(0.5, 0.7, 1.0, 1.0);
console.log(`ClearColor: mode=Color, rgba=(${cc.color.x}, ${cc.color.y}, ${cc.color.z}, ${cc.color.w})`);

// Switch to no clearing
cc.mode = Editor.Components.CameraClearColor.Mode.None;
console.log(`ClearColor: mode=None (${cc.mode})`);

Extends

Properties

color

color: vec4

Clear color as a vec4 RGBA value.


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 the camera background is cleared.


type

readonly type: string

The entity's type.

Inherited from

EntityStructure.type

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 CameraClearColor.

Returns

Meta

See also

Editor.Components.Camera.

Nested types

Enumerations

EnumerationDescription
ModeThe same entity as in Lens Scripting.