DrawingParameters.ts 7.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210
  1. import { EngravingRules } from "./EngravingRules";
  2. import { PlacementEnum } from "../VoiceData/Expressions/AbstractExpression";
  3. export enum ColoringModes {
  4. XML = 0,
  5. AutoColoring = 1,
  6. CustomColorSet = 2
  7. }
  8. export enum DrawingParametersEnum {
  9. allon = "allon",
  10. compact = "compact",
  11. default = "default",
  12. leadsheet = "leadsheet",
  13. preview = "preview",
  14. thumbnail = "thumbnail",
  15. }
  16. /** Internal drawing/rendering parameters and broad modes like compact and thumbnail. Overlap with EngravingRules. */
  17. export class DrawingParameters {
  18. /** will set other settings if changed with set method */
  19. private drawingParametersEnum: DrawingParametersEnum;
  20. public drawHighlights: boolean;
  21. public drawErrors: boolean;
  22. public drawSelectionStartSymbol: boolean;
  23. public drawSelectionEndSymbol: boolean;
  24. public drawCursors: boolean;
  25. public drawActivitySymbols: boolean;
  26. public drawScrollIndicator: boolean;
  27. public drawComments: boolean;
  28. public drawMarkedAreas: boolean;
  29. public drawTitle: boolean = true;
  30. public drawSubtitle: boolean = true;
  31. public drawLyricist: boolean = true;
  32. public drawComposer: boolean = true;
  33. public drawCredits: boolean = true;
  34. public drawPartNames: boolean = true;
  35. public coloringMode: ColoringModes;
  36. public fingeringPosition: PlacementEnum = PlacementEnum.Left;
  37. /** Draw notes set to be invisible (print-object="no" in XML). */
  38. public drawHiddenNotes: boolean = false;
  39. constructor(drawingParameters: DrawingParametersEnum = DrawingParametersEnum.default) {
  40. this.DrawingParametersEnum = drawingParameters;
  41. }
  42. /** Sets drawing parameters enum and changes settings flags accordingly. */
  43. public set DrawingParametersEnum(drawingParametersEnum: DrawingParametersEnum) {
  44. this.drawingParametersEnum = drawingParametersEnum;
  45. switch (drawingParametersEnum) {
  46. case DrawingParametersEnum.allon:
  47. this.setForAllOn();
  48. break;
  49. case DrawingParametersEnum.thumbnail:
  50. this.setForThumbnail();
  51. break;
  52. case DrawingParametersEnum.leadsheet:
  53. this.setForLeadsheet();
  54. break;
  55. case DrawingParametersEnum.compact:
  56. this.setForCompactMode();
  57. break;
  58. case DrawingParametersEnum.default:
  59. default:
  60. this.setForDefault();
  61. }
  62. }
  63. public get DrawingParametersEnum(): DrawingParametersEnum {
  64. return this.drawingParametersEnum;
  65. }
  66. public setForAllOn(): void {
  67. this.drawHighlights = true;
  68. this.drawErrors = true;
  69. this.drawSelectionStartSymbol = true;
  70. this.drawSelectionEndSymbol = true;
  71. this.drawCursors = true;
  72. this.drawActivitySymbols = true;
  73. this.drawScrollIndicator = true;
  74. this.drawComments = true;
  75. this.drawMarkedAreas = true;
  76. this.DrawTitle = true;
  77. this.DrawSubtitle = true;
  78. this.DrawComposer = true;
  79. this.DrawLyricist = true;
  80. this.drawCredits = true;
  81. this.DrawPartNames = true;
  82. this.drawHiddenNotes = true;
  83. EngravingRules.Rules.CompactMode = false;
  84. }
  85. public setForDefault(): void {
  86. this.setForAllOn();
  87. this.drawHiddenNotes = false;
  88. }
  89. public setForThumbnail(): void {
  90. this.drawHighlights = false;
  91. this.drawErrors = false;
  92. this.drawSelectionStartSymbol = false;
  93. this.drawSelectionStartSymbol = false;
  94. this.drawCursors = false;
  95. this.drawActivitySymbols = false;
  96. this.drawScrollIndicator = false;
  97. this.drawComments = true;
  98. this.drawMarkedAreas = true;
  99. this.drawHiddenNotes = false;
  100. }
  101. public setForCompactMode(): void {
  102. this.setForDefault();
  103. EngravingRules.Rules.CompactMode = true;
  104. this.DrawCredits = false; // sets DrawComposer, DrawTitle, DrawLyricist to false
  105. // this.DrawPartNames = true; // unnecessary
  106. this.drawHiddenNotes = false;
  107. }
  108. public setForLeadsheet(): void {
  109. this.drawHighlights = false;
  110. this.drawErrors = false;
  111. this.drawSelectionStartSymbol = true;
  112. this.drawSelectionEndSymbol = true;
  113. this.drawCursors = true;
  114. this.drawActivitySymbols = false;
  115. this.drawScrollIndicator = true;
  116. this.drawComments = true;
  117. this.drawMarkedAreas = true;
  118. }
  119. //#region GETTER / SETTER
  120. public get DrawCredits(): boolean {
  121. return this.drawCredits;
  122. }
  123. public set DrawCredits(value: boolean) {
  124. this.drawCredits = value;
  125. this.DrawComposer = value;
  126. this.DrawTitle = value;
  127. this.DrawSubtitle = value;
  128. this.DrawLyricist = value;
  129. }
  130. // TODO these drawCredits settings are duplicate in drawingParameters and EngravingRules. Maybe we only need them in EngravingRules.
  131. // this sets the parameter in DrawingParameters, which in turn sets the parameter in EngravingRules.
  132. // see settings below that don't call drawingParameters for the immediate approach.
  133. // on the other hand, DrawingParameters has the added option of setting broad modes (e.g. compact), though they aren't that useful
  134. public get DrawTitle(): boolean {
  135. return this.drawTitle;
  136. }
  137. /** Enable or disable drawing the Title of the piece. If disabled, will disable drawing Subtitle as well. */
  138. public set DrawTitle(value: boolean) {
  139. this.drawTitle = value;
  140. EngravingRules.Rules.RenderTitle = value;
  141. if (!value) { // don't draw subtitle if title isn't drawn
  142. this.DrawSubtitle = false;
  143. }
  144. }
  145. public get DrawSubtitle(): boolean {
  146. return this.drawSubtitle;
  147. }
  148. /** Enable or disable drawing the Subtitle of the piece. If enabled, will enable drawing Title as well. */
  149. public set DrawSubtitle(value: boolean) {
  150. this.drawSubtitle = value;
  151. EngravingRules.Rules.RenderSubtitle = value;
  152. if (value) {
  153. this.DrawTitle = true; // if subtitle is drawn, title needs to be drawn as well
  154. }
  155. }
  156. public get DrawComposer(): boolean {
  157. return this.drawComposer;
  158. }
  159. /** Enable or disable drawing a label for the Composer of the piece. */
  160. public set DrawComposer(value: boolean) {
  161. this.drawComposer = value;
  162. EngravingRules.Rules.RenderComposer = value;
  163. }
  164. public get DrawLyricist(): boolean {
  165. return this.drawLyricist;
  166. }
  167. public set DrawLyricist(value: boolean) {
  168. this.drawLyricist = value;
  169. EngravingRules.Rules.RenderLyricist = value;
  170. }
  171. public get DrawPartNames(): boolean {
  172. return this.drawPartNames;
  173. }
  174. public set DrawPartNames(value: boolean) {
  175. this.drawPartNames = value;
  176. EngravingRules.Rules.RenderPartNames = value;
  177. }
  178. public get FingeringPosition(): PlacementEnum {
  179. return this.fingeringPosition;
  180. }
  181. public set FingeringPosition(value: PlacementEnum) {
  182. this.fingeringPosition = value;
  183. EngravingRules.Rules.FingeringPosition = value;
  184. }
  185. }