editor › Globals › PlaceholderDescriptor

Class: PlaceholderDescriptor

Changes the plate material and adds a hint

Hierarchy

• PlaceholderDescriptor

Implements

• IModelElement

Index

Properties

• anchor
• assembly
• changeEmitter
• hintIsShown
• hintText
• shouldBeSerialized
• showHintDuration

Methods

• destroy
• getAnchor
• getAssembly
• getChangeEventEmitter
• getElementsThisDependsOn
• getHintText
• getIsValid
• getShouldBeSerialized
• getShowHint
• getSurface
• setAnchor
• setAssembly
• setHintText
• setShouldBeSerialized
• showHint

Properties

Private anchor

• anchor: MeshSurfaceAnchor

Defined in src/model/data/Concepts/PlaceholderDescriptor.ts:13

---

Private assembly

• assembly: Assembly

Defined in src/model/data/Concepts/PlaceholderDescriptor.ts:14

---

Private changeEmitter

• changeEmitter: EventEmitter‹IModelElementEvent› = new EventEmitter()

Defined in src/model/data/Concepts/PlaceholderDescriptor.ts:15

---

Private hintIsShown

• hintIsShown: boolean = true

Defined in src/model/data/Concepts/PlaceholderDescriptor.ts:17

---

Private hintText

• hintText: string

Defined in src/model/data/Concepts/PlaceholderDescriptor.ts:16

---

Private shouldBeSerialized

• shouldBeSerialized: boolean = true

Defined in src/model/data/Concepts/PlaceholderDescriptor.ts:19

---

Private Readonly showHintDuration

• showHintDuration: number = Config.get("embedAsset.placeholderHintTime", 0)

Defined in src/model/data/Concepts/PlaceholderDescriptor.ts:18

Methods

destroy

▸ destroy(): void

Implementation of IModelElement

Defined in src/model/data/Concepts/PlaceholderDescriptor.ts:80

Returns: void

---

getAnchor

▸ getAnchor(): MeshSurfaceAnchor

Defined in src/model/data/Concepts/PlaceholderDescriptor.ts:29

Returns: MeshSurfaceAnchor

---

getAssembly

▸ getAssembly(): Assembly

Implementation of IModelElement

Defined in src/model/data/Concepts/PlaceholderDescriptor.ts:33

Returns: Assembly

---

getChangeEventEmitter

▸ getChangeEventEmitter(): IPublicEventEmitterInterface‹IModelElementEvent›

Implementation of IModelElement

Defined in src/model/data/Concepts/PlaceholderDescriptor.ts:64

Returns: IPublicEventEmitterInterface‹IModelElementEvent›

---

getElementsThisDependsOn

▸ getElementsThisDependsOn(): IModelElement[]

Implementation of IModelElement

Defined in src/model/data/Concepts/PlaceholderDescriptor.ts:68

Returns: IModelElement[]

---

getHintText

▸ getHintText(): string

Defined in src/model/data/Concepts/PlaceholderDescriptor.ts:41

Returns: string

---

getIsValid

▸ getIsValid(): boolean

Implementation of IModelElement

Defined in src/model/data/Concepts/PlaceholderDescriptor.ts:76

Returns: boolean

---

getShouldBeSerialized

▸ getShouldBeSerialized(): boolean

Defined in src/model/data/Concepts/PlaceholderDescriptor.ts:87

Returns: boolean

---

getShowHint

▸ getShowHint(): boolean

Defined in src/model/data/Concepts/PlaceholderDescriptor.ts:60

Returns: boolean

---

getSurface

▸ getSurface(): MeshSurface

Defined in src/model/data/Concepts/PlaceholderDescriptor.ts:45

Returns: MeshSurface

---

setAnchor

▸ setAnchor(anchor: MeshSurfaceAnchor): void

Defined in src/model/data/Concepts/PlaceholderDescriptor.ts:21

Parameters:

Name	Type
anchor	MeshSurfaceAnchor

Returns: void

---

setAssembly

▸ setAssembly(assembly: Assembly): void

Implementation of IModelElement

Defined in src/model/data/Concepts/PlaceholderDescriptor.ts:25

Parameters:

Name	Type
assembly	Assembly

Returns: void

---

setHintText

▸ setHintText(hintText: string): void

Defined in src/model/data/Concepts/PlaceholderDescriptor.ts:37

Parameters:

Name	Type
hintText	string

Returns: void

---

setShouldBeSerialized

▸ setShouldBeSerialized(value: boolean): void

Defined in src/model/data/Concepts/PlaceholderDescriptor.ts:91

Parameters:

Name	Type
value	boolean

Returns: void

---

showHint

▸ showHint(): void

Defined in src/model/data/Concepts/PlaceholderDescriptor.ts:52

Shows the placeholder hint for a limited amount of time

Returns: void