Hazel引擎学习（一）

我自己维护引擎的github地址在这里，里面加了不少注释，有需要的可以看看

1.SetUp项目，生成的文件在bin目录下，生成的intermediate文件在bin-int目录下，大概是这么个目录结构

注意这里的当前路径都是取的该vxproj文件所在的路径，所以如下图所示，我这么写目录结构 各自对应的bin和bin-int都会在对应的项目文件夹里，如下图所示： 如果要想统一生成在同一个文件夹，能不能这么写： 然而这样VS会警告你，因为把不同的Project里生成的东西放在了同一个文件夹下，这样是不好的，所以最终应该这么写：

2.两个工程，一个叫Hazel，作为引擎，一个叫SandboxApp，作为实际使用的例子, 一个是dll，一个是exe 3.可能要编辑solution的顺序，让sandboxApp在最上面，最为setup project 4.只保留64位平台 5.Hazel相关内容应该放在对应的namespace里面

主要是以下几个任务：

目录结构如下，Core.h用来存放宏的定义，Application用来定义基类

创建EntryPoint 从上面的步骤可知，如果要使用Engine的内容，需要包含Core.h、Application.h，以后还可能会有更多内容，所以为了避免这个情况，添加一个EntryPoint头文件，把所有需要的都放在里面，这样Sandbox就只需要Include一个文件了，在这里，这个EntryPoint文件，叫做Hazel.h

为什么这么设计 这节课的主要目的是创建一个dll对应的Main函数，进行Engine对应的操作，同时，封装一个接口函数，用于创建对应的Application，具体创建Application对象的任务交给了对象，对象需要new出自己的应用对象，继承于Engine里的Application基类，然后把这个指针传过来，之后的内存释放就交给引擎来处理了，因为实际上执行的只有Sandbox.cpp文件，把该cpp包含的#include "Hazel.h"给展开，大致代码如下

碰到的小问题 使用dllexport来导出类的时候，发现对应的dll能生成，但是lib文件不会生成了，而且提示这个报错：

仔细阅读代码后，发现是_delcspec(dllexport)应该写在class的左边：

主要是以下几个任务

游戏引擎少不了LogStystem，这里使用了别人做好的Github项目，叫做spdlog，Cherno使用这个Molude的方式很特别，用到了Github的submodule的特性，这样的好处是，可以直接update该module，而不用再从网上Copy和Paste这个项目，具体操作如下，在对应的Git Bash界面，输入

就一行命令，就能创建对应的文件夹，clone该仓库，而且会在当前目录生成一个类似于.gitignore的.submodule文件，具体内容如下图所示： 关于git submodule add操作，如果网不好的下载速度很慢，如果失败了再add可能会出问题，如果出问题了，可以去把.git文件的modules下对应的文件夹删除，再进行add，我就是这样弄成功的

对于这个LogSystem，底层使用的是spdlog，上层当然得封装一层Hazel的Log类，以下是核心代码：

这里报了个错，记得C++Class内的static对象，需要在类外进行定义，不能只进行声明。

额外的宏操作，这里的宏的写法可以实现函数的宏，代码如下所示：

最后效果如图，还挺好看的

有意思的是 spdlog库的核心内容都是在头文件里通过内联函数使用的，所以只需要包含其头文件就可以，文件里的其他所有文件都被设置为了Excluded From Project，如下图所示，然后我做了个测试，删除了所有的cpp文件，一样能够成功build：

官方给了个简单的模板：

这里的filter一般限定了范围，比如说特定的Windows平台，如下所示：

如上所示，filter相当于筛选器，上述写法，如果是安卓平台的Release模式，则下面的filter还是会执行，如果想限定两个，比如只生在windows的Release情况下的filter，则应该这么写

如果想取消对应filter的限定，则在后面加上这一行即可：

学到了一个单词，叫做token，我原本以为叫做Macro，token表示一些代表符号，比如VS里的$(SolutionDir)，而Premake的宏大概是这么写：

在Github上Premake的Wiki界面搜索Token可以找到对应的一些符号，如下所示：

还可以使用postbuildcommand来实现build完成之后的文件拷贝和复制工作，如下所示：

编写Premake5.lua文件的一点疑惑 由于Sanbox是使用了Hazel的文件的，所以我这么写是对的：

但为什么不可以像下面这么写呢：

具体原因涉及到了VS寻找Header文件的方式了, Visual Studio looks for headers in this order:

如下图所示，红色方框里显示Sandbox加入了Hazel的相关文件，但实际上Visual Studio并不能找到对应的头文件的内容，因为VS会先去寻找sandbox所在的目录，然后找附加include目录，肯定是找不到对应的头文件的，因为这些头文件在Hazel对应项目的文件夹下，如下图所示： 如果在SandboxApp.cpp所在的文件夹加入Hazel.h等相关的所有头文件，则会开始编译Hazel.h了，但是这样就产生了一个问题，在Hazel项目和SandboxApp项目下都各有一个Hazel.h文件，而且这俩文件是一模一样的。

总结： 对于每一个cpp，VS都会先针对其cpp所在的目录，寻找头文件（头文件里包含的头文件的路径也是基于该CPP），然后再去Additional Include Directory里找，注意这个Additional Include Directory里也是只找该目录，并不是该目录里面的所有内容(所以要注意相对路径的问题)，最后才会去VC++ Directories里找。所以，在premake5.lua里，不应该直接把Hazel的头文件加入Sandbox的files列表里。而且从逻辑上讲，files里应该放的是该项目的文件，而不应该包括外来的函数声明。

思路是由Application创建自己的窗口window，对应的window类不应该知道任何Application的信息，所以Application在创建自己的window时，还要同时创建一个callback，在学习这章之前，最好知道以下内容：

我把相关的内容放到附录，方便查看。

现在可以正式开始Event的设计了，首先需要定义的就是Event和EventType类，这里把Event作为基类，EventType是enum class，包含了基本的外设事件，如下所示:

对于Event类型，作为基类，那么最基本的两个接口应该为：

作为基类，这都是最基本的API，再者，为了方便使用，仿照C#的方式，C#语言里所有的Object都有一个ToString函数，方便我们打印一些消息，所以这个API我们也把它加入到Event基类里，如下所示：

目前就是这样，然后我们还需要一个EventTypeFlag枚举，以后用flag来快速筛选特定的Event:

对于string这种拼接，想象的很美好，可惜C++并不能像C#这样简单的组成一个字符串，所以我们需要通过stringstream来完成这个功能，写法如下:

所以我学到了一个方法，用宏去代替我们编写这么长的语句，这个宏名就叫做EVENT_CLASS_TYPE(typename)，来为我们生成对应的函数，通过#和##符号，可以达到这种效果，别记反了,一个#是转换成字符串，两个#是原语句替换，所以就是这么简化：

就像这样，我们可以把所有鼠标事件的类定义好，接下来还需要的定义的输入类就是Window Event、ApplicationEvent和KeyEvent，先说前两种Event，最后着重提一下KeyEvent，键盘事件的输入处理并不像点击鼠标那么简单，通常（简单的事件系统里）我们是没有长按鼠标的操作的，但是却有长按键盘的操作，当我们按键盘时，会先打印一个字母，然后停顿一下，如果这个时候还按着按钮，就继续打印剩余的字母。

所以说，按键的时候，第一次会立马打印第一个字母，然后需要记录我按的次数（或者记录按的时间），当记录的值达到一定阈值（或时间）时，才会继续不停打印接下来的字母，这里我们不用时间记录，而是用一个int值，记录按相同键的次数。

设计KeyEvent类的时候，可以发现，KeyPressedEvent会比KeyReleasedEvent的数据多一个，前者会额外记录按下Key时，key走过的Loop的总数，所以这个时候可以设计一个基类叫做KeyEvent，这里放通用的数据，就是Key的keycode，用于存放Key类型共有的内容，设计思路如下所示：

然后再写对应的子类

不过需要注意的是，std::function不能像一般的函数重载那样，如果我下面这么写，会报错

如下图所示，大意是不知道print到底是什么类型 要写，得这么写，用static_cast进行转换，具体原因我也不理解，以后再深入把，总之std::funtion是一个容器，用来存储callable object

再介绍一个Hazel代码里涉及到的问题，C++中的enum和enum class

C++11中引入了enum class，旨在解决原来的enum的各种缺点，在这里介绍一下之前的Enum类型的三大缺点：

如果加一行下列语句，编译器并不会报错，而是会换另一个更大的数据结构，可能是short，去存储

本来想用8位数保存enum，这种enum就很不安全。而C++11就可以这么写：

所以，enum class 比enum好，好在以下三点：

#：是为其加上双引号，当作字符串处理 ##：是直接进行字符的拼接

在C++的宏中，使用#，可以把#后面的内容加上""符号，当作字符串处理，如下所示：

输出如下，其实就是一些文字代替的简单东西，看习惯了就好了:

关于基类，其虚函数要声明为virtual，在C++里对于子类复写的函数，需不需要加virtual呢？而且在C++11中，提出了新的关键字override，这个关键字又有什么用呢？

首先看这么个例子，下面四种写法都可以成功编译：

直接说重点，对于override的函数，加不加virtual都无所谓，只要基类的虚函数加了virtual就可以了，但override关键字就重要一点了，它可以避免一些bug，因为我们写函数，如果不加override的时候，一旦函数类型写错了，这个函数其实就是一个新的函数，并没有override原来的虚函数，但是编译器不会提示这个错误，这就很蛋疼了，比如下面这个例子：

看看结果，发现写了override的时候才会报错，否则能正常编译，完全不会进行提示： 结论： 以后在定义任何虚函数的时候，都要在声明的最后一句加上关键字override，这是一个代码规范的好习惯

顺便提一个有意思的东西，就是const关键字与函数重载的关系 const与函数重载 函数重载与三个东西有关，参数类型，参数个数和参数之间的顺序有关，但是与返回值无关，那么先提两个问题：

首先看第一个问题，可以举一个例子：

输出结果：

结果能成功运行，且调用了不同的函数，这说明类的成员函数，后面加const和不加const，是两个函数，这是函数重载（C++ allows member methods to be overloaded on the basis of const type）

再看第二种问题，在类中 void A(int){} 和 void A(const int){} 是一个函数还是两个函数，这个问题可以换成，参数里加不加const，构不构成函数重载？

先直接说结论，如果参数是pointer类型或Reference，那么加const属于函数重载，但是其他类型就不属于函数重载了，看下面的代码，这种情况会报错：

输出：

也很好理解，传一个int类型，传递的是值，这个int又不会改变什么东西，所以值类型，加不加const都一样，但是如果用引用，那就完全不一样了，所以这么写是可以的：

输出：