abcjs 6.0.0-beta.9 → 6.0.0

package/src/write/abc_relative_element.js

@@ -1,18 +1,4 @@
 //    abc_relative_element.js: Definition of the RelativeElement class.
-//    Copyright (C) 2010-2020 Gregory Dyke (gregdyke at gmail dot com) and Paul Rosen
-//
-//    Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
-//    documentation files (the "Software"), to deal in the Software without restriction, including without limitation
-//    the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and
-//    to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-//
-//    The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-//
-//    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
-//    BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-//    NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
-//    DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-//    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 var RelativeElement = function RelativeElement(c, dx, w, pitch, opt) {
 	opt = opt || {};
@@ -41,12 +27,25 @@ var RelativeElement = function RelativeElement(c, dx, w, pitch, opt) {
 		else
 			this.bottom += opt.stemHeight;
 	}
-	//if (this.type === "symbol") {
-	//	var offset = glyphs.getYCorr(this.c);
-	//	this.top += offset;
-	//	this.bottom += offset;
-	//}
+	if (opt.dim)
+		this.dim = opt.dim;
+	if (opt.position)
+		this.position = opt.position;
 	this.height = opt.height ? opt.height : 4; // The +1 is to give a little bit of padding.
+	if (opt.top)
+		this.top = opt.top;
+	if (opt.bottom)
+		this.bottom = opt.bottom;
+	if (opt.name)
+		this.name = opt.name;
+	else if (this.c)
+		this.name = this.c;
+	else
+		this.name = this.type;
+	if (opt.realWidth)
+		this.realWidth = opt.realWidth;
+	else
+		this.realWidth = this.w;
 	this.centerVertically = false;
 	switch (this.type) {
 		case "debug":
@@ -77,88 +76,49 @@ var RelativeElement = function RelativeElement(c, dx, w, pitch, opt) {
 	}
 };
 
-RelativeElement.prototype.setX = function (x) {
-	this.x = x+this.dx;
+RelativeElement.prototype.getChordDim = function () {
+	if (this.type === "debug")
+		return null;
+	if (!this.chordHeightAbove && !this.chordHeightBelow)
+		return null;
+	// Chords are centered, annotations are left justified.
+	// NOTE: the font reports extra space to the left and right anyway, so there is a built in margin.
+	// We add a little margin so that items can't touch - we use half the font size as the margin, so that is 1/4 on each side.
+	// if there is only one character that we're printing, use half of that margin.
+	// var margin = this.dim.font.size/4;
+	// if (this.c.length === 1)
+	// 	margin = margin / 2;
+	var margin = 0;
+
+	var offset = this.type === "chord" ? this.realWidth/2 : 0;
+	var left = this.x - offset - margin;
+	var right = left + this.realWidth + margin;
+	return { left: left, right: right};
 };
 
-RelativeElement.prototype.setUpperAndLowerElements = function(positionY) {
-	switch(this.type) {
-		case "part":
-			this.top = positionY.partHeightAbove + this.height;
-			this.bottom = positionY.partHeightAbove;
-			break;
-		case "text":
-		case "chord":
-			if (this.chordHeightAbove) {
-				this.top = positionY.chordHeightAbove;
-				this.bottom = positionY.chordHeightAbove;
-			} else {
-				this.top = positionY.chordHeightBelow;
-				this.bottom = positionY.chordHeightBelow;
-			}
-			break;
-		case "lyric":
-			if (this.lyricHeightAbove) {
-				this.top = positionY.lyricHeightAbove;
-				this.bottom = positionY.lyricHeightAbove;
-			} else {
-				this.top = positionY.lyricHeightBelow;
-				this.bottom = positionY.lyricHeightBelow;
-			}
-			break;
-		case "debug":
-			this.top = positionY.chordHeightAbove;
-			this.bottom = positionY.chordHeightAbove;
-			break;
-	}
-	if (this.pitch === undefined || this.top === undefined)
-		window.console.error("RelativeElement position not set.", this.type, this.pitch, this.top, positionY);
+RelativeElement.prototype.invertLane = function (total) {
+	if (this.lane === undefined)
+		this.lane = 0;
+	this.lane = total - this.lane - 1;
 };
 
-RelativeElement.prototype.draw = function (renderer, bartop) {
-	if (this.pitch === undefined)
-		window.console.error(this.type + " Relative Element y-coordinate not set.");
-	var y = renderer.calcY(this.pitch);
-	switch(this.type) {
-		case "symbol":
-			if (this.c===null) return null;
-			var klass = "symbol";
-			if (this.klass) klass += " " + this.klass;
-			this.graphelem = renderer.printSymbol(this.x, this.pitch, this.c, this.scalex, this.scaley, renderer.addClasses(klass)); break;
-		case "debug":
-			this.graphelem = renderer.renderText({ x: this.x, y: renderer.calcY(15), text: ""+this.c, type: "debugfont", klass: 'debug-msg', anchor: 'start', centerVertically: false, history: 'not-selectable'}); break;
-		case "barNumber":
-			this.graphelem = renderer.renderText({ x: this.x, y: y, text: ""+this.c, type: "measurefont", klass: 'bar-number', anchor: "middle", history: 'ignore'});
-			break;
-		case "lyric":
-			this.graphelem = renderer.renderText({ x: this.x, y: y, text: this.c, type: "vocalfont", klass: 'lyric', anchor: "middle"});
-			break;
-		case "chord":
-			this.graphelem = renderer.renderText({ x: this.x, y: y, text: this.c, type: 'gchordfont', klass: "chord", anchor: "middle"});
-			break;
-		case "decoration":
-			this.graphelem = renderer.renderText({ x: this.x, y: y, text: this.c, type: 'annotationfont', klass: "annotation", anchor: "middle", centerVertically: true});
-			break;
-		case "text":
-			this.graphelem = renderer.renderText({ x: this.x, y: y, text: this.c, type: 'annotationfont', klass: "annotation", anchor: "start", centerVertically: this.centerVertically});
-			break;
-		case "multimeasure-text":
-			this.graphelem = renderer.renderText({ x: this.x+this.w/2, y: y, text: this.c, type: 'tempofont', klass: "rest", anchor: "middle", centerVertically: false});
-			break;
-		case "part":
-			this.graphelem = renderer.renderText({ x: this.x, y: y, text: this.c, type: 'partsfont', klass: "part", anchor: "start"});
-			break;
-		case "bar":
-			this.graphelem = renderer.printStem(this.x, this.linewidth, y, (bartop)?bartop:renderer.calcY(this.pitch2)); break; // bartop can't be 0
-		case "stem":
-			this.graphelem = renderer.printStem(this.x, this.linewidth, y, renderer.calcY(this.pitch2)); break;
-		case "ledger":
-			this.graphelem = renderer.printStaveLine(this.x, this.x+this.w, this.pitch, renderer.addClasses("ledger")); break;
-	}
-	if (this.scalex!==1 && this.graphelem) {
-		renderer.scaleExistingElem(this.graphelem, this.scalex, this.scaley, this.x, y);
-	}
-	return this.graphelem;
+RelativeElement.prototype.putChordInLane = function (i) {
+	this.lane = i;
+	// Add some extra space to account for the character's descenders.
+	if (this.chordHeightAbove)
+		this.chordHeightAbove = (this.height*1.25)*this.lane;
+	else
+		this.chordHeightBelow = (this.height*1.25)*this.lane;
+};
+
+RelativeElement.prototype.getLane = function () {
+	if (this.lane === undefined)
+		return 0;
+	return this.lane;
+};
+
+RelativeElement.prototype.setX = function (x) {
+	this.x = x+this.dx;
 };
 
 module.exports = RelativeElement;