Editor.Model.Layers
ClassThe layers of a {@Editor.Assets.Scene}.
Index
Properties
Methods
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
readonlycanAdd:boolean
Check if another layer can be added to this entity.
combinedIds
readonlycombinedIds:LayerSet
The LayerSet which represents this entity.
id
readonlyid:Uuid
The unique id of the entity.
Inherited from
meta
readonlymeta:Meta
Metadata associated with this entity, providing access to its unique identifier and other descriptive properties.
Inherited from
type
readonlytype:string
The entity's type.
Inherited from
Methods
add()
add(
layerId):Layer
Add layerId to this entity.
Parameters
| Parameter | Type |
|---|---|
layerId | LayerId |
Returns
contains()
contains(
layerId):boolean
Whether the layers contain layerId.
Parameters
| Parameter | Type |
|---|---|
layerId | LayerId |
Returns
boolean
find()
find(
layerId):Layer
Get the layer with layerId if possible.
Parameters
| Parameter | Type |
|---|---|
layerId | LayerId |
Returns
getDirectlyReferencedEntities()
getDirectlyReferencedEntities():
Entity[]
A list of entities which this entity has a reference to.
Returns
Entity[]
Inherited from
Entity.getDirectlyReferencedEntities
getMeta()
staticgetMeta():Meta
Returns metadata about this type.
Returns
Overrides
getOwnedEntities()
getOwnedEntities():
Entity[]
A list of entities which has a reference to this entity.
Returns
Entity[]
Inherited from
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
remove()
remove(
layerId):void
Remove layerId from this entity.
Parameters
| Parameter | Type |
|---|---|
layerId | LayerId |
Returns
void