跳转到主要内容

代码结构

本节介绍了TouchGFX项目的结构——从TouchGFX Designer生成的代码到用户编写的扩展代码。

生成的代码和用户代码

TouchGFX Designer生成的代码将与用户编写的代码完全分离。 事实上,生成的代码位于generated/gui_generated文件夹中,而手写代码位于gui文件夹中。

gui_generated代码充当用户代码类的基类。 基类包含在TouchGFX Designer中配置的所有设置代码。 下面的类示意图显示了类的关系:

引擎类、生成类和用户类的类层次结构

如上图所示,TouchGFX Designer应用包含3个不同代码层:

  • 引擎:这些类是TouchGFX提供的标准类。 它们充当生成类的基类。
  • 生成:当TouchGFX Designer生成代码时,将生成这些类和相应文件。 因此,不应手动编辑这些类和文件,因为任何手动修改都会在下一次运行代码生成器时被重写。 这些类是用户类的基类。
  • 用户:这些类预定供手写代码使用。 用户可以自由地将任何代码放入该层。 如果没有用户类,将生成用户类,并且永远不会被TouchGFX Designer修改。 它们属于用户
Note
TouchGFX Designer生成的应用的架构是开放式的,在某种意义上,对您的创建内容应当没有任何限制。 如果TouchGFX Designer不支持某些对象(如小工具、动画或效果),您可以将它们添加到用户类。 TouchGFX Designer生成的代码在设计上不会对制作TouchGFX应用的方式加以限制。

TouchGFX Designer生成的文件

根据规则,TouchGFX Designer将在TouchGFX项目的generated文件夹中重新生成文件,因此不得在该文件进行手动编辑,因为会被覆盖。 但是,TouchGFX Designer还可以生成编译所需的缺失文件,如assets/images/__designer中的application.configsimulator/main.cpp和皮肤图像。 事实上,TouchGFX Designer只需要下列文件就能生成、编译和运行项目:

  • 描述项目的.touchgfx文件
  • 位于gui文件夹的用户代码(如果有)
  • 位于assets/images文件夹的用户图像(如果有)
  • assets/texts/texts.xlsx文件中的文本(如果有)
  • 位于assets/fonts文件夹的字体(如果有)
Tip
在使用版本控制(如Git)时,这意味着实际上只需要将上面列出的文件提交到存储库。 其余的由TouchGFX Designer自己生成。

示例

下面是一个同时拥有生成代码和用户代码的应用的简单示例。 该示例应能更详细地说明以上情况。

TouchGFX Designer视图

下面的示例只有一个屏幕。 屏幕MyScreen包含一个方框box1和一个按钮button1。 我们设置了在点击button1时调用虚函数setRandomColor()的交互。

TouchGFX Designer应用

当按下按钮时,我们想要让背景框的颜色变为新的随机色。 为了演示如何编写您自己的自定义代码,我们将在用户代码中实现此行为。

下面是该示例中涉及的不同类:

类的示例

我们可以看到:

  • MyScreenViewBaseFrontendApplicationBaseFrontendHeapBase位于生成空间,这表明:
    • 在TouchGFX Designer中执行更改时,会重新生成这些类
    • 用户不应手动编辑这些类
  • MyScreenViewMyScreenPresenterFrontendApplicationFrontendHeap是在用户代码中创建的,这表明:
    • 在TouchGFX Designer中执行更改时,不会重新生成这些类。
    • 用户可以在这里自由地添加自定义代码
  • box1button1的所有设置都在生成的视图基类MyScreenViewBase中完成。
  • 用于屏幕之间过渡的所有函数都位于生成的应用基类FrontendApplicationBase中。
  • 用于确保分配了适量存储空间的所有记帐均位于生成的堆基类FrontendHeapBase中。

用户可以自由地编辑用户代码类。 例如,您可以添加更多小工具。 目前,我们只实现setRandomColor函数来实际更改box1的颜色。

代码

在视图基础代码中,可以看到TouchGFX Designer生成的方框和按钮设置。 我们还看到了buttonCallbackHandler中虚函数setRandomColor的设置和调用,但此刻该函数还没有任何操作:

MyApplication/generated/gui_generated/src/my_screen/MyScreenViewBase.cpp
/*********************************************************************************/
/********** THIS FILE IS GENERATED BY TOUCHGFX DESIGNER, DO NOT MODIFY ***********/
/*********************************************************************************/
#include <gui_generated/myscreen_screen/MyScreenViewBase.hpp>
#include <touchgfx/Color.hpp>
#include "BitmapDatabase.hpp"

MyScreenViewBase::MyScreenViewBase() :
buttonCallback(this, &MyScreenViewBase::buttonCallbackHandler)
{
box1.setPosition(0, 0, 800, 480);
box1.setColor(touchgfx::Color::getColorFrom24BitRGB(255, 255, 255));

button1.setXY(155, 106);
button1.setBitmaps(touchgfx::Bitmap(BITMAP_BLUE_BUTTONS_ROUND_EDGE_SMALL_ID), touchgfx::Bitmap(BITMAP_BLUE_BUTTONS_ROUND_EDGE_SMALL_PRESSED_ID));
button1.setAction(buttonCallback);

add(box1);
add(button1);
}

void MyScreenViewBase::setupScreen()
{

}

void MyScreenViewBase::buttonCallbackHandler(const touchgfx::AbstractButton& src)
{
if (&src == &button1)
{
//Interaction1
//When button1 clicked call virtual function
//Call setRandomColor
setRandomColor();
}
}

在视图基类的头文件中,我们看到了setRandomColor的声明和重写并实现用户代码中函数的指令:

MyApplication/generated/gui_generated/src/my_screen/MyScreenViewBase.hpp
/*********************************************************************************/
/********** THIS FILE IS GENERATED BY TOUCHGFX DESIGNER, DO NOT MODIFY ***********/
/*********************************************************************************/
#ifndef MYSCREENVIEWBASE_HPP
#define MYSCREENVIEWBASE_HPP

#include <gui/common/FrontendApplication.hpp>
#include <mvp/View.hpp>
#include <gui/myscreen_screen/MyScreenPresenter.hpp>
#include <touchgfx/widgets/Box.hpp>
#include <touchgfx/widgets/Button.hpp>

class MyScreenViewBase : public touchgfx::View<MyScreenPresenter>
{
public:
MyScreenViewBase();
virtual ~MyScreenViewBase() {}
virtual void setupScreen();

/*
* Virtual Action Handlers
*/
virtual void setRandomColor()
{
// Override and implement this function in MyScreen
}

protected:
FrontendApplication& application() {
return *static_cast<FrontendApplication*>(touchgfx::Application::getInstance());
}

/*
* Member Declarations
*/
touchgfx::Box box1;
touchgfx::Button button1;

private:

/*
* Callback Declarations
*/
touchgfx::Callback<MyScreenViewBase, const touchgfx::AbstractButton&> buttonCallback;

/*
* Callback Handler Declarations
*/
void buttonCallbackHandler(const touchgfx::AbstractButton& src);

};

#endif // MYSCREENVIEWBASE_HPP

下面进行具体操作。 导航到用户代码头文件MyScreenView.hpp并重写函数:

MyApplication/generated/gui_generated/src/my_screen/MyScreenView.hpp
#ifndef MYSCREENVIEW_HPP
#define MYSCREENVIEW_HPP

#include <gui_generated/myscreen_screen/MyScreenViewBase.hpp>
#include <gui/myscreen_screen/MyScreenPresenter.hpp>

class MyScreenView : public MyScreenViewBase
{
public:
MyScreenView();
virtual ~MyScreenView() {}
virtual void setupScreen();
virtual void tearDownScreen();
virtual void setRandomColor();
protected:
};

#endif // MYSCREENVIEW_HPP

然后,我们需要在MyScreenView的cpp文件中实现setRandomColor的实际行为:

MyApplication/gui/src/my_screen/MyScreenView.cpp
#include <gui/myscreen_screen/MyScreenView.hpp>
#include <touchgfx/Color.hpp>
#include <stdlib.h>

MyScreenView::MyScreenView()
{

}

void MyScreenView::setupScreen()
{
MyScreenViewBase::setupScreen();
}

void MyScreenView::tearDownScreen()
{
MyScreenViewBase::tearDownScreen();
}

void MyScreenView::setRandomColor()
{
box1.setColor(touchgfx::Color::getColorFrom24BitRGB(rand()&0xff, rand()&0xff, rand()&0xff));
box1.invalidate();
}

现在运行模拟器,结果显示我们已成功利用生成代码和用户代码创建了一个简单应用 - 现在每次您点击按钮时,背景框都会变为随机色。

展示应用的模拟器

Tip
当然,您无需使用TouchGFX Designer生成的代码的任何特性,但它有可能节约很多时间。 可以用传统的方式制作TouchGFX应用,只需手动添加必要的文件。

此外,还可以进行混合和匹配。 例如,可以使用并非在TouchGFX Designer项目中定义的屏幕。 您可以将 gotoXYZ 函数添加到FrontendApplication类,并将您的屏幕需要的视图、呈现器和转换添加到 FrontendHeap。.