playcanvas/build/playcanvas.dbg/src/framework/components/scroll-view/system.js

PlayCanvas WebGL game engine

import { Vec2 } from '../../../core/math/vec2.js';
import { ComponentSystem } from '../system.js';
import { ScrollViewComponent } from './component.js';
import { ScrollViewComponentData } from './data.js';

/**
 * @import { AppBase } from '../../app-base.js'
 */ const _schema = [
    {
        name: 'enabled',
        type: 'boolean'
    },
    {
        name: 'horizontal',
        type: 'boolean'
    },
    {
        name: 'vertical',
        type: 'boolean'
    },
    {
        name: 'scrollMode',
        type: 'number'
    },
    {
        name: 'bounceAmount',
        type: 'number'
    },
    {
        name: 'friction',
        type: 'number'
    },
    {
        name: 'dragThreshold',
        type: 'number'
    },
    {
        name: 'useMouseWheel',
        type: 'boolean'
    },
    {
        name: 'mouseWheelSensitivity',
        type: 'vec2'
    },
    {
        name: 'horizontalScrollbarVisibility',
        type: 'number'
    },
    {
        name: 'verticalScrollbarVisibility',
        type: 'number'
    }
];
const DEFAULT_DRAG_THRESHOLD = 10;
/**
 * Manages creation of {@link ScrollViewComponent}s.
 *
 * @category User Interface
 */ class ScrollViewComponentSystem extends ComponentSystem {
    /**
     * Create a new ScrollViewComponentSystem instance.
     *
     * @param {AppBase} app - The application.
     * @ignore
     */ constructor(app){
        super(app);
        this.id = 'scrollview';
        this.ComponentType = ScrollViewComponent;
        this.DataType = ScrollViewComponentData;
        this.schema = _schema;
        this.on('beforeremove', this._onRemoveComponent, this);
        this.app.systems.on('update', this.onUpdate, this);
    }
    initializeComponentData(component, data, properties) {
        if (data.dragThreshold === undefined) {
            data.dragThreshold = DEFAULT_DRAG_THRESHOLD;
        }
        if (data.useMouseWheel === undefined) {
            data.useMouseWheel = true;
        }
        if (data.mouseWheelSensitivity === undefined) {
            data.mouseWheelSensitivity = new Vec2(1, 1);
        }
        super.initializeComponentData(component, data, _schema);
        component.viewportEntity = data.viewportEntity;
        component.contentEntity = data.contentEntity;
        component.horizontalScrollbarEntity = data.horizontalScrollbarEntity;
        component.verticalScrollbarEntity = data.verticalScrollbarEntity;
    }
    onUpdate(dt) {
        const components = this.store;
        for(const id in components){
            const entity = components[id].entity;
            const component = entity.scrollview;
            if (component.enabled && entity.enabled) {
                component.onUpdate();
            }
        }
    }
    _onRemoveComponent(entity, component) {
        component.onRemove();
    }
    destroy() {
        super.destroy();
        this.app.systems.off('update', this.onUpdate, this);
    }
}

export { ScrollViewComponentSystem };