ChangeFlags Class
Beta
Viewport event synchronization flags. Used primarily for tracking changes that affect the viewport's FeatureSymbology.Overrides. Each time Viewport.renderFrame is invoked, the effects of any changes to these flags will be applied, and corresponding events dispatched. An individual flag is true if the corresponding Viewport state has changed and needs to be synchronized.
Methods
| Name | Description | |
|---|---|---|
| constructor(flags: ChangeFlag = ChangeFlag.Initial): ChangeFlags | ||
| areAllSet(flags: ChangeFlag): boolean | Return true if all of the specified flags are set. | |
| clear(flags: ChangeFlag = ChangeFlag.All): void | Clear all of the specified flags. | |
| isSet(flags: ChangeFlag): boolean | Return true if any of the specified flags are set. | |
| set(flags: ChangeFlag): void | Set all of the specified flags. | |
| setAlwaysDrawn(): void | ||
| setDisplayStyle(): void | ||
| setFeatureOverrideProvider(): void | ||
| setNeverDrawn(): void | ||
| setViewState(): void | ||
| setViewedCategories(): void | ||
| setViewedCategoriesPerModel(): void | ||
| setViewedModels(): void |
Properties
| Name | Type | Description | |
|---|---|---|---|
| alwaysDrawn Accessor ReadOnly | boolean | The set of always drawn elements has changed. | |
| areFeatureOverridesDirty Accessor ReadOnly | boolean | Returns true if any flag affecting FeatureSymbology.Overrides is set. | |
| displayStyle Accessor ReadOnly | boolean | The display style or its settings such as ViewFlags have changed. | |
| featureOverrideProvider Accessor ReadOnly | boolean | The ChangeFlags.FeatureOverrideProvider has changed, or its internal state has changed such that its overrides must be recomputed. | |
| hasChanges Accessor ReadOnly | boolean | Returns true if any flag is set. | |
| neverDrawn Accessor ReadOnly | boolean | The set of never drawn elements has changed. | |
| value Accessor ReadOnly | ChangeFlag | ||
| viewedCategories Accessor ReadOnly | boolean | The set of displayed categories has changed. | |
| viewedModels Accessor ReadOnly | boolean | The set of displayed models has changed. | |
| viewState Accessor ReadOnly | boolean | ChangeFlags.changeView was used to replace the previous ChangeFlags.ViewState with a new one. |
Defined in
Last Updated: 08 January, 2020