satie/src/implDirection_dynamicsView.ts

A sheet music renderer for the web

/**
 * This file is part of Satie music engraver <https://github.com/jnetterf/satie>.
 * Copyright (C) Joshua Netterfield <joshua.ca> 2015 - present.
 * 
 * Satie is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 * 
 * Satie is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 * 
 * You should have received a copy of the GNU Affero General Public License
 * along with Satie.  If not, see <http://www.gnu.org/licenses/>.
 */

import {Dynamics, Direction} from "musicxml-interfaces";
import {createFactory, ReactElement, Component, PropTypes} from "react";
import {filter} from "lodash";
import * as invariant from "invariant";

import Glyph from "./private_views_glyph";

const $Glyph = createFactory(Glyph);

export interface IProps {
    layout: {model: Direction, overrideX?: number};
    key?: string | number;
}

export default class DynamicsView extends Component<IProps, {}> {
    static contextTypes = <any> {
        originY: PropTypes.number
    };

    context: {
        originY: number;
    };

    render(): ReactElement<any> {
        let layout = this.props.layout;
        let model = layout.model;
        let dynamicsContainer = filter(model.directionTypes, dt => dt.dynamics)[0];
        invariant(!!dynamicsContainer, "No dynamics found!");
        let dynamics = dynamicsContainer.dynamics;

        let initX = this.props.layout.overrideX + dynamics.defaultX + (dynamics.relativeX || 0);
        let initY = (this.context.originY || 0) - dynamics.defaultY - (dynamics.relativeY || 0);

        let glyphName = this.getGlyphName(dynamics);
        if (!glyphName) {
            return null;
        }

        return $Glyph({
            fill: dynamics.color || "black",
            glyphName: glyphName,
            x: initX,
            y: initY
        });
    }

    getGlyphName(dynamics: Dynamics) {
        /* Not included in MusicXML:

          "dynamicMessaDiVoce": "U+E540",
          "dynamicMezzo": "U+E521",
          "dynamicNiente": "U+E526",
          "dynamicNienteForHairpin": "U+E541",
          "dynamicPF": "U+E52E",
          "dynamicRinforzando": "U+E523",
          "dynamicSforzando": "U+E524",
          "dynamicSforzatoPiano": "U+E53A",
          "dynamicZ": "U+E525",
        */
        switch (true) {
            case dynamics.f:
                return "dynamicForte";
            case dynamics.ff:
                return "dynamicFF";
            case dynamics.fff:
                return "dynamicFFF";
            case dynamics.ffff:
                return "dynamicFFFF";
            case dynamics.fffff:
                return "dynamicFFFFF";
            case dynamics.ffffff:
                return "dynamicFFFFFF";

            case dynamics.fp:
                return "dynamicFortePiano";
            case dynamics.fz:
                return "dynamicForzando";

            case dynamics.mf:
                return "dynamicMF";
            case dynamics.mp:
                return "dynamicMP";

            case dynamics.p:
                return "dynamicPiano";
            case dynamics.pp:
                return "dynamicPP";
            case dynamics.ppp:
                return "dynamicPPP";
            case dynamics.pppp:
                return "dynamicPPPP";
            case dynamics.ppppp:
                return "dynamicPPPPP";
            case dynamics.pppppp:
                return "dynamicPPPPPP";

            case dynamics.rf:
                return "dynamicRinforzando1";
            case dynamics.rfz:
                return "dynamicRinforzando2";

            case dynamics.sf:
                return "dynamicSforzando1";
            case dynamics.sffz:
                return "dynamicSforzatoFF";
            case dynamics.sfp:
                return "dynamicSforzandoPiano";
            case dynamics.sfpp:
                return "dynamicSforzandoPianissimo";
            case dynamics.sfz:
                return "dynamicSforzato";

            default:
                console.warn("Found unknown dynamic!");
                return null;
        }
    }
}