目录

Param

Class Info

class Param

用来封装数据的类,可以将各种类型的基础数据、自定义数据、枚举类型,使用容器进行封装,方便在插件框架中对数据进行传递。

Public Constructor Summary

Constructor Name

Param()

无参数构造函数。

explicit Param(const bool val)

显式构造函数,布尔形参。

explicit Param(const s32 val)

显式构造函数,32位整型形参。

explicit Param(const f32 val)

显式构造函数,单精度32位浮点数形参。

explicit Param(const f64 val)

显式构造函数,双精度64位浮点数形参。

explicit Param(const Vector2 val)

显式构造函数,二维向量形参。

explicit Param(const Vector3 val)

显式构造函数,三维向量形参。

explicit Param(const Vector4 val)

显式构造函数,四维向量形参。

explicit Param(const Matrix4 val)

显式构造函数,矩阵形参。

explicit Param(const Quaternion val)

显式构造函数,四元数形参。

explicit Param(const Color val)

显式构造函数,颜色形参。

explicit Param(void *val)

显式构造函数,指针形参。

explicit Param(const String &val)

显式构造函数,字符串形参。

explicit Param(const Array &val)

显式构造函数,std::vector<Param>形参。

explicit Param(const Object &val)

显式构造函数,std::map<String, Param>形参。

Public Destructor Summary

Destructor Name

~Param()

析构函数,释放内存。

Public Method Summary

Qualifier and Type

Method Name and Description

void

Set(u32 idx, const Param &param)

向Param类内部容器成员变量std::vector添加数据,idx为要添加的索引号。

void

Set(const String &name, const Param &param)

向Param类内部容器成员变量std::map<String, Param>添加数据。

template<typename T> void

Set(T val)

模板函数,根据传入参数类型设定Param。

char

ParameterType() const

返回Param数据类型。

bool

IsBool() const

判断当前Param类型是否是布尔型。

bool

IsInt() const

判断当前Param类型是否是整型。

bool

IsFloat() const

判断当前Param类型是否是单精度浮点型。

bool

IsDouble() const

判断当前Param类型是否是双精度浮点型。

bool

IsVector2() const

判断当前Param类型是否是二维向量。

bool

IsVector3() const

判断当前Param类型是否是三维向量。

bool

IsVector4() const

判断当前Param类型是否是四维向量。

bool

IsMatrix() const

判断当前Param类型是否是矩阵。

bool

IsQuaternion() const

判断当前Param类型是否是四元数。

bool

IsColor() const

判断当前Param类型是否是颜色。

bool

IsPointer() const

判断当前Param类型是否是指针。

bool

IsString() const

判断当前Param类型是否是字符串。

bool

IsArray() const

判断当前Param类型是否是std::vector。

bool

IsObject() const

判断当前Param类型是否是std::map。

const Param&

Get(u32 idx) const

从std::vector中获取指定下标位置的数据。

const void*

Get() const

获得指针类型数据。

template<typename T>

const T&

Get() const

模板函数,获取常数Param类型。

template<typename T>

T&

Get()

模板函数,获取Param类型。

const Param&

Get(const String &key) const

从std::map中获取对应的数据。

bool

Has(const String &key) const

判断当前Param内部std::map是否包含key。

std::vector<String>

Keys() const

返回std::map包含的所有键。

s32

Size() const

返回当前Param包含的数据总数量。

void

Clear()

将Param数据清空。

size_t

ArrayLen() const

如果当前Param类型是std::vector,返回其长度;否则,返回0。

Public Constructors

[h2]Param()

Constructor

Param()

无参构造函数。

[h2]explicit Param(const bool val)

Constructor

explicit Param(const bool val)

显式构造函数,传入布尔型参数。

Parameters

Name

Description

val

传入布尔型参数。

[h2]explicit Param(const s32 val)

Constructor

explicit Param(const s32 val)

显式构造函数,传入32位整型参数。

Parameters

Name

Description

val

传入32位整型参数。

[h2]explicit Param(const f32 val)

Constructor

explicit Param(const f32 val)

显式构造函数,传入32位单精度浮点型参数。

Parameters

Name

Description

val

传入32位单精度浮点型参数。

[h2]explicit Param(const f64 val)

Constructor

explicit Param(const f64 val)

显式构造函数,传入64位双精度浮点型参数。

Parameters

Name

Description

val

传入64位双精度浮点参数。

[h2]explicit Param(const Vector2 val)

Constructor

explicit Param(const Vector2 val)

显式构造函数,传入二维向量参数。

Parameters

Name

Description

val

传入二维向量参数。

[h2]explicit Param(const Vector3 val)

Constructor

explicit Param(const Vector3 val)

显式构造函数,传入三维向量参数。

Parameters

Name

Description

val

传入三维向量参数。

[h2]explicit Param(const Vector4 val)

Constructor

explicit Param(const Vector4 val)

显式构造函数,传入四维向量参数。

Parameters

Name

Description

val

传入四维向量参数。

[h2]explicit Param(const Matrix4 val)

Constructor

explicit Param(const Matrix4 val)

显式构造函数,传入矩阵参数。

Parameters

Name

Description

val

传入矩阵参数。

[h2]explicit Param(const Quaternion val)

Constructor

explicit Param(const Quaternion val)

显式构造函数,传入四元数参数。

Parameters

Name

Description

val

传入四元数参数。

[h2]explicit Param(const Color val)

Constructor

explicit Param(const Color val)

显式构造函数,传入颜色参数。

Parameters

Name

Description

val

传入颜色参数。

[h2]explicit Param(void *val)

Constructor

explicit Param(void *val)

显式构造函数,传入指针参数。

Parameters

Name

Description

val

传入指针参数。

[h2]explicit Param(const String &val)

Constructor

explicit Param(const String &val)

显式构造函数,传入字符串参数。

Parameters

Name

Description

val

传入字符串参数。

[h2]explicit Param(const Array &val)

Constructor

explicit Param(const Array &val)

显式构造函数,传入std::vector<Param>参数。

Parameters

Name

Description

val

传入std::vector<Param>参数。

[h2]explicit Param(const Object &val)

Constructor

explicit Param(const Object &val)

显式构造函数,传入std::map<String, Param>参数。

Parameters

Name

Description

val

传入std::map<String, Param>参数。

Public Destructors

[h2]~Param()

Destructor

~Param()

析构函数,释放内存。

Public Methods

[h2]Set(u32 idx, const Param &param)

Method

void Set(u32 idx, const Param &param)

向std::vector<Param>中添加或者替换索引号为idx的Param。

Parameters

Name

Description

idx

用于添加Param的下标索引,大于0才有效。

param

将要添加到std::vector<Param>的Param元素。

[h2]Set(const String &name, const Param &param)

Method

void Set(const String &name, const Param &param)

向std::map<String, Param>中添加param,name为对应的键。

Parameters

Name

Description

name

要添加Param对应的键。

param

将要添加到std::map<String, Param>中的Param值。

[h2]Set(T val)

Method

template<typename T> void Set(T val)

模板函数,根据传入参数类型设定Param。

Parameters

Name

Description

val

赋予当前Param的数据类型。

[h2]Get(u32 idx)

Method

const Param &Get(u32 idx) const

从std::vector<Param>中返回下标为idx的Param。

Parameters

Name

Description

idx

用于查找Param的下标索引。

Returns

Type

Description

const Param &

返回对应下标索引值的Param,如果找不到,返回空值。

[h2]Get(const String &key)

Method

const Param &Get(const String &key) const

从std::map中获取对应的数据。

Parameters

Name

Description

key

用于查找Param的下标索引。

Returns

Type

Description

const Param &

返回对应下标索引值的Param,如果找不到,返回空值。

[h2]const void* Get() const

Method

const void* Get() const

获取指针类型数据。

Returns

Type

Description

const void *

返回指针。

[h2]template<typename T> const T& Get() const

Method

template<typename T> const T& Get() const

模板函数,获取常量Param的类型。

Returns

Type

Description

template<typename T> const T&

返回Param类型。

[h2]template<typename T> T& Get()

Method

template<typename T> T& Get()

模板函数,获取Param的类型。

Returns

Type

Description

template<typename T> T&

返回Param类型。

[h2]ParameterType

Method

char ParameterType() const

返回Param类型。

Returns

Type

Description

char

将ParameterType转为char,返回char。

[h2]IsBool

Method

bool IsBool() const

判断当前Param类型是否是布尔型。

Returns

Type

Description

bool

  • true:布尔型。
  • false:非布尔型。

[h2]IsInt

Method

bool IsInt() const

判断当前Param类型是否是整型。

Returns

Type

Description

bool

  • true:是整型。
  • false:不是整型。

[h2]IsFloat

Method

bool IsFloat() const

判断当前Param类型是否是单精度浮点型。

Returns

Type

Description

bool

  • true:是单精度浮点型。
  • false:不是单精度浮点型。

[h2]IsDouble

Method

bool IsDouble() const

判断当前Param类型是否是双精度浮点型。

Returns

Type

Description

bool

  • true:是双精度浮点型。
  • false:不是双精度浮点型。

[h2]IsVector2

Method

bool IsVector2() const

判断当前Param类型是否是二维向量。

Returns

Type

Description

bool

  • true:是二维向量。
  • false:不是二维向量。

[h2]IsVector3

Method

bool IsVector3() const

判断当前Param类型是否是三维向量。

Returns

Type

Description

bool

  • true:是三维向量。
  • false:不是三维向量。

[h2]IsVector4

Method

bool IsVector4() const

判断当前Param类型是否是四维向量。

Returns

Type

Description

bool

  • true:是四维向量。
  • false:不是四维向量。

[h2]IsMatrix

Method

bool IsMatrix() const

判断当前Param类型是否是矩阵。

Returns

Type

Description

bool

  • true:是矩阵。
  • false:不是矩阵。

[h2]IsQuaternion

Method

bool IsQuaternion() const

判断当前Param类型是否是四元数。

Returns

Type

Description

bool

  • true:是四元数。
  • false:不是四元数。

[h2]IsColor

Method

bool IsColor() const

判断当前Param类型是否是颜色。

Returns

Type

Description

bool

  • true:是颜色。
  • false:不是颜色。

[h2]IsPointer

Method

bool IsPointer() const

判断当前Param类型是否是指针。

Returns

Type

Description

bool

  • true:是指针。
  • false:不是指针。

[h2]IsString

Method

bool IsString() const

判断当前Param类型是否是字符串。

Returns

Type

Description

bool

  • true:是字符串。
  • false:不是字符串。

[h2]IsArray

Method

bool IsArray() const

判断当前Param类型是否是std::vector。

Returns

Type

Description

bool

  • true:是std::vector。
  • false:不是std::vector。

[h2]IsObject

Method

bool IsObject() const

判断当前Param类型是否是std::map。

Returns

Type

Description

bool

std::map返回true,否则返回false。

[h2]Has

Method

bool Has(const String &key) const

查找是否包含传入key。只对std::map类型Param有效,如果不是std::map直接返回false。

Parameters

Name

Description

key

待查找的键,用于在std::map中查询。

Returns

Type

Description

bool

查找是否包含传入key。

  • true:包含。
  • false:不包含或不是std::map类型Param。

[h2]Keys

Method

std::vector<String> Keys() const

只对std::map类型Param起作用,如果不是std::map直接返回空vector。

获得std::map包含的所有key,以std::vector<String>形式传出。

Returns

Type

Description

std::vector<String>

返回包含的所有key。

[h2]Size

Method

s32 Size() const

返回当前Param包含的数据总数量,如果不是std::map类型,也不是std::vector,返回0。

Returns

Type

Description

s32

返回总数据量。

[h2]Clear

Method

void Clear()

将Param数据清空。

[h2]ArrayLen

Method

size_t ArrayLen() const

如果当前Param类型是std::vector,返回其长度;否则,返回0。

Returns

Type

Description

size_t

如果当前Param类型是std::vector,返回数据长度;否则,返回0。