editor › Globals › BoxelCSGProgress

Class: BoxelCSGProgress

This class manages showing progress bars to the user. The CSG currently doesn't have any progress callbacks, so it takes the last operation duration as an indicator of how long the next one is going to take.

Hierarchy

• BoxelCSGProgress

Index

Constructors

• constructor

Properties

• fakeProgress
• initialTimeout
• message
• notificationController
• operationFinished
• progressId
• progressShown
• lastServerCSGOperationDuration

Methods

• _update
• cancelOperation
• endOperation
• finishOperation
• startOperation

Constructors

constructor

+ new BoxelCSGProgress(notificationController: any, boxelOperationId: string): BoxelCSGProgress

Defined in src/modules/kyub.core.boxel/src/BoxelCSGProgress.ts:19

Parameters:

Name	Type
notificationController	any
boxelOperationId	string

Returns: BoxelCSGProgress

Properties

Private Readonly fakeProgress

• fakeProgress: FakeProgress

Defined in src/modules/kyub.core.boxel/src/BoxelCSGProgress.ts:19

---

Private Readonly initialTimeout

• initialTimeout: any = Config.get("interaction.waitTimeUntilUserFeedback")

Defined in src/modules/kyub.core.boxel/src/BoxelCSGProgress.ts:14

---

Private Readonly message

• message: any = Config.get("csg.waitingMessageServerCsg")

Defined in src/modules/kyub.core.boxel/src/BoxelCSGProgress.ts:15

---

Private Readonly notificationController

• notificationController: any

Defined in src/modules/kyub.core.boxel/src/BoxelCSGProgress.ts:23

---

Private operationFinished

• operationFinished: boolean = false

Defined in src/modules/kyub.core.boxel/src/BoxelCSGProgress.ts:12

---

Private Readonly progressId

• progressId: string

Defined in src/modules/kyub.core.boxel/src/BoxelCSGProgress.ts:16

---

Private progressShown

• progressShown: boolean = false

Defined in src/modules/kyub.core.boxel/src/BoxelCSGProgress.ts:18

---

Static Private lastServerCSGOperationDuration

▪ lastServerCSGOperationDuration: any = Config.get("csg.serverTimeout")

Defined in src/modules/kyub.core.boxel/src/BoxelCSGProgress.ts:9

Methods

Private _update

▸ _update(): void

Defined in src/modules/kyub.core.boxel/src/BoxelCSGProgress.ts:65

Returns: void

---

cancelOperation

▸ cancelOperation(): void

Defined in src/modules/kyub.core.boxel/src/BoxelCSGProgress.ts:53

Returns: void

---

endOperation

▸ endOperation(): void

Defined in src/modules/kyub.core.boxel/src/BoxelCSGProgress.ts:60

Returns: void

---

finishOperation

▸ finishOperation(): void

Defined in src/modules/kyub.core.boxel/src/BoxelCSGProgress.ts:46

Returns: void

---

startOperation

▸ startOperation(): void

Defined in src/modules/kyub.core.boxel/src/BoxelCSGProgress.ts:33

Returns: void