Class TextureLayerGroup

Abstract parent class for texture layers and layer groups. In the future can be expanded for things like text or fx layers

Hierarchy (View Summary)

TextureLayerItem
- TextureLayerGroup

Index

Accessors

children parent selected

Constructors

Methods

addForEditing clickSelect extend getAllChildren getDepth getSaveCopy getUndoCopy propertiesDialog remove scrollTo select showContextMenu toggleVisibility registerType solveLayerOrder

Properties

folded menu? multi_selected name parent_uuid texture type uuid visible properties types

Accessors

children

get children(): TextureLayerItem[]
Returns TextureLayerItem[]
- Defined in types/generated/texturing/layers.d.ts:167

parent

get parent(): TextureLayerGroup
Returns TextureLayerGroup
Inherited from TextureLayerItem.parent
- Defined in types/generated/texturing/layers.d.ts:30
set parent(parent: TextureLayerGroup): void
Parameters
- parent: TextureLayerGroup
Returns void
Inherited from TextureLayerItem.parent
- Defined in types/generated/texturing/layers.d.ts:31

selected

get selected(): boolean
Returns boolean
Inherited from TextureLayerItem.selected
- Defined in types/generated/texturing/layers.d.ts:29

Constructors

constructor

new TextureLayerGroup(
    data: TextureLayerGroupData,
    texture?: Texture,
    uuid?: string,
): TextureLayerGroup
Parameters
- data: TextureLayerGroupData
- Optionaltexture: Texture
- Optionaluuid: string
Returns TextureLayerGroup
Overrides TextureLayerItem.constructor
- Defined in types/generated/texturing/layers.d.ts:166

Methods

addForEditing

addForEditing(): this
Add the layer to the associated texture above the previously selected layer, select this layer, and scroll the layer panel list to it

Returns this
Inherited from TextureLayerItem.addForEditing
- Defined in types/generated/texturing/layers.d.ts:45

clickSelect

clickSelect(event: MouseEvent): void
Parameters
- event: MouseEvent
Returns void
Inherited from TextureLayerItem.clickSelect
- Defined in types/generated/texturing/layers.d.ts:40

extend

extend(data: TextureLayerGroupData): void
Parameters
- data: TextureLayerGroupData
Returns void
Overrides TextureLayerItem.extend
- Defined in types/generated/texturing/layers.d.ts:168

getAllChildren

getAllChildren(): TextureLayerItem[]
Returns TextureLayerItem[]
- Defined in types/generated/texturing/layers.d.ts:171

getDepth

getDepth(): number
Returns number
Inherited from TextureLayerItem.getDepth
- Defined in types/generated/texturing/layers.d.ts:32

getSaveCopy

getSaveCopy(): TextureLayerGroupData
Returns TextureLayerGroupData
Overrides TextureLayerItem.getSaveCopy
- Defined in types/generated/texturing/layers.d.ts:170

getUndoCopy

getUndoCopy(): TextureLayerGroupData
Returns TextureLayerGroupData
Overrides TextureLayerItem.getUndoCopy
- Defined in types/generated/texturing/layers.d.ts:169

propertiesDialog

propertiesDialog(): void
Open the properties dialog

Returns void
Overrides TextureLayerItem.propertiesDialog
- Defined in types/generated/texturing/layers.d.ts:183

remove

remove(undo?: boolean): void
Remove the layer
Parameters
- Optionalundo: boolean
  Create an undo point and update the texture
Returns void
Inherited from TextureLayerItem.remove
- Defined in types/generated/texturing/layers.d.ts:54

scrollTo

scrollTo(): this
Scroll the layer panel list to

Returns this
Inherited from TextureLayerItem.scrollTo
- Defined in types/generated/texturing/layers.d.ts:49

select

select(multi_select?: boolean): void
Selects the layer
Parameters
- Optionalmulti_select: boolean
Returns void
Overrides TextureLayerItem.select
- Defined in types/generated/texturing/layers.d.ts:175

showContextMenu

showContextMenu(event: MouseEvent): void
Parameters
- event: MouseEvent
Returns void
Inherited from TextureLayerItem.showContextMenu
- Defined in types/generated/texturing/layers.d.ts:41

toggleVisibility

toggleVisibility(): this
Toggle layer groupvisibility. This creates an undo point

Returns this
- Defined in types/generated/texturing/layers.d.ts:179

`Static`registerType

registerType(id: string, constructor: any): void
Parameters
- id: string
- constructor: any
Returns void
Inherited from TextureLayerItem.registerType
- Defined in types/generated/texturing/layers.d.ts:65

`Static`solveLayerOrder

solveLayerOrder(list: TextureLayerItem[]): TextureLayerItem[]
Util function to update the order of layers of a texture to support the hierarchy. Returns a new array with the result
Parameters
- list: TextureLayerItem[]
Returns TextureLayerItem[]
Inherited from TextureLayerItem.solveLayerOrder
- Defined in types/generated/texturing/layers.d.ts:63

Properties

folded

folded: boolean

`Optional`menu

menu?: Menu

multi_selected

multi_selected: boolean

name

name: string

parent_uuid

parent_uuid: string

texture

texture: Texture

type

type: string

uuid

uuid: string

visible

visible: boolean

`Static`properties

properties: Record<string, Property<any>>

`Static`types

types: Record<string, any>