SSTFormat/チップ.cs

   1 using System;
   2 using System.Collections.Generic;
   3 using System.Diagnostics;
   4 using System.Linq;
   5
   6 namespace SSTFormat
   7 {
   8         public class チップ : IComparable
   9         {
  10                 public const int 最大音量 = 4;
  11
  12                 #region " プロパティ(1)（増減したら CopyFrom() を修正のこと）"
  13                 //----------------
  14                 public チップ種別 チップ種別 { get; set; } = チップ種別.Unknown;
  15                 public int 小節番号 { get; set; } = -1;
  16                 public int 小節内位置 { get; set; } = 0;
  17                 public int 小節解像度 { get; set; } = 1;
  18                 /// <summary>
  19                 /// チップの描画時刻[ms]。
  20                 /// 譜面の先頭（小節番号 -1 の小節の先頭）からの時刻をミリ秒単位で表す。
  21                 /// </summary>
  22                 public long 描画時刻ms { get; set; } = FDK.カウンタ.QPCTimer.未使用;
  23                 /// <summary>
  24                 /// チップの描画時刻[sec]。
  25                 /// 譜面の先頭（小節番号 -1 の小節の先頭）からの時刻を秒単位で表す。
  26                 /// </summary>
  27                 public double 描画時刻sec => ( this.描画時刻ms / 1000.0 );
  28                 /// <summary>
  29                 /// チップの発声時刻[ms]。
  30                 /// 譜面の先頭（小節番号 -1 の小節の先頭）からの時刻をミリ秒単位で表す。
  31                 /// </summary>
  32                 /// <remarks>
  33                 /// サウンドの発声遅延を考慮して、描画時刻よりも遅く設定すること。
  34                 /// </remarks>
  35                 public long 発声時刻ms { get; set; } = FDK.カウンタ.QPCTimer.未使用;
  36                 /// <summary>
  37                 /// チップの発声時刻[sec]。
  38                 /// 譜面の先頭（小節番号 -1 の小節の先頭）からの時刻を秒単位で表す。
  39                 /// </summary>
  40                 /// <remarks>
  41                 /// サウンドの発声遅延を考慮して、描画時刻よりも遅く設定すること。
  42                 /// </remarks>
  43                 public double 発声時刻sec => ( this.発声時刻ms / 1000.0 );
  44                 /// <summary>
  45                 /// チップの音量（小:1～4:大）。
  46                 /// </summary>
  47                 public int 音量
  48                 {
  49                         get
  50                         {
  51                                 return this.bs_音量;
  52                         }
  53                         set
  54                         {
  55                                 if( ( 1 > value ) || ( チップ.最大音量 < value ) )
  56                                         throw new ArgumentException( $"音量の値域(1～{チップ.最大音量})を超える値 '{value}' が指定されました。" );
  57
  58                                 this.bs_音量 = value;
  59                         }
  60                 }
  61                 /// <summary>
  62                 /// チップが BPM チップである場合は、その BPM 値。それ以外の場合は無効。
  63                 /// </summary>
  64                 public double BPM { get; set; } = 120.0;
  65                 //----------------
  66                 #endregion
  67                 #region " プロパティ(2) 演奏用（増減したら CopyFrom() を修正のこと）"
  68                 //----------------
  69                 public bool 可視 { get; set; } = true;
  70                 public bool 不可視
  71                 {
  72                         get { return !this.可視; }
  73                         set { this.可視 = !value; }
  74                 }
  75                 public bool 可視の初期値
  76                 {
  77                         get
  78                         {
  79                                 return (
  80                                         // ↓これらは不可視。
  81                                         ( this.チップ種別 == チップ種別.BPM ) ||
  82                                         ( this.チップ種別 == チップ種別.背景動画 ) ||
  83                                         ( this.チップ種別 == チップ種別.小節メモ ) ||
  84                                         ( this.チップ種別 == チップ種別.Unknown )
  85                                         ) ? false : true;
  86                                 }
  87                         }
  88                 public bool ヒット済みである { get; set; } = false;
  89                 public bool ヒットされていない
  90                 {
  91                         get { return !this.ヒット済みである; }
  92                         set { this.ヒット済みである = !value; }
  93                 }
  94                 public bool 発声済みである { get; set; } = false;
  95                 public bool 発声されていない
  96                 {
  97                         get { return !this.発声済みである; }
  98                         set { this.発声済みである = !value; }
  99                 }
 100                 //----------------
 101                 #endregion
 102                 #region " プロパティ(3) SSTFEditor用（増減したら CopyFrom() を修正のこと）"
 103                 //----------------
 104                 public int 譜面内絶対位置grid { get; set; } = 0;
 105                 public bool ドラッグ操作により選択中である { get; set; } = false;
 106                 public bool 選択が確定している { get; set; } = false;
 107                 public bool 選択が確定していない
 108                 {
 109                         get { return !this.選択が確定している; }
 110                         set { this.選択が確定している = !value; }
 111                 }
 112                 public bool 移動済みである { get; set; } = true;
 113                 public bool 移動されていない
 114                 {
 115                         get { return !this.移動済みである; }
 116                         set { this.移動済みである = !value; }
 117                 }
 118                 public string チップ内文字列 { get; set; } = null;
 119                 public int 枠外レーン数 { get; set; } = 0;
 120                 //----------------
 121                 #endregion
 122
 123                 public チップ()
 124                 {
 125                 }
 126                 public チップ( チップ コピー元チップ )
 127                 {
 128                         this.CopyFrom( コピー元チップ );
 129                 }
 130                 public void CopyFrom( チップ srcChip )
 131                 {
 132                         // プロパティ(1)
 133                         this.チップ種別 = srcChip.チップ種別;
 134                         this.小節番号 = srcChip.小節番号;
 135                         this.小節内位置 = srcChip.小節内位置;
 136                         this.小節解像度 = srcChip.小節解像度;
 137                         this.描画時刻ms = srcChip.描画時刻ms;
 138                         this.発声時刻ms = srcChip.発声時刻ms;
 139                         this.音量 = srcChip.音量;
 140                         this.BPM = srcChip.BPM;
 141
 142                         // プロパティ(2)
 143                         this.可視 = srcChip.可視;
 144                         this.ヒット済みである = srcChip.ヒット済みである;
 145                         this.発声済みである = srcChip.発声済みである;
 146
 147                         // プロパティ(3)
 148                         this.譜面内絶対位置grid = srcChip.譜面内絶対位置grid;
 149                         this.ドラッグ操作により選択中である = srcChip.ドラッグ操作により選択中である;
 150                         this.選択が確定している = srcChip.選択が確定している;
 151                         this.移動済みである = srcChip.移動済みである;
 152                         this.チップ内文字列 = srcChip.チップ内文字列;
 153                         this.枠外レーン数 = srcChip.枠外レーン数;
 154                 }
 155                 public void ヒット前の状態にする()
 156                 {
 157                         // 演奏用プロパティについて設定する。
 158
 159                         this.可視 = this.可視の初期値;
 160                         this.ヒット済みである = false;
 161                         this.発声済みである = false;
 162                 }
 163
 164                 #region " IComparable 実装 "
 165                 //-----------------
 166                 // 概要:
 167                 //     現在のインスタンスを同じ型の別のオブジェクトと比較して、並べ替え順序において、現在のインスタンスの位置が同じ型の別のオブジェクトの前、後ろ、または同じのいずれであるかを示す整数を返します。
 168                 //
 169                 // パラメータ:
 170                 //   obj:
 171                 //     このインスタンスと比較するオブジェクト。
 172                 //
 173                 // 戻り値:
 174                 //     比較対象オブジェクトの相対順序を示す 32 ビット符号付き整数。戻り値の意味は次のとおりです。
 175                 //
 176                 //     値              説明
 177                 //     --------------------
 178                 //     負数           this ＜ obj
 179                 //     0                this ＝ obj
 180                 //     正数           this ＞ obj
 181                 //
 182                 // 例外:
 183                 //   System.ArgumentException:
 184                 //     obj の型がこのインスタンスの型と異なります。
 185                 //
 186                 public int CompareTo( object obj )
 187                 {
 188                         var other = obj as チップ;
 189
 190                         if( this.小節番号 < other.小節番号 ) { return -1; }
 191                         if( this.小節番号 > other.小節番号 ) { return +1; }
 192
 193                         double dbThis = (double) this.小節内位置 / (double) this.小節解像度;
 194                         double dbOther = (double) other.小節内位置 / (double) other.小節解像度;
 195
 196                         if( dbThis < dbOther ) { return -1; }
 197                         if( dbThis > dbOther ) { return +1; }
 198
 199
 200                         // グリッドが完全に等しいなら、チップの種類ごとに定義された深度で順序を決める。
 201
 202                         if( チップ.チップの深さ[ this.チップ種別 ] > チップ.チップの深さ[ other.チップ種別 ] ) { return -1; }
 203                         if( チップ.チップの深さ[ this.チップ種別 ] < チップ.チップの深さ[ other.チップ種別 ] ) { return +1; }
 204
 205                         return 0;
 206                 }
 207                 //-----------------
 208                 #endregion
 209
 210                 protected readonly static Dictionary<チップ種別, int> チップの深さ
 211                         #region " *** "
 212                         //-----------------
 213                         = new Dictionary<チップ種別, int>() {
 214                                 { チップ種別.Ride_Cup, 50 },
 215                                 { チップ種別.HiHat_Open, 50 },
 216                                 { チップ種別.HiHat_HalfOpen, 50 },
 217                                 { チップ種別.HiHat_Close, 50 },
 218                                 { チップ種別.HiHat_Foot, 50 },
 219                                 { チップ種別.Snare, 50 },
 220                                 { チップ種別.Snare_OpenRim, 50 },
 221                                 { チップ種別.Snare_ClosedRim, 50 },
 222                                 { チップ種別.Snare_Ghost, 50 },
 223                                 { チップ種別.Tom1, 50 },
 224                                 { チップ種別.Tom1_Rim, 50 },
 225                                 { チップ種別.BPM, 50 },
 226                                 { チップ種別.Ride, 60 },
 227                                 { チップ種別.Splash, 60 },
 228                                 { チップ種別.Tom2, 60 },
 229                                 { チップ種別.Tom2_Rim, 60 },
 230                                 { チップ種別.LeftCrash, 70 },
 231                                 { チップ種別.China, 70 },
 232                                 { チップ種別.Tom3, 70 },
 233                                 { チップ種別.Tom3_Rim, 70 },
 234                                 { チップ種別.RightCrash, 70 },
 235                                 { チップ種別.Bass, 75 },
 236                                 { チップ種別.LeftCymbal_Mute, 76 },
 237                                 { チップ種別.RightCymbal_Mute, 76 },
 238                                 { チップ種別.小節線, 80 },
 239                                 { チップ種別.拍線, 85 },
 240                                 { チップ種別.背景動画, 90 },
 241                                 { チップ種別.小節メモ, 99 },
 242                                 { チップ種別.Unknown, 99 },
 243                         };
 244                         //-----------------
 245                         #endregion
 246
 247                 #region " バックストア "
 248                 //-----------------
 249                 private int bs_音量 = チップ.最大音量;
 250                 //-----------------
 251                 #endregion
 252         }
 253 }