21. 便利な関数
Siv3D プログラミングを便利にする、いくつかの小さな関数を学びます。
21.1 最小値・最大値
Min(a, b) は a と b のうち小さい方を返しますMax(a, b) は a と b のうち大きい方を返します- 2 つの引数の型は同じである必要があります
- 2 つの引数の型が異なる場合は
Min<size_t>(a, b) のように明示的に型を指定します
# include <Siv3D.hpp>
void Main()
{
Print << Min(10, 20);
Print << Max(10, 20);
Print << Min(12.3, 45.6);
Print << Max(12.3, 45.6);
String s = U"Hello";
Print << Min<size_t>(s.size(), 4);
Print << Max<size_t>(s.size(), 4);
while (System::Update())
{
}
}
21.2 指定した範囲に収める
Clamp(value, min, max) は value を [min, max] の範囲に収めた値を返します
Clamp(-20, 0, 100) は 0 を返しますClamp(50, 0, 100) は 50 を返しますClamp(120, 0, 100) は 100 を返します
- 3 つの引数の型は同じである必要があります
# include <Siv3D.hpp>
void Main()
{
Print << Clamp(-20, 0, 100);
Print << Clamp(50, 0, 100);
Print << Clamp(120, 0, 100);
while (System::Update())
{
}
}
21.3 範囲内であるかを調べる
InRange(value, min, max) は value が [min, max] の範囲内にあるかを bool 型で返します
InRange(50, 0, 100) は true を返しますInRange(120, 0, 100) は false を返します
# include <Siv3D.hpp>
void Main()
{
Print << InRange(50, 0, 100);
Print << InRange(120, 0, 100);
while (System::Update())
{
}
}
21.4 奇数・偶数の判定
IsOdd(n) は整数 n が奇数であるかを bool 型で返しますIsEven(n) は整数 n が偶数であるかを bool 型で返します
# include <Siv3D.hpp>
void Main()
{
Print << IsOdd(3);
Print << IsOdd(4);
Print << IsEven(3);
Print << IsEven(4);
while (System::Update())
{
}
}
21.5 絶対値
Abs(value) は value の絶対値を返します
Abs(-10) は 10 を返しますAbs(10) は 10 を返しますAbs(-3.14) は 3.14 を返しますAbs(3.14) は 3.14 を返します
# include <Siv3D.hpp>
void Main()
{
Print << Abs(-10);
Print << Abs(10);
Print << Abs(-3.14);
Print << Abs(3.14);
while (System::Update())
{
}
}
21.6 差の絶対値
AbsDiff(a, b) は a と b の差の絶対値を返します
AbsDiff(10, 20) は 10 を返しますAbsDiff(20, 10) は 10 を返しますAbsDiff(3.14, 2.71) は 0.43 を返しますAbsDiff(2.71, 3.14) は 0.43 を返します
# include <Siv3D.hpp>
void Main()
{
Print << AbsDiff(10, 20);
Print << AbsDiff(20, 10);
Print << AbsDiff(3.14, 2.71);
Print << AbsDiff(2.71, 3.14);
while (System::Update())
{
}
}
21.7 インデックス付き範囲 for 文
- 範囲 for 文において、
Indexed() を使うと、整数のインデックスと範囲の各要素の両方を同時に扱えます
# include <Siv3D.hpp>
void Main()
{
const Array<String> animals = { U"cat", U"dog", U"bird" };
for (auto&& [i, animal] : Indexed(animals))
{
Print << U"{}: {}"_fmt(i, animal);
}
while (System::Update())
{
}
}
21.8 インデックス付き範囲 for 文（参照）
- インデックス付き範囲 for 文で、各要素を参照で取得するには、
IndexedRef() を使います
# include <Siv3D.hpp>
void Main()
{
Array<int32> numbers = { 10, 20, 30 };
for (auto&& [i, number] : IndexedRef(numbers))
{
number += i;
}
for (const auto& number : numbers)
{
Print << number;
}
while (System::Update())
{
}
}
21.9 ループの短縮記述
for (int32 i = 0; i < N; ++i) を for (auto i : step(N)) と短く書くことができますfor (auto i = from; i <= to; ++i) を for (auto i : Range(from, to)) と短く書くことができます
# include <Siv3D.hpp>
void Main()
{
for (auto i : step(3))
{
Print << i;
}
Print << U"---";
for (auto i : Range(5, 10))
{
Print << i;
}
while (System::Update())
{
}
}
21.10 文字の性質を調べる
- 文字（おもに ASCII 文字）の性質を調べる次のような関数があります
| 関数 |
説明 |
bool IsASCII(char32) |
ASCII 文字であるかを返す |
bool IsDigit(char32) |
10 進数の数字であるかを返す |
bool IsLower(char32) |
アルファベットの小文字であるかを返す |
bool IsUpper(char32) |
アルファベットの大文字であるかを返す |
bool IsAlpha(char32) |
文字がアルファベットであるかを返す |
bool IsAlnum(char32) |
文字がアルファベットもしくは数字であるかを返す |
bool IsXdigit(char32) |
文字が 16 進数の数字であるかを返す |
bool IsControl(char32) |
文字が制御文字であるかを返す |
bool IsBlank(char32) |
文字が空白文字 (' ', '\t', および全角空白) であるかを返す |
bool IsSpace(char32) |
文字が空白類文字 (' ', '\t', '\n', '\v', '\f', '\r', および全角空白) であるかを返す |
bool IsPrint(char32) |
文字が印字可能文字であるかを返す |
char32 ToLower(char32) |
アルファベットの大文字を小文字にする |
char32 ToUpper(char32) |
アルファベットの小文字を大文字にする |
# include <Siv3D.hpp>
void Main()
{
Print << IsASCII(U'A') << U' ' << IsASCII(U'あ');
Print << IsUpper(U'A') << U' ' << IsUpper(U'a');
Print << IsAlnum(U'4') << U' ' << IsAlnum(U'#');
Print << IsSpace(U' ') << U' ' << IsSpace(U'-');
Print << ToLower(U'A') << U' ' << ToLower(U'a');
while (System::Update())
{
}
}
出力true false
true false
true false
true false
a a
21.11 数学定数
# include <Siv3D.hpp>
void Main()
{
// 円周率
Print << Math::Pi;
// 黄金比
Print << Math::Phi;
// NaN
Print << Math::QNaN;
while (System::Update())
{
}
}
21.12 角度の表現
- C++ や Siv3D の API は角度をラジアンで扱いますが、人にとっての読みやすさのため、表記だけを別の単位にすることができます
_deg というサフィックスを用いると、度数法で角度を表現できます
- 例えば
90_deg は (90 * Math::Pi / 180.0) になり、90° をラジアンで表現した値になります
_pi というサフィックスを用いることで、π とのかけ算を省略できます
- 例えば
0.5_pi は (0.5 * Math::Pi) と同じです
- 円の半径に対する周長の比として定義される定数 τ を用いて、角度を表現できます。サフィックスは
_tau です
- 例えば
0.5_tau は (0.5 * Math::TwoPi) と同じで、180° をラジアンで表現した値になります
| サフィックス |
説明 |
数値に乗算する値 |
_deg |
度数法 |
Math::Pi / 180.0 |
_pi |
π |
Math::Pi |
_tau |
τ |
Math::TwoPi |
# include <Siv3D.hpp>
void Main()
{
Print << U"{}"_fmt(180_deg);
Print << U"{}"_fmt(1_pi);
Print << U"{}"_fmt(0.5_tau);
while (System::Update())
{
}
}
出力3.141592653589793
3.141592653589793
3.141592653589793
21.13 角度の正規化
- 角度（ラジアン）を正規化するには
Math::NormalizeAngle(radian, cenetr = Pi) を使います
- 第 2 引数は正規化の中心角度です。省略すると
Pi が使われます
- 中心角度が Pi の場合の戻り値の範囲は
[0, 2π) です
- 中心角度が 0 の場合の戻り値の範囲は
[-π, π) です
# include <Siv3D.hpp>
void Main()
{
while (System::Update())
{
const double a = (Scene::Time() * -90_deg);
const double b = (Scene::Time() * 90_deg);
ClearPrint();
Print << a;
// 角度を [0.0, 2π) の範囲に正規化した値を返す
Print << Math::NormalizeAngle(a);
// 角度を [-π, π) の範囲に正規化した値を返す
Print << Math::NormalizeAngle(a, 0.0);
Print << U"----";
Print << b;
// 角度を [0.0, 2π) の範囲に正規化した値を返す
Print << Math::NormalizeAngle(b);
// 角度を [-π, π) の範囲に正規化した値を返す
Print << Math::NormalizeAngle(b, 0.0);
}
}
出力例-3.86462
2.41857
2.41857
----
3.86462
3.86462
-2.41857
21.14 ラジアンと度数法の変換
- ラジアンから度数法への変換には
Math::ToDegrees(radian) を使います
- 度数法からラジアンへの変換には
Math::ToRadians(degrees) を使います
# include <Siv3D.hpp>
void Main()
{
const double angle = 45_deg;
Print << angle;
Print << Math::ToDegrees(angle);
Print << Math::ToRadians(Math::ToDegrees(angle));
while (System::Update())
{
}
}
21.15 列挙型から整数への変換
FromEnum(enum) を使うと、列挙型の値を整数に変換できます
# include <Siv3D.hpp>
enum class State
{
Menu,
Game,
Result
};
void Main()
{
State state = State::Result;
const int32 n = FromEnum(state);
Print << n;
while (System::Update())
{
}
}
21.16 整数から列挙型への変換
ToEnum<Enum>(i) を使うと、整数を列挙型に変換できます
# include <Siv3D.hpp>
enum class State
{
Menu,
Game,
Result
};
void Main()
{
const int32 n = 2;
State state = ToEnum<State>(n);
Print << (state == State::Result);
while (System::Update())
{
}
}
21.17 エラー
- Siv3D のプログラムでエラーを伝える例外を送出したい場合、
Error クラスを使うと便利です
- この例外が捕捉されなかった場合、Siv3D エンジンはエラーメッセージの内容をメッセージボックスに表示してプログラムを終了します
- Windows 版（Visual Studio）において、例外の発生箇所を IDE 上で表示する方法は、例外の発生箇所の表示 を参照してください
# include <Siv3D.hpp>
void Main()
{
const Texture texture{ U"aaa.png" };
if (not texture)
{
// 例外を送出する
throw Error{ U"Failed to load `aaa.png`" };
}
while (System::Update())
{
}
}
21.18 コマンドライン引数の取得
- プログラムの起動時に渡されたコマンドライン引数を取得するには、
System::GetCommandLineArgs() を使います
# include <Siv3D.hpp>
void Main()
{
const Array<String> commands = System::GetCommandLineArgs();
for (const auto& command : commands)
{
Print << command;
}
while (System::Update())
{
}
}
21.19 コンソール出力
Print では追いきれないほどの出力データを可視化したい場合や、出力データをクリップボードにコピーしたい場合はコンソール出力が便利ですPrint の代わりに Console に向かって出力することで、コンソール出力ができます- Windows の場合はコマンドプロンプトに出力されます
# include <Siv3D.hpp>
void Main()
{
Array<int32> v = { 10,20,30,40,50 };
Print << v;
// コンソール出力
Console << v;
Console << U"Hello, Siv3D!";
while (System::Update())
{
}
}
21.20 ログ出力
Print の代わりに Logger に向かって出力することで、ログ出力ができます- Windows の場合は Visual Studio の「出力」ウィンドウに出力されます（デバッグ実行時）
# include <Siv3D.hpp>
void Main()
{
Array<int32> v = { 10,20,30,40,50 };
Print << v;
// ログ出力
Logger << v;
Logger << U"Hello, Siv3D!";
while (System::Update())
{
}
}