目录

Vector2

Class Info

class Vector2

二维向量类。包括二维向量的取负、加法、减法、乘法、除法、点乘计算。

Public Field Summary

Qualifier and Type

Field and Description

Value

f32

x

二维向量的X分量

-

f32

y

二维向量的Y分量

-

const Vector2

ZERO

零向量,记为ZERO

(0, 0)

const Vector2

ONE

X、Y分量均为1,记为ONE

(1, 1)

const Vector2

UP

X分量为0,Y分量为1,记为UP

(0, 1)

const Vector2

DOWN

X分量为0,Y分量为-1,记为DOWN

(0, -1)

const Vector2

LEFT

X分量为-1,Y分量为0,记为LEFT

(-1, 0)

const Vector2

RIGHT

X分量为1,Y分量为0,记为RIGHT

(1, 0)

const Vector2

UNIT_X

X轴上单位向量,记为UNIT_X

(1, 0)

const Vector2

UNIT_Y

Y轴上单位向量,记为UNIT_Y

(0, 1)

const Vector2

NEGATIVE_UNIT_X

X轴负方向单位向量,记为NEGATIVE_UNIT_X

(-1, 0)

const Vector2

NEGATIVE_UNIT_Y

Y轴负方向单位向量,记为NEGATIVE_UNIT_Y

(0, -1)

Public Constructor Summary

Constructor Name

Vector2()

构造函数,初始化二维向量的X、Y分量为0。

Vector2(f32 nx, f32 ny)

构造函数,使用nx、ny初始化二维向量的X、Y分量。

Public Destructor Summary

Destructor Name

~Vector2()

析构函数。

Public Method Summary

Qualifier and Type

Method Name and Description

Vector2

operator-() const

重载-(取负)运算符,对当前对象的X、Y分量取负。

Vector2&

operator=(const Vector2& other)

重载赋值运算符,使用Vector2类对象给当前对象赋值。

Vector2

operator+(const Vector2& other) const

重载+运算符,用于当前对象和指定Vector2类对象间的加法运算。

Vector2&

operator+=(const Vector2& other)

重载+=运算符,用于当前对象和指定Vector2类对象间的加法运算。

Vector2

operator-(const Vector2& other) const

重载-运算符,用于当前对象和指定Vector2类对象间的减法运算。

Vector2&

operator-=(const Vector2& other)

重载-=运算符,用于当前对象和指定Vector2类对象间的减法运算。

Vector2

operator*(const f32 v) const

重载*运算符,用于当前对象和指定浮点类型对象间的乘法运算。

Vector2&

operator*=(const f32 v)

重载*=运算符,用于当前对象和指定浮点类型对象间的乘法运算。

Vector2

operator/(const f32 v) const

重载/运算符,用于当前对象和指定浮点类型对象间的除法运算。

Vector2&

operator/=(const f32 v)

重载/=运算符,用于当前对象和指定浮点类型对象间的除法运算。

bool

operator==(const Vector2& other) const

重载==运算符,比较当前对象和指定Vector2类对象是否相等,相等返回true,不相等返回false。

bool

operator!=(const Vector2& other) const

重载!=运算符,比较当前对象和指定Vector2类对象是否不相等,不相等返回true,相等返回false。

f32

Length() const

计算当前二维向量的模。

f32

Dot(const Vector2& other) const

二维向量的点乘运算。

Vector2

Normalize()

二维向量归一化计算。

String

ToString() const

二维向量转字符串类型,形如“(x, y)”。

Public Constructors

[h2]Vector2

Constructor

Vector2()

构造函数,初始化二维向量的X、Y分量为0。

[h2]Vector2(f32 nx, f32 ny)

Constructor

Vector2(f32 nx, f32 ny)

构造函数,使用nx、ny初始化二维向量的X、Y分量。

Parameters

Name

Description

nx

初始化X分量的值。

ny

初始化Y分量的值。

Public Destructors

[h2]~Vector2

Destructor

~Vector2()

析构函数。

Public Methods

[h2]operator-

Method

Vector2 operator-() const

重载-(取负)运算符,对当前对象的X、Y分量取负。

Returns

Type

Description

Vector2

返回记录取负结果的Vector2类对象。

[h2]operator=

Method

Vector2& operator=(const Vector2& other)

重载赋值运算符,使用Vector2类对象给当前对象赋值。

Parameters

Name

Description

other

给当前对象赋值的Vector2类对象。

Returns

Type

Description

Vector2&

返回赋值后对当前对象的引用。

[h2]operator+

Method

Vector2 operator+(const Vector2& other) const

重载+运算符,用于当前对象和指定Vector2类对象间的加法运算。

Parameters

Name

Description

other

与当前对象进行加法运算的Vector2类对象。

Returns

Type

Description

Vector2

返回记录加法结果的Vector2类对象。

[h2]operator+=

Method

Vector2& operator+=(const Vector2& other)

重载+=运算符,用于当前对象和指定Vector2类对象间的加法运算。

Parameters

Name

Description

other

与当前对象进行加法运算的Vector2类对象。

Returns

Type

Description

Vector2&

返回记录加法结果的当前对象的引用。

[h2]operator-(const Vector2& other)

Method

Vector2 operator-(const Vector2& other) const

重载-运算符,用于当前对象和指定Vector2类对象间的减法运算。

Parameters

Name

Description

other

与当前对象进行减法运算并作为减数的Vector2类对象。

Returns

Type

Description

Vector2

返回记录减法结果的Vector2类对象。

[h2]operator-=

Method

Vector2& operator-=(const Vector2& other)

重载-=运算符,用于当前对象和指定Vector2类对象间的减法运算。

Parameters

Name

Description

other

与当前对象进行减法运算并作为减数的Vector2类对象。

Returns

Type

Description

Vector2&

返回记录减法结果的当前对象的引用。

[h2]operator*

Method

Vector2 operator*(const f32 v) const

重载*运算符,用于当前对象和指定浮点类型对象间的乘法运算。

Parameters

Name

Description

v

与当前对象进行乘法运算的浮点类型对象。

Returns

Type

Description

Vector2

返回记录乘法结果的Vector2类对象。

[h2]operator*=

Method

Vector2& operator*=(const f32 v)

重载*=运算符,用于当前对象和指定浮点类型对象间的乘法运算。

Parameters

Name

Description

v

与当前对象进行乘法运算的浮点类型对象。

Returns

Type

Description

Vector2&

返回记录乘法结果的当前对象的引用。

[h2]operator/

Method

Vector2 operator/(const f32 v) const

重载/运算符,用于当前对象和指定浮点类型对象间的除法运算。

Parameters

Name

Description

v

与当前对象进行除法运算并作为除数的浮点类型对象。

Returns

Type

Description

Vector2

返回记录除法结果的Vector2类对象。

[h2]operator/=

Method

Vector2& operator/=(const f32 v)

重载/=运算符,用于当前对象和指定浮点类型对象间的除法运算。

Parameters

Name

Description

v

与当前对象进行除法运算并作为除数的浮点类型对象。

Returns

Type

Description

Vector2&

返回记录除法结果的当前对象的引用。

[h2]operator==

Method

bool operator==(const Vector2& other) const

重载==运算符,比较当前对象和指定Vector2类对象是否相等,相等返回true,不相等返回false。

Parameters

Name

Description

other

与当前对象进行比较的Vector2类对象。

Returns

Type

Description

bool

  • true:相等。
  • false:不相等。

[h2]operator!=

Method

bool operator!=(const Vector2& other) const

重载!=运算符,比较当前对象和指定Vector2类对象是否不相等,不相等返回true,相等返回false。

Parameters

Name

Description

other

与当前对象进行比较的Vector2类对象。

Returns

Type

Description

bool

  • true:不相等。
  • false:相等。

[h2]Length

Method

f32 Length() const

计算当前二维向量的模。

Returns

Type

Description

f32

返回浮点类型的二维向量的模。

[h2]Dot

Method

f32 Dot(const Vector2& other) const

二维向量的点乘运算。

Parameters

Name

Description

other

与当前对象进行点乘运算的二维向量。

Returns

Type

Description

f32

浮点类型点乘运算结果。

[h2]Normalize

Method

Vector2& Normalize()

二维向量归一化计算。

Returns

Type

Description

Vector2&

返回归一化后的当前二维向量的引用。

[h2]ToString

Method

String ToString() const

二维向量转字符串类型,形如“(x, y)”。

Returns

Type

Description

String

返回二维向量转换成的字符串,返回值形如“(x, y)”。