VST GUIにおけるOn/Offボタンコントロールの実装

VST GUIにおいてOn/Offボタンコントロールを実装する方法を説明いたします。
なお、VST GUIの基本的な作成方法として下記をご理解いただいている前提で進めさせていただきます。

On/Offボタンコントロールは下記のようなコントロールで、クリックするごとにOnとOffが切り替わります。
ボタンがOffの時に値は0.0となり、Onの時に1.0になります。

まず、On/Offボタンコントロールを作成するにあたって、On/Offボタンコントロール用の画像を用意します。
ここでは下記の画像を使用しています。なお、利用できる画像形式はPNGのみとなりますのでご注意ください。

【On/Offボタンコントロール画像】

On/Offボタンコントロール用の画像はOff状態とOn状態のを一つにしたものになります。
画像は上側がOff状態、下側がOn状態となります。

次に上記の画像をプロジェクトで利用できるように、リソースファイルに追記します。

【resource.rc】

button.png           PNG   ".\\img\\button.png"

1	button.png PNG ".\\img\\button.png"

リソースファイルの記載方法はこちらもご参照ください。　→　最小構成のVST GUI

そして、VST GUIクラスのopen()関数内で、On/Offボタンコントロールを生成する処理を追記いたします。
コントロールを生成する処理は関数にしております。関数作成自体は必須ではありませんが、複数のコントロールを作る場合などに便利なためです。

【guieditor.cpp】

CControl* MyVSTGUIEditor::createOnOffButton(ParamID tag, int x, int y)
{
	// オン・オフボタンコントロールを作成する

	// まずは画像ファイルを読み込む
	CBitmap *bmp = new CBitmap("button.png");

	// コントロールのサイズを画像ファイルから取得する
	// オン状態とオフ状態が1つの画像(上下で)になっているので、高さは1/2にする
	CRect size(0, 0, bmp->getWidth(), bmp->getHeight() / 2);
	size.offset(x, y);   // 位置を設定(frameの左上が0,0となる)

	// コントロールの作成
	COnOffButton* control = new COnOffButton(size, this, tag, bmp);

	// パラメータの現在の値を取得し、コントロールに反映
	ParamValue value = controller->getParamNormalized(tag);
	control->setValueNormalized(value);

	// コントロールをフレームに登録
	frame->addView(control);

	// 読み込んだ画像は忘れず解放
	bmp->forget();

	// 作成したコントロールのポインタを返す
	return control;
}

CControl* MyVSTGUIEditor::createOnOffButton(ParamID tag, int x, int y)

{

// オン・オフボタンコントロールを作成する

// まずは画像ファイルを読み込む

CBitmap *bmp = new CBitmap("button.png");

// コントロールのサイズを画像ファイルから取得する

// オン状態とオフ状態が1つの画像(上下で)になっているので、高さは1/2にする

CRect size(0, 0, bmp->getWidth(), bmp->getHeight() / 2);

size.offset(x, y); // 位置を設定(frameの左上が0,0となる)

// コントロールの作成

COnOffButton* control = new COnOffButton(size, this, tag, bmp);

// パラメータの現在の値を取得し、コントロールに反映

ParamValue value = controller->getParamNormalized(tag);

control->setValueNormalized(value);

// コントロールをフレームに登録

frame->addView(control);

// 読み込んだ画像は忘れず解放

bmp->forget();

// 作成したコントロールのポインタを返す

return control;

}

createOnOffButton()関数の引数には、パラメータータグ(ID)と座標(x、y)を指定するようにしています。
コントロールはパラメーターと関連付けるので、パラメータータグ(ID)が必要になります。また、フレーム(描画領域)上の位置を指定するための座標(x、y)が必要になります。

createOnOffButton()関数ではまず、On/Offボタンコントロール用の画像を読み込んでいます。

次に画像からOn/Offボタンコントロールのサイズを取得し、CRect sizeにそのサイズを設定します。
On/Offボタンコントロール用の画像は2つの状態(On状態、Off状態)を1つの画像としていますので、高さは2で割っています。
また、このsizeはコントロールのサイズだけでなくフレーム上の配置位置も兼ねています。CRectのoffset()関数を使用して位置を設定します。

各画像と配置位置・サイズが決まれば、COnOffButtonクラスを作成します。
COnOffButtonクラスのコンストラクタには、「サイズ」「VST GUIクラスのポインタ」「パラメータータグ(ID)」「画像」の順に指定します。

これでOn/Offボタンが作成できるので、パラメータの現在の値をOn/Offボタンコントロールに反映し、フレームに登録すれば表示させることができます。

On/Offボタンコントロール用の画像はCOnOffButton側に設定され不要となるため解放しておきます。

作成したコントロール生成処理関数がコントロールのポインタを返すのは、後で他のコントロールと同期させたりするのに利用するためです。

また、VST GUIクラスのopen()関数内での呼び出しは下記のようにします。
【guieditor.cpp】

bool PLUGIN_API MyVSTGUIEditor::open(void* parent, const PlatformType& platformType)
{
	// GUIウィンドウが開かれたときに、UIを作成する

	～～ 中略 ～～

	//　---------------------------------------------
	// ここから各コントロールの作成
	createOnOffButton(1, 10, 10);

	～～ 中略 ～～

	// GUIウィンドウのオープンに成功した場合はtrueを返す
	return true;
}

bool PLUGIN_API MyVSTGUIEditor::open(void* parent, const PlatformType& platformType)

{

// GUIウィンドウが開かれたときに、UIを作成する

～～中略～～

//　---------------------------------------------

// ここから各コントロールの作成

createOnOffButton(1, 10, 10);

～～中略～～

// GUIウィンドウのオープンに成功した場合はtrueを返す

return true;

}

以上でOn/Offボタンコントロールを追加することができます。
ここでご紹介したOn/Offボタンコントロール用の画像はご自由にご利用いただいてかまいません。

上記以外にもVST3.6についての情報があります。下記をご参照ください。

はじめてのVST3プラグイン作り

また、質問やご指摘はコメント欄や掲示板、Twitterでいただけばとおもいます。

■掲示板
■Twitterアカウント：@vstcpp　　　URL：https://twitter.com/vstcpp

On/Offボタンの実装

VST GUIにおけるOn/Offボタンコントロールの実装

コメントを残すコメントをキャンセル