designlab::Vector2 構造体

2次元の位置ベクトルを表す構造体． [詳解]

#include <math_vector2.h>

公開メンバ関数
constexpr	Vector2 ()
constexpr	Vector2 (float x_pos, float y_pos)
constexpr	Vector2 (const Vector2 &other)=default
constexpr	Vector2 (Vector2 &&other) noexcept=default
constexpr Vector2 &	operator= (const Vector2 &other)=default
constexpr Vector2	operator+ () const
constexpr Vector2	operator- () const
constexpr Vector2	operator+ (const Vector2 &other) const
constexpr Vector2	operator- (const Vector2 &other) const
constexpr Vector2	operator* (float s) const
constexpr Vector2	operator/ (float s) const
Vector2 &	operator+= (const Vector2 &other)
Vector2 &	operator-= (const Vector2 &other)
Vector2 &	operator*= (float s)
Vector2 &	operator/= (float s)
constexpr bool	operator== (const Vector2 &other) const
constexpr bool	operator!= (const Vector2 &other) const
constexpr float	GetSquaredLength () const noexcept
	このベクトルの長さの2乗を返す．
float	GetLength () const
	このベクトルの長さを返す．
constexpr float	Dot (const Vector2 &other) const noexcept
	自分・引数 の内積の結果を返す．
constexpr float	Cross (const Vector2 &other) const noexcept
	自分×引数 の外積の結果を返す．
float	GetDistanceFrom (const Vector2 &other) const noexcept
	このベクトルと other の距離を返す．
Vector2	GetNormalized () const
	このベクトルを正規化したベクトルを返す．
constexpr bool	IsZero () const noexcept
	このベクトルが0ならば true．
void	Normalize () noexcept
	このベクトルを正規化する． 絶対値が0のベクトルの場合，そのまま0ベクトルになる．
std::string	ToString () const
	このベクトルを文字列にして返す． (x, y) の形式，小数点以下3桁まで．
std::string	ToCsvString () const
	このベクトルをCSV形式の文字列にして返す． x, y, z の形式，小数点以下3桁まで．

静的公開メンバ関数
static constexpr Vector2	GetZeroVec () noexcept
	零ベクトルを返す． 静的な関数なので Vector2::GetZeroVec() と呼ぶことができる．

公開変数類
float	x
float	y

詳解

2次元の位置ベクトルを表す構造体．

参考

• Vec2 クラスを作る https://qiita.com/Reputeless/items/96226cfe1282a014b147 ( アクセス日 2024/2/29 )

本当はテンプレート構造体にするべき． しかし，実用的に使用するのは2次元，3次元程度であるため， このようにそれぞれ実装する．

math_vector2.h の 30 行目に定義があります。

構築子と解体子

Vector2() [1/4]

constexpr designlab::Vector2::Vector2 ( )

inlineconstexpr

math_vector2.h の 32 行目に定義があります。

被呼び出し関係図:

Vector2() [2/4]

constexpr designlab::Vector2::Vector2 ( float  x_pos, float  y_pos  )

inlineconstexpr

math_vector2.h の 33 行目に定義があります。

Vector2() [3/4]

constexpr designlab::Vector2::Vector2 ( const Vector2 &  other )

constexprdefault

Vector2() [4/4]

constexpr designlab::Vector2::Vector2 ( Vector2 &&  other )

constexprdefaultnoexcept

関数詳解

Cross()

constexpr float designlab::Vector2::Cross ( const Vector2 &  other ) const

inlineconstexprnoexcept

自分×引数 の外積の結果を返す．

引数

[in]

other

他のベクトル．

戻り値

このベクトルと other の外積．

覚え書き

2次元なので，外積はスカラー．

math_vector2.h の 96 行目に定義があります。

被呼び出し関係図:

Dot()

constexpr float designlab::Vector2::Dot ( const Vector2 &  other ) const

inlineconstexprnoexcept

自分・引数 の内積の結果を返す．

引数

[in]

other

他のベクトル．

戻り値

このベクトルと other の内積．

math_vector2.h の 86 行目に定義があります。

被呼び出し関係図:

GetDistanceFrom()

float designlab::Vector2::GetDistanceFrom ( const Vector2 &  other ) const

inlinenoexcept

このベクトルと other の距離を返す．

引数

[in]

other

他のベクトル．

戻り値

このベクトルと other の距離．

math_vector2.h の 105 行目に定義があります。

GetLength()

float designlab::Vector2::GetLength ( ) const

inline

このベクトルの長さを返す．

戻り値

このベクトルの長さ．

覚え書き

sqrtは重いので，長さの2乗を返す GetSquaredLength を使うことを推奨．

math_vector2.h の 80 行目に定義があります。

呼び出し関係図:

被呼び出し関係図:

GetNormalized()

Vector2 designlab::Vector2::GetNormalized

(

)

const

このベクトルを正規化したベクトルを返す．

戻り値

正規化されたベクトル．

math_vector2.cpp の 42 行目に定義があります。

呼び出し関係図:

被呼び出し関係図:

GetSquaredLength()

constexpr float designlab::Vector2::GetSquaredLength ( ) const

inlineconstexprnoexcept

このベクトルの長さの2乗を返す．

戻り値

このベクトルの長さの2乗．

覚え書き

sqrt(ルートの計算)が重いのでこちらを使えるなら使うべき．

math_vector2.h の 74 行目に定義があります。

呼び出し関係図:

被呼び出し関係図:

GetZeroVec()

static constexpr Vector2 designlab::Vector2::GetZeroVec ( )

inlinestaticconstexprnoexcept

零ベクトルを返す． 静的な関数なので Vector2::GetZeroVec() と呼ぶことができる．

戻り値

零ベクトル．

math_vector2.h の 136 行目に定義があります。

呼び出し関係図:

IsZero()

constexpr bool designlab::Vector2::IsZero ( ) const

inlineconstexprnoexcept

このベクトルが0ならば true．

戻り値

このベクトルが0ならば true．

覚え書き

誤差を考慮している．

math_vector2.h の 119 行目に定義があります。

呼び出し関係図:

Normalize()

void designlab::Vector2::Normalize ( )

inlinenoexcept

このベクトルを正規化する．
絶対値が0のベクトルの場合，そのまま0ベクトルになる．

注意

この関数は，このベクトルの値を変更する． GetNormalized は値を変更しない． 間違えないようにすること．

math_vector2.h の 129 行目に定義があります。

呼び出し関係図:

operator!=()

constexpr bool designlab::Vector2::operator!= ( const Vector2 &  other ) const

inlineconstexpr

math_vector2.h の 64 行目に定義があります。

operator*()

constexpr Vector2 designlab::Vector2::operator* ( float  s ) const

inlineconstexpr

math_vector2.h の 51 行目に定義があります。

operator*=()

Vector2 & designlab::Vector2::operator*=

(

float

s

)

math_vector2.cpp の 28 行目に定義があります。

operator+() [1/2]

constexpr Vector2 designlab::Vector2::operator+ ( ) const

inlineconstexpr

math_vector2.h の 38 行目に定義があります。

operator+() [2/2]

constexpr Vector2 designlab::Vector2::operator+ ( const Vector2 &  other ) const

inlineconstexpr

math_vector2.h の 41 行目に定義があります。

operator+=()

Vector2 & designlab::Vector2::operator+=

(

const Vector2 &

other

)

math_vector2.cpp の 14 行目に定義があります。

operator-() [1/2]

constexpr Vector2 designlab::Vector2::operator- ( ) const

inlineconstexpr

math_vector2.h の 39 行目に定義があります。

operator-() [2/2]

constexpr Vector2 designlab::Vector2::operator- ( const Vector2 &  other ) const

inlineconstexpr

math_vector2.h の 46 行目に定義があります。

operator-=()

Vector2 & designlab::Vector2::operator-=

(

const Vector2 &

other

)

math_vector2.cpp の 21 行目に定義があります。

operator/()

constexpr Vector2 designlab::Vector2::operator/ ( float  s ) const

inlineconstexpr

math_vector2.h の 52 行目に定義があります。

operator/=()

Vector2 & designlab::Vector2::operator/=

(

float

s

)

math_vector2.cpp の 35 行目に定義があります。

operator=()

constexpr Vector2 & designlab::Vector2::operator= ( const Vector2 &  other )

constexprdefault

operator==()

constexpr bool designlab::Vector2::operator== ( const Vector2 &  other ) const

inlineconstexpr

math_vector2.h の 59 行目に定義があります。

呼び出し関係図:

ToCsvString()

std::string designlab::Vector2::ToCsvString

(

)

const

このベクトルをCSV形式の文字列にして返す．
x, y, z の形式，小数点以下3桁まで．

戻り値

このベクトルをCSV形式の文字列にしたもの．

math_vector2.cpp の 63 行目に定義があります。

呼び出し関係図:

ToString()

std::string designlab::Vector2::ToString

(

)

const

このベクトルを文字列にして返す．
(x, y) の形式，小数点以下3桁まで．

戻り値

このベクトルを文字列にしたもの．

math_vector2.cpp の 54 行目に定義があります。

呼び出し関係図:

被呼び出し関係図:

メンバ詳解

x

float designlab::Vector2::x

math_vector2.h の 149 行目に定義があります。

y

float designlab::Vector2::y

math_vector2.h の 150 行目に定義があります。

---

この構造体詳解は次のファイルから抽出されました:

• DesignLab/math_vector2.h
• DesignLab/math_vector2.cpp