@kieler/klighd-core/src/skgraph-model-renderer.ts

Core KLighD diagram visualization with Sprotty

/*
 * KIELER - Kiel Integrated Environment for Layout Eclipse RichClient
 *
 * http://rtsys.informatik.uni-kiel.de/kieler
 *
 * Copyright 2020-2025 by
 * + Kiel University
 *   + Department of Computer Science
 *     + Real-Time and Embedded Systems Group
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License 2.0 which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * SPDX-License-Identifier: EPL-2.0
 */

import { SKGraphElement } from '@kieler/klighd-interactive/lib/constraint-classes'
import { KlighdInteractiveMouseListener } from '@kieler/klighd-interactive/lib/klighd-interactive-mouselistener'
import Color = require('color')
import { VNode } from 'snabbdom'
import {
    IVNodePostprocessor,
    ModelRenderer,
    RenderingTargetKind,
    SModelElementImpl,
    SParentElementImpl,
    ViewRegistry,
} from 'sprotty'
import { Viewport } from 'sprotty-protocol'
import { RenderOptionsRegistry } from './options/render-options-registry'
import { EDGE_TYPE, KRenderingLibrary, LABEL_TYPE, NODE_TYPE, PORT_TYPE } from './skgraph-models'
import { TitleStorage } from './titles/title-storage'

/**
 * Contains additional data and functionality needed for the rendering of SKGraphs.
 */
export class SKGraphModelRenderer extends ModelRenderer {
    constructor(
        readonly viewRegistry: ViewRegistry,
        readonly targetKind: RenderingTargetKind,
        postprocessors: IVNodePostprocessor[]
    ) {
        super(viewRegistry, targetKind, postprocessors)
    }

    /**
     * The background color given by the synthesis, or undefined.
     */
    backgroundColor: Color | undefined

    /**
     * Map for all bounds related to KRenderingRefs, mapped by their rendering ID.
     */
    boundsMap: Record<string, unknown>

    /**
     * Map for all decoration data (bounds and rotation of decorators) related to KRenderingRefs, mapped by their rendering ID.
     */
    decorationMap: Record<string, unknown>

    /**
     * Access to the rendering library, expected to be defined on the root graph element.
     */
    kRenderingLibrary?: KRenderingLibrary

    mListener: KlighdInteractiveMouseListener

    renderingDefs: Map<string, VNode>

    renderOptionsRegistry: RenderOptionsRegistry

    /**
     * Storage for the title renderings
     */
    titleStorage: TitleStorage = new TitleStorage()

    viewport: Viewport

    /** Used to force rendering independant of smart zoom. Needed by the proxy-view. */
    forceRendering = false

    /**
     * Renders all children of the SKGraph that should be rendered within the child area of the element.
     *
     * @param element The element to render the children from.
     */
    renderChildAreaChildren(element: Readonly<SParentElementImpl> & SKGraphElement): VNode[] {
        element.areChildAreaChildrenRendered = true
        return element.children
            .filter((child) => child.type === NODE_TYPE || child.type === EDGE_TYPE)
            .map((child): VNode | undefined => this.renderElement(child))
            .filter((vnode) => vnode !== undefined) as VNode[]
    }

    /**
     * Renders all children of the SKGraph that should be rendered outside of the child area of the element.
     *
     * @param element The element to render the children from.
     */
    renderNonChildAreaChildren(element: Readonly<SParentElementImpl> & SKGraphElement): VNode[] {
        element.areNonChildAreaChildrenRendered = true
        return element.children
            .filter((child) => child.type === PORT_TYPE || child.type === LABEL_TYPE)
            .map((child): VNode | undefined => this.renderElement(child))
            .filter((vnode) => vnode !== undefined) as VNode[]
    }

    /** Renders an element forcefully, i.e. independant of smart zoom. */
    forceRenderElement(element: SKGraphElement): VNode | undefined {
        const prevForceRendering = this.forceRendering
        this.forceRendering = true
        const vnode = this.renderElement(element)
        this.forceRendering = prevForceRendering
        return vnode
    }

    /** @inheritdoc */
    renderElement(element: Readonly<SModelElementImpl>): VNode | undefined {
        this.titleStorage.decendToChild()
        const node = super.renderElement(element)
        this.titleStorage.ascendToParent()
        return node
    }
}