Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Robustify and simplify View.has_finished() logic #13801

Open
wants to merge 2 commits into
base: branch-3.5
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
30 changes: 25 additions & 5 deletions bokehjs/src/lib/core/view.ts
Original file line number Diff line number Diff line change
Expand Up @@ -106,15 +106,39 @@ export class View implements ISignalable {

protected _has_finished: boolean = false

mark_finished(): void {
has_finished(): boolean {
if (!this._has_finished) {
return false
}

for (const child of this.children()) {
if (!child.has_finished()) {
return false
}
}

return true
}

mark_finished(recursive: boolean = false): void {
this._has_finished = true

if (recursive) {
for (const child of this.children()) {
child.mark_finished(recursive)
}
}
}

/**
* Mark as finished even if e.g. external resources were not loaded yet.
*/
force_finished(): void {
this.mark_finished()

for (const child of this.children()) {
child.force_finished()
}
}

finish(): void {
Expand Down Expand Up @@ -153,10 +177,6 @@ export class View implements ISignalable {
return this.parent == null
}

has_finished(): boolean {
return this._has_finished
}

get is_idle(): boolean {
return this.has_finished()
}
Expand Down
3 changes: 3 additions & 0 deletions bokehjs/src/lib/models/annotations/arrow.ts
Original file line number Diff line number Diff line change
Expand Up @@ -194,6 +194,9 @@ export class ArrowView extends DataAnnotationView {

ctx.restore()
}

this.start?.mark_finished()
this.end?.mark_finished()
}
}

Expand Down
2 changes: 2 additions & 0 deletions bokehjs/src/lib/models/annotations/contour_color_bar.ts
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@ export class ContourColorBarView extends BaseColorBarView {
}
ctx.restore()
}
this._fill_view.force_finished() // MultiPolygonsView.paint() wasn't called

const multi_line = this._line_view.glyph as MultiLineView
const nline = multi_line.data_size
Expand All @@ -96,6 +97,7 @@ export class ContourColorBarView extends BaseColorBarView {
}
ctx.restore()
}
this._line_view.force_finished() // MultiLineView.paint() wasn't called
}
}

Expand Down
12 changes: 0 additions & 12 deletions bokehjs/src/lib/models/annotations/text_annotation.ts
Original file line number Diff line number Diff line change
Expand Up @@ -65,18 +65,6 @@ export abstract class TextAnnotationView extends AnnotationView {
super.remove()
}

override has_finished(): boolean {
if (!super.has_finished()) {
return false
}

if (!this._text_view.has_finished()) {
return false
}

return true
}

override get displayed(): boolean {
return super.displayed && this._text_view.model.text != "" && this.visuals.text.doit
}
Expand Down
4 changes: 0 additions & 4 deletions bokehjs/src/lib/models/annotations/toolbar_panel.ts
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,6 @@ export class ToolbarPanelView extends AnnotationView {
this.toolbar_view.after_render()
}

override has_finished(): boolean {
return super.has_finished() && this.toolbar_view.has_finished()
}

override *children(): IterViews {
yield* super.children()
yield this.toolbar_view
Expand Down
4 changes: 4 additions & 0 deletions bokehjs/src/lib/models/annotations/whisker.ts
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,8 @@ export class WhiskerView extends UpperLowerView {
this.lower_head.paint(ctx, i)
ctx.restore()
}

this.lower_head.mark_finished()
}

if (this.upper_head != null) {
Expand All @@ -78,6 +80,8 @@ export class WhiskerView extends UpperLowerView {
this.upper_head.paint(ctx, i)
ctx.restore()
}

this.upper_head.mark_finished()
}
}
}
Expand Down
20 changes: 0 additions & 20 deletions bokehjs/src/lib/models/axes/axis.ts
Original file line number Diff line number Diff line change
Expand Up @@ -713,26 +713,6 @@ export class AxisView extends GuideRendererView {

super.remove()
}

override has_finished(): boolean {
if (!super.has_finished()) {
return false
}

if (this._axis_label_view != null) {
if (!this._axis_label_view.has_finished()) {
return false
}
}

for (const label_view of this._major_label_views.values()) {
if (!label_view.has_finished()) {
return false
}
}

return true
}
}

export namespace Axis {
Expand Down
10 changes: 2 additions & 8 deletions bokehjs/src/lib/models/glyphs/glyph.ts
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,8 @@ export abstract class GlyphView extends DOMComponentView {
const cls = await this.load_glglyph() as BaseGLGlyphConstructor
this.glglyph = new cls(webgl.regl_wrapper, this)
}

this.mark_finished()
}

request_paint(): void {
Expand All @@ -130,14 +132,6 @@ export abstract class GlyphView extends DOMComponentView {

protected abstract _paint(ctx: Context2d, indices: number[], data?: Glyph.Data): void

override has_finished(): boolean {
return true
}

override notify_finished(): void {
this.renderer.notify_finished()
}

protected _bounds(bounds: Rect): Rect {
return bounds
}
Expand Down
1 change: 1 addition & 0 deletions bokehjs/src/lib/models/glyphs/image_url.ts
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ export class ImageURLView extends XYGlyphView {

protected override _set_data(): void {
if (this.inherited_url) {
this._images_rendered = true
return
}

Expand Down
14 changes: 0 additions & 14 deletions bokehjs/src/lib/models/glyphs/math_text_glyph.ts
Original file line number Diff line number Diff line change
Expand Up @@ -25,20 +25,6 @@ export abstract class MathTextGlyphView extends TextView {
yield* this._label_views.values()
}

override has_finished(): boolean {
if (!super.has_finished()) {
return false
}

for (const view of this._label_views.values()) {
if (!view.has_finished()) {
return false
}
}

return true
}

protected abstract _build_label(text: string): BaseText

protected override async _build_labels(): Promise<void> {
Expand Down
1 change: 1 addition & 0 deletions bokehjs/src/lib/models/graphics/decoration.ts
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ export class DecorationView extends View {
override async lazy_initialize(): Promise<void> {
await super.lazy_initialize()
this.marking = await build_view(this.model.marking, {parent: this.parent})
this.mark_finished()
}
}

Expand Down
1 change: 1 addition & 0 deletions bokehjs/src/lib/models/graphics/marking.ts
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ export abstract class MarkingView extends DOMComponentView implements visuals.Pa
const uniform = prop.uniform(source).select(indices)
self[`${prop.attr}`] = uniform
}
this.mark_finished()
}

abstract paint(ctx: Context2d, i: number): void
Expand Down
16 changes: 1 addition & 15 deletions bokehjs/src/lib/models/layouts/layout_dom.ts
Original file line number Diff line number Diff line change
Expand Up @@ -465,21 +465,7 @@ export abstract class LayoutDOMView extends PaneView {
}

override has_finished(): boolean {
if (!super.has_finished()) {
return false
}

if (this.is_layout_root && !this._layout_computed) {
return false
}

for (const child_view of this.child_views) {
if (!child_view.has_finished()) {
return false
}
}

return true
return super.has_finished() && (!this.is_layout_root || this._layout_computed)
}

override box_sizing(): DOMBoxSizing {
Expand Down
16 changes: 0 additions & 16 deletions bokehjs/src/lib/models/plots/plot_canvas.ts
Original file line number Diff line number Diff line change
Expand Up @@ -886,22 +886,6 @@ export class PlotView extends LayoutDOMView implements Paintable {
})
}

override has_finished(): boolean {
if (!super.has_finished()) {
return false
}

if (this.model.visible) {
for (const [, renderer_view] of this.renderer_views) {
if (!renderer_view.has_finished()) {
return false
}
}
}

return true
}

override _after_layout(): void {
super._after_layout()
this.unpause(true)
Expand Down
20 changes: 0 additions & 20 deletions bokehjs/src/lib/models/renderers/composite_renderer.ts
Original file line number Diff line number Diff line change
Expand Up @@ -104,26 +104,6 @@ export abstract class CompositeRendererView extends RendererView {
element_view.reposition(displayed)
}
}

override has_finished(): boolean {
if (!super.has_finished()) {
return false
}

for (const renderer_view of this.renderer_views) {
if (!renderer_view.has_finished()) {
return false
}
}

for (const element_view of this.element_views) {
if (!element_view.has_finished()) {
return false
}
}

return true
}
}

export namespace CompositeRenderer {
Expand Down
10 changes: 10 additions & 0 deletions bokehjs/src/lib/models/renderers/glyph_renderer.ts
Original file line number Diff line number Diff line change
Expand Up @@ -328,6 +328,16 @@ export class GlyphRendererView extends DataRendererView {
return this.glyph.has_webgl
}

override paint(): void {
super.paint()

this.decimated_glyph.force_finished()
this.selection_glyph.force_finished()
this.nonselection_glyph.force_finished()
this.hover_glyph?.force_finished()
this.muted_glyph.force_finished()
}

protected _paint(): void {
const {has_webgl} = this

Expand Down
4 changes: 0 additions & 4 deletions bokehjs/src/lib/models/renderers/renderer.ts
Original file line number Diff line number Diff line change
Expand Up @@ -134,10 +134,6 @@ export abstract class RendererView extends StyledElementView implements visuals.
this.plot_view.request_layout()
}

override notify_finished(): void {
this.plot_view.notify_finished()
}

notify_finished_after_paint(): void {
this.plot_view.notify_finished_after_paint()
}
Expand Down
1 change: 1 addition & 0 deletions bokehjs/src/lib/models/sources/cds_view.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ export class CDSViewView extends View {
override initialize(): void {
super.initialize()
this.compute_indices()
this.mark_finished()
}

override connect_signals(): void {
Expand Down
5 changes: 5 additions & 0 deletions bokehjs/src/lib/models/tools/tool.ts
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,11 @@ export type EventRole = EventType | "multi"
export abstract class ToolView extends View {
declare model: Tool

override initialize(): void {
super.initialize()
this._has_finished = true
}

override connect_signals(): void {
super.connect_signals()
this.connect(this.model.properties.active.change, () => {
Expand Down
14 changes: 0 additions & 14 deletions bokehjs/src/lib/models/tools/toolbar.ts
Original file line number Diff line number Diff line change
Expand Up @@ -54,20 +54,6 @@ export class ToolbarView extends UIElementView {
yield* this._tool_button_views.values()
}

override has_finished(): boolean {
if (!super.has_finished()) {
return false
}

for (const child_view of this._tool_button_views.values()) {
if (!child_view.has_finished()) {
return false
}
}

return true
}

override initialize(): void {
super.initialize()

Expand Down
4 changes: 4 additions & 0 deletions bokehjs/src/lib/models/ui/dialog.ts
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,10 @@ export class DialogView extends UIElementView {

this._title = await build_view(title, {parent: this})
this._content = await build_view(content, {parent: this})

if (!this.model.visible) {
this.force_finished()
}
}

override connect_signals(): void {
Expand Down
14 changes: 0 additions & 14 deletions bokehjs/src/lib/models/ui/pane.ts
Original file line number Diff line number Diff line change
Expand Up @@ -78,20 +78,6 @@ export class PaneView extends UIElementView {
element_view.render_to(this.shadow_el)
}
}

override has_finished(): boolean {
if (!super.has_finished()) {
return false
}

for (const element_view of this.element_views) {
if (!element_view.has_finished()) {
return false
}
}

return true
}
}

export namespace Pane {
Expand Down