Skip to main content

Editor.Model.Layers

Class

The layers of a {@Editor.Assets.Scene}.

Index

Example

const model = this.pluginSystem.findInterface(Editor.Model.IModel) as Editor.Model.IModel;
const scene = model.project.scene;
const layers = scene.layers;

console.log(`Can add new layers: ${layers.canAdd}`);

const combinedIds = layers.combinedIds;
const idArray = combinedIds.toArray();
console.log(`Combined layer count: ${idArray.length}`);

for (const id of idArray) {
const layer = layers.find(id);
if (!Editor.isNull(layer)) {
console.log(` Layer "${layer.name}" — id: ${layer.id}`);
}
}

const defaultId = Editor.Model.LayerId.Default;
const hasDefault = layers.contains(defaultId);
console.log(`Contains default layer: ${hasDefault}`);

Extends

Properties

canAdd

readonly canAdd: boolean

Check if another layer can be added to this entity.


combinedIds

readonly combinedIds: LayerSet

The LayerSet which represents this entity.


id

readonly id: Uuid

The unique id of the entity.

Inherited from

Entity.id


meta

readonly meta: Meta

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

Inherited from

Entity.meta


type

readonly type: string

The entity's type.

Inherited from

Entity.type

Methods

add()

add(layerId): Layer

Add layerId to this entity.

Parameters

ParameterType
layerIdLayerId

Returns

Layer


contains()

contains(layerId): boolean

Whether the layers contain layerId.

Parameters

ParameterType
layerIdLayerId

Returns

boolean


find()

find(layerId): Layer

Get the layer with layerId if possible.

Parameters

ParameterType
layerIdLayerId

Returns

Layer


getDirectlyReferencedEntities()

getDirectlyReferencedEntities(): Entity[]

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

Returns

Entity[]

Inherited from

Entity.getDirectlyReferencedEntities


getMeta()

static getMeta(): Meta

Returns metadata about this type.

Returns

Meta

Overrides

Entity.getMeta


getOwnedEntities()

getOwnedEntities(): Entity[]

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

Returns

Entity[]

Inherited from

Entity.getOwnedEntities


getTypeName()

static getTypeName(): string

Returns the type name of this class.

Returns

string

Overrides

Entity.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

Entity.getTypeName


isOfType()

isOfType(type): boolean

Returns true if the object is of the specified type.

Parameters

ParameterType
typestring

Returns

boolean

Inherited from

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

Entity.isSame


remove()

remove(layerId): void

Remove layerId from this entity.

Parameters

ParameterType
layerIdLayerId

Returns

void