CEGUI添加自定义控件

转载

深圳市贝福科技 2013-08-01 18:58:00

文章标签 控件 #include 新控件官网 #define 文章分类 代码人生

用CEGUI做界面将近3个月了，比较忙，而且自己懒了许多，没能像以前那样抽出大量时间研究CEGUI，查阅更多的资料书籍，只是在工作间隙，将官网上的一些资料和同事推荐的《CEGUI深入解析》看了看。

国人写的这本书还是不错的，从中我学到的一些CEGUI很重要的知识，希望更多的中国人出更多的技术书籍，让后人受益。这本书我断断续续3个月才看完，实在是看得很慢。最近两天有时间，在看完之后，为了加深自己的理解，根据书中的推荐，写了一个Timer控件，来熟悉一些CEGUI的控件创建，使用过程。在这过程中，有些地方不好搞，特别是CEGUILayoutEditor编辑器的源码编译比较麻烦，不过用了一天时间，基本搞通了整个流程，这里记录总结一下，以便日后回顾。

本人使用CEGUI 0.7.4 和 CEGUILayoutEditor 0.7.1(因为官网主页最新的是0.7.1的）

创建控件对应的头文件和源文件

cegui将控件相关的头文件放到include/elements目录下，将控件相关的源文件放在src/elements目录下。
计时器控件的两个基本功能：

可以给控件设置图片。
可以显示文本，且文本会每秒更新。
提供每秒更新事件，以及倒计时结束事件，这样用户可以设置自己的回调函数。

通过分析，我们的计时器控件只需要继承自CEGUI::PushButton控件即可，将其所有图片设置同一张背景图。然后在控件的构造函数中，订阅窗口每帧的更新事件，并在事件处理函数中完成计时，文本显示，触发事件等功能。下面是计时器控件的属性相关代码：

/***********************************************************************
    filename:   CEGUITimerWindowProperties.h
    created:    7/31/2013
    author:     xujie
*************************************************************************/

#ifndef _CEGUITimerWindowProperties_h_
#define _CEGUITimerWindowProperties_h_

#include "CEGUIProperty.h"


// Start of CEGUI namespace section
namespace CEGUI
{


namespace TimerWindowProperties
{
class TimerFormatText : public Property
{
public:
	TimerFormatText() : Property(
		"TimerFormatText",
		"Property to get/set the text of timer.  Value is a String.",//$(CurrentTime)
		"$(CurrentTime)")
	{}

	String	get(const PropertyReceiver* receiver) const;
	void	set(PropertyReceiver* receiver, const String& value);
};

class TotalTime : public Property
{
public:
    TotalTime() : Property(
        "TotalTime",
        "Property to get/set the total time of timer.  Value is a String.",
        "15")
    {}

    String	get(const PropertyReceiver* receiver) const;
    void	set(PropertyReceiver* receiver, const String& value);
};

}

} // End of  CEGUI namespace section


#endif	// end of guard _CEGUIFrameWindowProperties_h_

/***********************************************************************
    filename:   CEGUITimerWindowProperties.h
    created:    7/31/2013
    author:     xujie
*************************************************************************/
#include "elements/CEGUITimerWindowProperties.h"
#include "elements/CEGUITimerWindow.h"
#include "CEGUIPropertyHelper.h"
#include "CEGUIExceptions.h"


// Start of CEGUI namespace section
namespace CEGUI
{

namespace TimerWindowProperties
{
String	TimerFormatText::get(const PropertyReceiver* receiver) const
{
	return static_cast<const TimerWindow*>(receiver)->GetTimerFormatText();
}


void	TimerFormatText::set(PropertyReceiver* receiver, const String& value)
{
	static_cast<TimerWindow*>(receiver)->SetTimerFormatText( value );
}

String	TotalTime::get(const PropertyReceiver* receiver) const
{
    return PropertyHelper::floatToString( static_cast<const TimerWindow*>(receiver)->GetTotalTime() );
}


void	TotalTime::set(PropertyReceiver* receiver, const String& value)
{
    static_cast<TimerWindow*>(receiver)->SetTimer( PropertyHelper::stringToFloat( value ) );
}

}

} // End of  CEGUI namespace section

我为计时器设置了两个属性。

计时器格式化字符串属性。这个属性是方便用户再CEGUILayoutEditor进行设置的，比如：“还有$(CurrentTime)进入竞技场”，其中的$(CurrentTime)代表当前控件的事件。控件设置窗口文本时，会将$(CurrentTime)替换为秒数。我们这里不做太多复杂的时间格式（年-月-日-小时-分钟-秒），因为主要是为了熟悉控件创建流程。
总时间属性。这个属性表示计时器控件倒计时的总时间。如15秒钟，那么计时器就会倒计时15秒。

下面是计时器控件的逻辑代码：

/***********************************************************************
    filename:   CEGUITimerWindow.h
    created:    7/31/2013
    author:     xujie

    purpose:    Interface to a default window
*************************************************************************/

#ifndef _CEGUITimerWindow_h_
#define _CEGUITimerWindow_h_

#include "CEGUIPushButton.h"
#include "CEGUITimerWindowProperties.h"

#if defined(_MSC_VER)
#	pragma warning(push)
#	pragma warning(disable : 4251)
#endif

// Start of CEGUI namespace section
namespace CEGUI
{
class CEGUIEXPORT TimerWindow : public PushButton
{
public:
    /*************************************************************************
        Constants
    *************************************************************************/
    // type name for th is widget
    static const String WidgetTypeName;             //!< The unique typename of this widget
    static const String EventNamespace;

    static const String EventTimerEnded;
    static const String EventOneSecondPast;

    static TimerWindowProperties::TimerFormatText TimerFormatTextProperty;
    static TimerWindowProperties::TotalTime TotalTimeProperty;
    /*************************************************************************
        Construction and Destruction
    *************************************************************************/
    /*!
    \brief
        Constructor for GUISheet windows.
    */
    TimerWindow(const String& type, const String& name);


    /*!
    \brief
        Destructor for GUISheet windows.
    */
    virtual ~TimerWindow(void) {}

    void SetTimer( float fTotalTime );
    float GetTotalTime() const;
    float GetCurrentTime() const;

    void SetTimerFormatText( const String& strFormatText );
    const String& GetTimerFormatText() const;

protected:
    void SetTimerText( int nSecond );

protected:
    bool OnUpdate( const CEGUI::EventArgs& Arg );
	/*!
	\brief
		Return whether this window was inherited from the given class name at some point in the inheritance hierarchy.

	\param class_name
		The class name that is to be checked.

	\return
		true if this window was inherited from \a class_name. false if not.
	*/
	virtual bool	testClassName_impl(const String& class_name) const
	{
		if (class_name=="TimerWindow")	return true;
		return Window::testClassName_impl(class_name);
	}

private:
    float m_fTotalTime;
    float m_fCurrentTime;
    String m_strTimerFormatText;
};
} // End of  CEGUI namespace section


#endif

/***********************************************************************
    filename:   CEGUITimerWindow.cpp
    created:    7/31/2013
    author:     xujie

    purpose:    Interface to a default window
*************************************************************************/

#include "elements/CEGUITimerWindow.h"
#include <sstream>


// Start of CEGUI namespace section
namespace CEGUI
{
/*************************************************************************
	Constants
*************************************************************************/
// type name for this widget
const String TimerWindow::WidgetTypeName( "CEGUI/TimerWindow" );
const String TimerWindow::EventNamespace( "TimerWindow" );

const String TimerWindow::EventTimerEnded( "TimerEnded" );
const String TimerWindow::EventOneSecondPast( "OneSecondPast" );

TimerWindowProperties::TimerFormatText TimerWindow::TimerFormatTextProperty;
TimerWindowProperties::TotalTime TimerWindow::TotalTimeProperty;


/*************************************************************************
    Constructor
*************************************************************************/
TimerWindow::TimerWindow(const String& type, const String& name) :
    PushButton(type, name), 
    m_fTotalTime( 0 ), 
    m_fCurrentTime( 0 ),
    m_strTimerFormatText( "$(CurrentTime)" )
{
    subscribeEvent( 
        CEGUI::Window::EventWindowUpdated, 
        CEGUI::Event::Subscriber( &TimerWindow::OnUpdate, this ) );

    addProperty( &TimerFormatTextProperty );
    addProperty( &TotalTimeProperty );
}

void TimerWindow::SetTimer( float fTotalTime )
{
    m_fTotalTime = fTotalTime;
    m_fCurrentTime = fTotalTime;
}

float TimerWindow::GetTotalTime() const
{
    return m_fTotalTime;
}

float TimerWindow::GetCurrentTime() const
{
    return m_fCurrentTime;
}

void TimerWindow::SetTimerFormatText( const String& strFormatText )
{
    m_strTimerFormatText = strFormatText;
}

const String& TimerWindow::GetTimerFormatText() const
{
    return m_strTimerFormatText;
}

void TimerWindow::SetTimerText( int nSecond )
{
    String strCurrentTimeTag( "$(CurrentTime)" );

    //get current time text
    std::stringstream ss;
    ss << nSecond;
    String strCurrentTimeText = ss.str().c_str();

    //replace current time tag to real time text
    String strText = m_strTimerFormatText;
    String::size_type nCurrentTimeTagIndex = strText.find( strCurrentTimeTag );
    if( String::npos != nCurrentTimeTagIndex )
    {
        strText.replace( nCurrentTimeTagIndex, strCurrentTimeTag.size(), strCurrentTimeText );
    }

    setText( strText );
}

bool TimerWindow::OnUpdate( const CEGUI::EventArgs& Arg )
{
    const CEGUI::UpdateEventArgs* pUpdateEventArg = dynamic_cast< const CEGUI::UpdateEventArgs* >( &Arg );
    if( NULL == pUpdateEventArg )
    {
        return false;
    }

    if( m_fCurrentTime < 0.0f )
    {
        return true;
    }

    float fPreviousTime = m_fCurrentTime;
    m_fCurrentTime -= pUpdateEventArg->d_timeSinceLastFrame;

    //one second pasts
    if( ( int )fPreviousTime != ( int )m_fCurrentTime  )//if the two variables are positive
    {
        CEGUI::UpdateEventArgs oArg = *pUpdateEventArg;

        fireEvent( EventOneSecondPast, oArg, EventNamespace );
        SetTimerText( ( int )fPreviousTime );
    }

    //one second pasts and timer ended
    if( fPreviousTime * m_fCurrentTime < 0.0f )//if m_fCurrentTime is less than 0
    {
        CEGUI::UpdateEventArgs oArg = *pUpdateEventArg;

        fireEvent( EventOneSecondPast, oArg, EventNamespace );
        fireEvent( EventTimerEnded, oArg, EventNamespace );
        SetTimerText( ( int )fPreviousTime );
    }

    return true;
}

//----------------------------------------------------------------------------//
}

代码具体含义不做解释了，逻辑还是比较简单的。这些文件我都是先拷贝CEGUI原本的一些控件代码，然后更改的。其实可以做一个CEGUI新控件模板文件，这样以后添加新控件就方便多了。
控件的逻辑模块就完成了，我们还需要将控件加到CEGUI系统中，在System::addStandardWindowFactories()函数中，添加一行：

WindowFactoryManager::addFactory< TplWindowFactory<TimerWindow> >();

这样就可以创建控件了。但是控件还没有LookNFeel和渲染窗口类。但因为我们是继承CEGUI::PushButton，而且没有添加新的渲染信息，所以我们可以直接复用CEGUI::PushButton的LooknFeel和渲染窗口类。我们在datafiles\schemes\TaharezLook.scheme和datafiles\schemes\TaharezLookWidgets.scheme两个文件中添加如下一行xml文本。

<FalagardMapping WindowType="TaharezLook/TimerWindow" TargetType="CEGUI/TimerWindow"  Renderer="Falagard/Button"       LookNFeel="TaharezLook/Button" />

其中两个文件中，第一个是给CEGUI系统用的，第二个是给CEGUILayoutEditor用的。

完成这些步骤，我们可以在CEGUI的sample中写相应代码创建TimerWindow控件了。

CEGUI::TimerWindow* pTimerWindow = dynamic_cast< CEGUI::TimerWindow* >( 
        CEGUI::WindowManager::getSingleton().createWindow( "TaharezLook/TimerWindow", "Root/TimerWindow" ) );
    if( pTimerWindow )
    {
        pTimerWindow->setProperty( "NormalImage", "set:TaharezLook image:ButtonMiddleNormal" );
        pTimerWindow->setProperty( "HoverImage", "set:TaharezLook image:ButtonMiddleNormal" );
        pTimerWindow->setProperty( "PushedImage", "set:TaharezLook image:ButtonMiddleNormal" );
        pTimerWindow->setProperty( "DisabledImage", "set:TaharezLook image:ButtonMiddleNormal" );
        pTimerWindow->setPosition( CEGUI::UVector2( cegui_absdim( 0 ), cegui_absdim( 200 ) ) );
        pTimerWindow->setSize( CEGUI::UVector2( cegui_absdim( 700 ), cegui_absdim( 100 ) ) );
        pTimerWindow->SetTimer( 15.0f );
        pTimerWindow->SetTimerFormatText( L"剩余$(CurrentTime)秒进入竞技场" );

        pTimerWindow->subscribeEvent( 
            CEGUI::TimerWindow::EventTimerEnded, 
            CEGUI::Event::Subscriber( &FirstWindowSample::_OnTimerEnded, this ) );
        root->addChildWindow( pTimerWindow );
    }

因为我的CEGUI::String类中添加接受Utf16字符串的构造函数，所以可以直接在代码里面使用Unicode字符串，如：

pTimerWindow->SetTimerFormatText( L"剩余$(CurrentTime)秒进入竞技场" );

例外，我们CEGUI已经支持中文显示，不知道的朋友可以到网上查阅一下相关教程。大体流程是：为CEGUI提供一个中文字符文件，然后让控件使用这种字体文件就可以显示中文了。

第一部分我们完成了代码创建控件，使用控件。接下来，我们要完成让CEGUILayoutEditor可以使用新的控件。为了让CELayoutEditor使用我们新控件，我们必须为其提供我们CEGUIBase.dll，这样编辑器才能识别使用新控件。
其实，我们主要做的，还是为CELayoutEditor提供一个可用的CEGUIBase.dll，但是我发现，直接将下载CELayoutEditor工具中的CEGUIBase.dll替换掉，无法运行，提示refCount函数入口找不到，这说明官网提供的Release版本不是使用CEGUI 0.7.4 SDK。所以我们必须要编译CELayoutEditor源码，才能得到一个能识别我们新的CEGUIBase.dll的CELayoutEditor.exe。

编译CELayoutEditor源码工程【参考教程】：
1. 到CEGUI官网下载CEGUILayoutEditor源码工程，网址：CELayoutEditor源码下载地址，国内好像不能访问这网站，所以需要用到FQ工具。如果你没有FQ的话，推荐使用Goagent（捣鼓半天或者1天就可以永久FQ了）。
2. 下载完后，打开vc++9\CELayoutEditor.sln的解决方案，编译时发现，它需要很多源码中没有头文件和lib文件。这是因为CELayoutEditor使用wxWidgetUI库开发的编辑界面，所以需要wxWidget头文件和lib。下载：wxWidget源码下载地址。下载完成后打开\build\msw目录，打开其中wx.dsw文件。做如下修改：
  在下列文件中修改#define wxUSE_GLCANVAS 0为 #define wxUSE_GLCANVAS 1 :
  wxWidgets-2.8.11\include\wx\msw\setup.h
  wxWidgets-2.8.11\include\wx\msw\setup0.h
  wxWidgets-2.8.11\include\wx\univ\setup.h
  选择“Unicode Debug”编译选项进行编译。
3. 修改CELayoutEditor项目属性配置。在头文件包含路径，以及lib文件路径，以及PostEvent命令中，解决方案使用了$(CEGUI_7),$(WXWIDGETS_7),$(CE_LAYOUT_EDITOR_7)等环境变量，我们需要新建3个环境变量（CEGUI_7,WXWIDGETS_7,CE_LAYOUT_EDITOR_7)，分别对应CEGUI SDK目录，wxWidgets SDK目录，CELayoutEditor SDK目录，然后重启vs，选择Debug进行编译（因为我们上面使用Unicode Debug编译选项进行编译的，同样可以使用Unicode Release，然后CELayoutEditor也使用Release进行编译）。
  
  如果你发现PostEvent命令执行失败，那么可能是你的环境变量的路径中带有空格，因为Dos命令中，空格是参数分隔符，所以如果路径带空格的话，需要用双引号将路径包裹起来。我们到项目属性中【PostEvent】中，将copy命令的原路径和目标路径加上双引号。所以也推荐CELayoutEditor官网将项目属性中的，【PostEvent】命令中的路径带上双引号，以方便编译。
4. 如果幸运的话，你现在可以调试着运行CELayoutEditor。
5. 此时你已经可以选择【AddWindow】-》【Taharaze】-》【TimerWindow】，来创建我们新添加的控件了（记住要在$(CEGUI_7)datafiles\schemes\TaharezLookWidgets.scheme中也添加上你的新控件）。但是在控件属性上，我们还无法设置我们新控件的两个属性【TimerFormatText】【TotalTime】，为了能让CELayoutEditor中识别这两个属性，我们需要修改CELayoutEditor.ini文件。
  
  打开CELayoutEditor.ini文件，定位到【SupportedProperties】字段，在等号后面追加
```
TimerFormatText,text;TotalTime,text;
```
  结果如下：
```
SupportedProperties=TimerFormatText,text;TotalTime,text;Alpha,float;ClickStepSize,float;MaximumValue,float;Visible,bool;AlwaysOnTop,bool;ClippedByParent,bool;InheritsAlpha,bool;Selected,bool;ReadOnly,bool;CloseButtonEnabled,bool;DragMovingEnabled,bool;FrameEnabled,bool;SizingEnabled,bool;TitlebarEnabled,bool;MultiSelect,bool;Sort,bool;DraggingEnabled,bool;BackgroundEnabled,bool;InheritsTooltipText,bool;HoverImage,text;PushedImage,text;DisabledImage,text;NormalImage,text;Font,font;TitlebarFont,font;VerticalAlignment,vert_align;HorizontalAlignment,horz_align;VertFormatting,vert_text_format;HorzFormatting,horz_text_format;Tooltip,text;Image,text;TextColours,text;
```
  这个配置文件，此字段太长了，有点难看。
6. 修改完成后，我们在新添加的TimerWindow控件上，能找到这个两个属性，并进行设置了。加载layout文件，测试很顺利。