FineKernelToolKit 3.1.0

- 総合概要
- 名前空間
- クラス
- ファイル

- クラス一覧
- クラス階層
- クラスメンバ

公開メンバ関数 | プロパティ | 全メンバ一覧
FK_CLI::fk_Quaternion クラス

四元数(クォータニオン)を管理するクラス [詳解]

FK_CLI::fk_Quaternion 連携図
[凡例]

## 公開メンバ関数
| fk_Quaternion ()
| コンストラクタ1 [詳解]
| fk_Quaternion (double s, double x, double y, double z)
| コンストラクタ2 [詳解]
| fk_Quaternion (double s, fk_Vector^ v)
| コンストラクタ3 [詳解]
| fk_Quaternion (fk_Quaternion^ Q)
| コピーコンストラクタ [詳解]
| ~fk_Quaternion ()
| デストラクタ [詳解]
| !fk_Quaternion ()
| ファイナライザ [詳解]
bool | Equals (fk_Quaternion^ Q)
| 同値比較メソッド1 [詳解]
virtual bool | Equals (Object^ O) override
| 同値比較メソッド2 [詳解]
String^ | ToString () override
| 文字列出力メソッド [詳解]
void | Init (void)
| 初期化メソッド [詳解]
void | Set (double s, double x, double y, double z)
| 成分設定メソッド1 [詳解]
void | Set (double s, fk_Vector^ v)
| 成分設定メソッド2 [詳解]
void | SetRotate (double theta, double x, double y, double z)
| 回転変換設定メソッド1 [詳解]
void | SetRotate (double theta, fk_Vector^ V)
| 回転変換設定メソッド2 [詳解]
bool | Normalize (void)
| 正規化メソッド [詳解]
void | Conj (void)
| 共役化メソッド [詳解]
bool | Inverse (void)
| 逆元化メソッド [詳解]
fk_Quaternion^ | GetInverse (void)
| 逆元取得メソッド [詳解]

## 静的公開メンバ関数
単項演算子
static fk_Quaternion^ | operator- (fk_Quaternion^ argQ)
| 単項マイナス演算子 [詳解]
static fk_Quaternion^ | operator~ (fk_Quaternion^ argQ)
| 単項共役演算子 [詳解]
二項演算子
static fk_Quaternion^ | operator* (fk_Quaternion^ Q1, fk_Quaternion^ Q2)
| 四元数積二項演算子 [詳解]
static fk_Quaternion^ | operator+ (fk_Quaternion^ Q1, fk_Quaternion^ Q2)
| 四元数和二項演算子 [詳解]
static fk_Quaternion^ | operator- (fk_Quaternion^ Q1, fk_Quaternion^ Q2)
| 四元数差二項演算子 [詳解]
static fk_Quaternion^ | operator* (fk_Quaternion^ Q, double D)
| 四元数スカラー倍二項演算子1 [詳解]
static fk_Quaternion^ | operator* (double D, fk_Quaternion^ Q)
| 四元数スカラー倍二項演算子2 [詳解]
static fk_Quaternion^ | operator/ (fk_Quaternion^ Q, double D)
| 四元数スカラー商二項演算子 [詳解]
static fk_Vector^ | operator* (fk_Quaternion^ Q, fk_Vector^ V)
| 四元数ベクトル変換二項演算子 [詳解]
static double | operator^ (fk_Quaternion^ Q1, fk_Quaternion^ Q2)
| 四元数内積二項演算子 [詳解]
代入演算子
static void | operator*= (fk_Quaternion^ Q1, fk_Quaternion^ Q2)
| 積代入演算子 [詳解]
static void | operator*= (fk_Quaternion^ Q1, double D)
| スカラー倍代入演算子 [詳解]
static void | operator/= (fk_Quaternion^ Q, double D)
| スカラー商代入演算子 [詳解]
static void | operator+= (fk_Quaternion^ Q1, fk_Quaternion^ Q2)
| 単項和代入演算子 [詳解]
static void | operator-= (fk_Quaternion^ Q1, fk_Quaternion^ Q2)
| 単項差代入演算子 [詳解]

## プロパティ
double | s`[get, set]`
| 四元数スカラー部成分プロパティ [詳解]
double | x`[get, set]`
| 四元数ベクトル部 x 成分プロパティ [詳解]
double | y`[get, set]`
| 四元数ベクトル部 y 成分プロパティ [詳解]
double | z`[get, set]`
| 四元数ベクトル部 z 成分プロパティ [詳解]
fk_Vector^ | v`[get, set]`
| 四元数ベクトル部プロパティ [詳解]
fk_Angle^ | Euler`[get, set]`
| オイラー角プロパティ [詳解]
double | Norm`[get]`
| ノルムプロパティ [詳解]
double | Abs`[get]`
| 絶対値プロパティ [詳解]
fk_Matrix^ | Matrix`[get]`
| 行列プロパティ [詳解]

## 詳解

四元数(クォータニオン)を管理するクラス

このクラスは、四元数(クォータニオン)の様々な機能を提供します。 四元数とは、3種類の虚数単位 と 4 個の実数 を用いて

という形式で表現される数のことで、「ハミルトン数」とも呼ばれます。 3Dグラフィックス分野での主な利用用途は、3次元の姿勢補間です。 四元数の補間については fk_Math を参照して下さい。

上記定義式のうち、s を「スカラー部」、(x, y, z) を「ベクトル部」と呼びます。 fk_Quaternion クラスでは、スカラー部を double 型の「s」というプロパティ ベクトル部を fk_Vector 型の「v」というプロパティで参照や設定を行うことができます。 また、ベクトル部の各成分 x, y, z を個別にプロパティで参照や設定を行うことも可能です。

四元数は、数学的には任意軸回転変換を表現します。 一つの四元数 は3次元ベクトル に対し、

という演算によって回転変換したベクトル を求めることができます。 また、四元数の積演算が合成変換を意味します。

その他の数学的性質については、各演算子やメソッドの項目で解説します。

参照
  fk_Vector, fk_Angle, fk_Matrix, fk_Math

## 構築子と解体子

FK_CLI::fk_Quaternion::fk_Quaternion | ( |  | ) |

コンストラクタ1

引数なしの場合、全ての成分が 0 である四元数を生成します。 特に、スカラー部も 0 であることに注意して下さい。

FK_CLI::fk_Quaternion::fk_Quaternion | ( | double | s,
|  | double | x,
|  | double | y,
|  | double | z
| ) |  |

コンストラクタ2

4個の実数を引数とするコンストラクタによって、 各成分を個別に初期設定できます。

四元数の成分は、回転角や回転軸を直接表すものではありません。 回転角と回転軸を設定したい場合は、 SetRotate() を使用して下さい。

引数

  [in] | s | スカラー部設定値
  [in] | x | ベクトル部 x 成分設定値
  [in] | y | ベクトル部 y 成分設定値
  [in] | z | ベクトル部 z 成分設定値

参照
  Set(), SetRotate()

FK_CLI::fk_Quaternion::fk_Quaternion | ( | double | s,
|  | fk_Vector^ | v
| ) |  |

コンストラクタ3

1個の実数と1個の fk_Vector 型変数を引数とするコンストラクタによって、 スカラー部とベクトル部をそれぞれ初期設定できます。

四元数の成分は、回転角や回転軸を直接表すものではありません。 回転角と回転軸を設定したい場合は、 SetRotate() を使用して下さい。

引数

  [in] | s | スカラー部設定値
  [in] | v | ベクトル部設定値

参照
  Set(), SetRotate()

FK_CLI::fk_Quaternion::fk_Quaternion | ( | fk_Quaternion^ | Q | ) |

コピーコンストラクタ

FK_CLI::fk_Quaternion::~fk_Quaternion | ( |  | ) |

デストラクタ

FK_CLI::fk_Quaternion::!fk_Quaternion | ( |  | ) |

ファイナライザ

## 関数詳解

bool FK_CLI::fk_Quaternion::Equals | ( | fk_Quaternion^ | Q | ) |

同値比較メソッド1

2つの四元数の値が同値かどうかを判定します。 単純に == 演算子を用いた場合はインスタンスが同一であるかどうかの判定となるため、 異なるインスタンスで同値かどうかを判定する場合はこのメソッドを利用して下さい。

引数

  [in] | Q | 同値かどうかを判定する四元数

戻り値
  同値であれば true を、そうでなければ false を返します。

virtual bool FK_CLI::fk_Quaternion::Equals | ( | Object^ | O | ) |
| override virtual

同値比較メソッド2

2つの四元数の値が同値かどうかを判定します。 単純に == 演算子を用いた場合はインスタンスが同一であるかどうかの判定となるため、 異なるインスタンスで同値かどうかを判定する場合はこのメソッドを利用して下さい。

引数

  [in] | O | 同値かどうかを判定する四元数

戻り値
  同値であれば true を、そうでなければ false を返します。

static fk_Quaternion ^ FK_CLI::fk_Quaternion::operator- | ( | fk_Quaternion^ | argQ | ) |
| static

単項マイナス演算子

四元数 に対し、

として符号は定義されます。以下のコードは、q2 に -q1 を代入します。

    q2 = -q1;

覚え書き
  回転変換を表す四元数 において、 による変換もまったく同じ回転となります。 逆回転変換を行う四元数を求めたい場合は、共役を利用して下さい。

static fk_Quaternion ^ FK_CLI::fk_Quaternion::operator~ | ( | fk_Quaternion^ | argQ | ) |
| static

単項共役演算子

四元数 に対し、

として共役 は定義されます。 以下のコードは、q2 に q1 の共役を代入します。

    q2 = ~q1;

正規化された四元数 が回転を現すとき、 共役四元数 は の逆回転を表します。

参照
  Conj()

static fk_Quaternion ^ FK_CLI::fk_Quaternion::operator* | ( | fk_Quaternion^ | Q1,
|  | fk_Quaternion^ | Q2
| ) |  |
| static

四元数積二項演算子

2つの四元数 に対し、 それぞれのスカラー部とベクトル部を以下のように記述するとします。

このとき、四元数の積は以下のように定義されます。

これを得るには、以下のように記述します。 q1, q2, q はいずれも fk_Quaternion 型の変数です。

    q = q1 * q2;

四元数の積は、四元数を回転変換として考えたとき、合成変換を生成することを意味します。 なお、四元数の積は交換法則は成り立ちません。

static fk_Quaternion ^ FK_CLI::fk_Quaternion::operator+ | ( | fk_Quaternion^ | Q1,
|  | fk_Quaternion^ | Q2
| ) |  |
| static

四元数和二項演算子

四元数の和は、全ての成分同士を加算することで定義されます。 四元数 q1 と q2 の和を得るには、以下のように記述します。 q1, q2, q はいずれも fk_Quaternion 型の変数です。

    q = q1 + q2;

static fk_Quaternion ^ FK_CLI::fk_Quaternion::operator- | ( | fk_Quaternion^ | Q1,
|  | fk_Quaternion^ | Q2
| ) |  |
| static

四元数差二項演算子

四元数の差は、全ての成分同士を減算することで定義されます。 四元数 q1 と q2 の差を得るには、以下のように記述します。 q1, q2, q はいずれも fk_Quaternion 型の変数です。

    q = q1 - q2;

static fk_Quaternion ^ FK_CLI::fk_Quaternion::operator* | ( | fk_Quaternion^ | Q,
|  | double | D
| ) |  |
| static

四元数スカラー倍二項演算子1

四元数のスカラー倍は、全ての成分に与えられた実数を掛けることで定義されます。 これを得るには、以下のように記述します。 q1, q2 はいずれも fk_Quaternion 型の変数で、d は double 型の変数です。

    q2 = q1 * d;

なお、四元数と実数の順番は逆でも構いません。

static fk_Quaternion ^ FK_CLI::fk_Quaternion::operator* | ( | double | D,
|  | fk_Quaternion^ | Q
| ) |  |
| static

四元数スカラー倍二項演算子2

四元数のスカラー倍は、全ての成分に与えられた実数を掛けることで定義されます。 これを得るには、以下のように記述します。 q1, q2 はいずれも fk_Quaternion 型の変数で、d は double 型の変数です。

    q2 = d * q1;

なお、四元数と実数の順番は逆でも構いません。

static fk_Quaternion ^ FK_CLI::fk_Quaternion::operator/ | ( | fk_Quaternion^ | Q,
|  | double | D
| ) |  |
| static

四元数スカラー商二項演算子

四元数のスカラー商は、全ての成分を与えられた実数で割ることで定義されます。 これを得るには、以下のように記述します。 q1, q2 はいずれも fk_Quaternion 型の変数で、d は double 型の変数です。

    q2 = q1 / d;

static fk_Vector ^ FK_CLI::fk_Quaternion::operator* | ( | fk_Quaternion^ | Q,
|  | fk_Vector^ | V
| ) |  |
| static

四元数ベクトル変換二項演算子

四元数は、数学的には任意軸回転変換を表現します。 一つの四元数 は3次元ベクトル に対し、

という演算によって回転変換したベクトル を求めることができます。

上記の変換ベクトルを得るには、以下のように記述します。 v1, v2 はともに fk_Vector 型の変数、q は fk_Quaternion 型の変数です。 v1 が元のベクトル、v2 が変換後のベクトルを意味します。

    v2 = q * v1;

static double FK_CLI::fk_Quaternion::operator^ | ( | fk_Quaternion^ | Q1,
|  | fk_Quaternion^ | Q2
| ) |  |
| static

四元数内積二項演算子

2つの四元数 の内積(スカラー積)は、以下のように定義されます。

これを得るには、以下のように記述します。 q1, q2 は fk_Quaternion 型の変数、d は double 型の変数です。

    d = q1 ^ q2;

なお、四元数の内積は交換法則が成り立ちます。

覚え書き
  ここで演算子として採用されている「^」は、 言語仕様上あまり演算子としての優先度が高くありません。 そのため、括弧を適切に使用しないと本来の意図と異なる結果を生じるおそれがあります。

static void FK_CLI::fk_Quaternion::operator*= | ( | fk_Quaternion^ | Q1,
|  | fk_Quaternion^ | Q2
| ) |  |
| static

積代入演算子

以下のコードは、四元数 q1 および q2 の積を 前の q1 の値は破棄して改めて q1 に設定します。

    q1 *= q2;

これは、以下のコードと同義です。

    q1 = q1 * q2;

覚え書き
  四元数の積は交換法則が成り立たないため、 を に代入したいときは、この演算子は利用できません。

static void FK_CLI::fk_Quaternion::operator*= | ( | fk_Quaternion^ | Q1,
|  | double | D
| ) |  |
| static

スカラー倍代入演算子

以下のコードは、四元数 q の全ての成分を d 倍します。 q は fk_Quaternion 型の変数、d は double 型の変数です。

    q *= d;

d は変数でなく数値でも構いません。

    q *= 2.0;

static void FK_CLI::fk_Quaternion::operator/= | ( | fk_Quaternion^ | Q,
|  | double | D
| ) |  |
| static

スカラー商代入演算子

以下のコードは、四元数 q の全ての成分を 1/d 倍します。 q は fk_Quaternion 型の変数、d は double 型の変数です。

    q /= d;

d は変数でなく数値でも構いません。

    q /= 2.0;

static void FK_CLI::fk_Quaternion::operator+= | ( | fk_Quaternion^ | Q1,
|  | fk_Quaternion^ | Q2
| ) |  |
| static

単項和代入演算子

以下のコードは、q1 に q2 分を加算します。 q1, q2 はいずれも fk_Quaternion 型の変数です。

    q1 += q2;

上記コードは、以下のコードと同義です。

    q1 = q1 + q2;

static void FK_CLI::fk_Quaternion::operator-= | ( | fk_Quaternion^ | Q1,
|  | fk_Quaternion^ | Q2
| ) |  |
| static

単項差代入演算子

以下のコードは、q1 に q2 分を減算します。 q1, q2 はいずれも fk_Quaternion 型の変数です。

    q1 -= q2;

上記コードは、以下のコードと同義です。

    q1 = q1 - q2;

String ^ FK_CLI::fk_Quaternion::ToString | ( |  | ) |
| override

文字列出力メソッド

現在の四元数成分値を文字列として出力します。

戻り値
  成分値の文字列

void FK_CLI::fk_Quaternion::Init | ( | void |  | ) |

初期化メソッド

スカラー部を 1 に、ベクトル部を零ベクトルとして初期化します。

void FK_CLI::fk_Quaternion::Set | ( | double | s,
|  | double | x,
|  | double | y,
|  | double | z
| ) |  |

成分設定メソッド1

各成分を個別に設定します。

ここで与えられるスカラー部とベクトル部は、 回転角や回転軸を表すわけではないことに注意して下さい。 回転変換における回転角と回転軸を設定する場合は、 SetRotate() を用います。

引数

  [in] | s | スカラー部設定値
  [in] | x | ベクトル部 x 成分設定値
  [in] | y | ベクトル部 y 成分設定値
  [in] | z | ベクトル部 z 成分設定値

参照
  SetRotate()

void FK_CLI::fk_Quaternion::Set | ( | double | s,
|  | fk_Vector^ | v
| ) |  |

成分設定メソッド2

1個の実数と1個の fk_Vector 型変数から、 スカラー部とベクトル部をそれぞれ設定します。

ここで与えられるスカラー部とベクトル部は、 回転角や回転軸を表すわけではないことに注意して下さい。 回転変換における回転角と回転軸を設定する場合は、 SetRotate() を用います。

引数

  [in] | s | スカラー部設定値
  [in] | v | ベクトル部設定値

参照
  SetRotate()

void FK_CLI::fk_Quaternion::SetRotate | ( | double | theta,
|  | double | x,
|  | double | y,
|  | double | z
| ) |  |

回転変換設定メソッド1

回転角を theta、回転軸を (x, y, z) とする回転変換を表す四元数を設定します。 回転軸は正規化されている必要はありません。

具体的に設定される成分値は、回転角を とし、 回転軸を表すベクトルを としたとき、 スカラー部は が、 ベクトル部は が設定されます。

ここで与えられた値と、設定される成分値は異なることに注意してください。 成分値を直接代入するには Set() を用います。

引数

  [in] | theta | 回転角
  [in] | x | 回転軸の x 成分
  [in] | y | 回転軸の y 成分
  [in] | z | 回転軸の z 成分

参照
  Set()

void FK_CLI::fk_Quaternion::SetRotate | ( | double | theta,
|  | fk_Vector^ | V
| ) |  |

回転変換設定メソッド2

回転角を theta、回転軸を V とする回転変換を表す四元数を設定します。 回転軸は正規化されている必要はありません。

具体的に設定される成分値は、回転角を とし、 回転軸を表すベクトルを としたとき、 スカラー部は が、 ベクトル部は が設定されます。

ここで与えられた値と、設定される成分値は異なることに注意してください。 成分値を直接代入するには Set() を用います。

引数

  [in] | theta | 回転角
  [in] | V | 回転軸ベクトル

参照
  Set()

bool FK_CLI::fk_Quaternion::Normalize | ( | void |  | ) |

正規化メソッド

四元数を正規化します。正規化とは、元の四元数の成分を絶対値で割ることで、 絶対値が 1 である四元数を求めることです。 全ての成分が 0 である場合のみ、正規化できません。

戻り値
  成功すれば true を、失敗すれば false を返します。

void FK_CLI::fk_Quaternion::Conj | ( | void |  | ) |

共役化メソッド

現在設定されている四元数に対し、自身を共役化します。

四元数 に対し、

として共役 は定義されます。 正規化された四元数 が回転を現すとき、 共役四元数 は の逆回転を表します。

bool FK_CLI::fk_Quaternion::Inverse | ( | void |  | ) |

逆元化メソッド

現在設定されている四元数に対し、自身を逆元化します。

四元数 に対し、

として逆元 は定義されます。

四元数が正規である(つまり、ノルムが1である)場合、 四元数の逆元と共役は等しくなります。 また、四元数によるベクトル変換を考えたとき、逆元は逆変換を表します。

戻り値
  成功すれば true を返し、失敗すれば false を返します。 失敗は、全ての成分が 0 である場合に起こります。

参照
  Norm, Conj(), GetInverse()

fk_Quaternion ^ FK_CLI::fk_Quaternion::GetInverse | ( | void |  | ) |

逆元取得メソッド

逆元となる四元数を返します。 四元数 に対し、

として逆元 は定義されます。

四元数が正規である(つまり、ノルムが1である)場合、 四元数の逆元と共役は等しくなります。 また、四元数によるベクトル変換を考えたとき、逆元は逆変換を表します。

参照
  Norm, Inverse()

## プロパティ詳解

double FK_CLI::fk_Quaternion::s
| get set

四元数スカラー部成分プロパティ

double FK_CLI::fk_Quaternion::x
| get set

四元数ベクトル部 x 成分プロパティ

double FK_CLI::fk_Quaternion::y
| get set

四元数ベクトル部 y 成分プロパティ

double FK_CLI::fk_Quaternion::z
| get set

四元数ベクトル部 z 成分プロパティ

fk_Vector^ FK_CLI::fk_Quaternion::v
| get set

四元数ベクトル部プロパティ

fk_Angle^ FK_CLI::fk_Quaternion::Euler
| get set

オイラー角プロパティ

設定の際には、原点を中心とする物体が、 オイラー角 (0, 0, 0) から 与えられたオイラー角の状態に回転する変換を表す四元数を設定します。 参照の際には、 四元数を回転変換として解釈したときに、 オイラー角 (0, 0, 0) の状態の物体が回転したときの 姿勢状態を示すオイラー角となります。 オイラー角についての解説は、 fk_Angle を参照して下さい。

double FK_CLI::fk_Quaternion::Norm
| get

ノルムプロパティ

四元数 のノルム値 を参照します。 のノルム値は、 以下のように定義されます。

double FK_CLI::fk_Quaternion::Abs
| get

絶対値プロパティ

四元数 の絶対値 を参照します。 の絶対値は、 以下のように定義されます。

fk_Matrix^ FK_CLI::fk_Quaternion::Matrix
| get

行列プロパティ

四元数を回転変換と考えたときの、同じ回転変換を意味する行列を参照します。