1.绪论
一个强大的可视化系统不仅需要强大的数据处理能力,也需要方便易用的交互功能。图形处理软件ParaView、
德国癌症研究中心研发的MITK等开源软件系统都提供了强大的交互功能。VTK的交互功能除了可以监听来自鼠标、键盘等外部设备的消息,还可以在渲染场景中生成功能各异的交互部件(Widget),用于控制可视化过程的参数,达到用户的渲染要求。
2.观察者/命令模式
1.观察者/命令者是VTK里用比较多的设计模式。VTK中绝大多数的类都派生自vtkObject。查看类vtkObject的接口可以找到AddObserve()、RemoveObserve()、GetCommand()等函数。
2.观察者/命令模式是指一个Object可以有多个Observe,他定义了对象间的一种“一对多”的依赖关系,当一个Object对象的状态发生改变时,所有依赖于它的Observe对象都得到通知而被自动更新。命令模式属于对象行为模式,他将一个请求封装为一个对象,并提供一致性发送请求的接口,当一个事件发生时,他不直接把事件传递给事件调用者,而是在命令和调用者之间增加一个中间者,讲这种直接关系切断,同时将两者都隔离。事件调用者只是和接口打交道,不和具体事件实现交互。
在VTK中,可以通过两种方式来实现观察者/命令模式,他们分别是使用时间回调函数、从VTKCommand派生出具体的子类。
- 观察者-事件回调方案
在vtkObject中,有如下函数:
unsigned long AddObserver(unsigned long event, vtkCommand *, float priority = 0.0f);
unsigned long AddObserver(const char* event, vtkCommand *, float priority = 0.0f);
AddObserver()函数的作用就是针对某个事件添加挂插着到某个VTK对象中。当该对象发生观察者感兴趣的事件时,就会自动调用回调函数,执行相关操作。
- 定义回调函数。
回调函数的函数签名只能是以下形式:
void long MyCallbackFunc(vtkObject* obj, unsigned long eid, void* clientdata, void* calldata);
其中,
obj:是调用事件的对象(即调用AddObserver()函数的对象,对应于本例的rwi);
eid:是所要监听的事件ID,VTK中的事件定义在vtkCommand.h文件中;
clientdata:是与VTKCallbackCommand实例相关的数据,简单地说,是指回调函数里需要访问主程序里面得数据时,由主程序向回调函数传递的数据。
calldata:是执行vtkObject::InvokeEvent()函数时,随着回调函数发送得数据,比如说,当调用ProgressEvent事件时,会自动发送当前的进度值作为callback。 - 创建一个VTKCallbackCommand对象,并调用VTKCallbackCommand::SetCallback()函数设置所定义的回调函数。
//Step1:设置事件回调函数
vtkSmartPointer<vtkCallbackCommand> mouseCallback =
vtkSmartPointer<vtkCallbackCommand>::New();
mouseCallback->SetCallback(MyCallbackFunc); //很重要!!!
- 将VTKCallbackCommand对象添加到对象的观察者列表中。
//Step2:将vtkCallbackCommand对象添加到观察者列表。
rwi->SetRenderWindow(viewer->GetRenderWindow()); //唤醒显示窗口
rwi->AddObserver(vtkCommand::LeftButtonPressEvent, mouseCallback);
#include "Test.h"
#include <vtkAutoInit.h>
VTK_MODULE_INIT(vtkRenderingOpenGL2);
VTK_MODULE_INIT(vtkInteractionStyle);
#include <vtkCallbackCommand.h>
long cntPress = 0;
void MyCallbackFunc(vtkObject*, unsigned long eid, void* clientdata, void* calldata)
{
std::cout << "You have clicked : " << ++cntPress << " times" << std::endl;
}
#include <vtkSmartPointer.h>
#include <vtkJPEGReader.h>
#include <vtkImageViewer2.h>
#include <vtkRenderer.h>
#include <vtkRenderWindow.h>
#include <vtkRenderWindowInteractor.h>
int main()
{
vtkSmartPointer<vtkJPEGReader> reader =
vtkSmartPointer<vtkJPEGReader>::New();
reader->SetFileName("data/lena.jpg");
reader->Update();
vtkSmartPointer<vtkImageViewer2> viewer =
vtkSmartPointer<vtkImageViewer2>::New();
viewer->SetInputData(reader->GetOutput());
viewer->GetRenderer()->SetBackground(0, 0, 0);
viewer->SetSize(480, 320);
viewer->GetRenderWindow()->SetWindowName("Observer-Callback");
vtkSmartPointer<vtkRenderWindowInteractor> rwi =
vtkSmartPointer<vtkRenderWindowInteractor>::New();
viewer->SetupInteractor(rwi);
viewer->Render();
/*************************************************************/
//Step1:设置事件回调函数
vtkSmartPointer<vtkCallbackCommand> mouseCallback =
vtkSmartPointer<vtkCallbackCommand>::New();
mouseCallback->SetCallback(MyCallbackFunc); //很重要!!!
//Step2:将vtkCallbackCommand对象添加到观察者列表。
rwi->SetRenderWindow(viewer->GetRenderWindow()); //唤醒显示窗口
rwi->AddObserver(vtkCommand::LeftButtonPressEvent, mouseCallback);
rwi->Initialize();
rwi->Start();
return 0;
}
VTK中的vtkRenderWindowInteractor提供了一种独立于平台的交互机制,用来响应不同平台的鼠标、按键和时钟等消息。当渲染窗口中有事件发生时(比如说单机消息),vtkRenderWindowInteractor内部会调用与平台相关的子类,将该消息转换成对应平台的消息。因此,该例的核心在于:通过vtkRenderWindowInteractor来监听鼠标左键的消息,一旦监听到对象的观察者列表中的消息时,程序会自动调用事件回调函数。
2.2 vtkCommand子类
观察者/命令模式除了使用事件回调函数外,还可以直接从vtkCommand类中派生出子类来实现
#include <vtkAutoInit.h>
VTK_MODULE_INIT(vtkRenderingOpenGL2);
VTK_MODULE_INIT(vtkInteractionStyle);
#include <vtkCommand.h>
#include <vtkSmartPointer.h>
#include <vtkConeSource.h>
#include <vtkPolyDataMapper.h>
#include <vtkActor.h>
#include <vtkRenderer.h>
#include <vtkRenderWindow.h>
#include <vtkRenderWindowInteractor.h>
#include <vtkInteractorStyleTrackballCamera.h>
class myCallback :public vtkCommand
{
public:
static myCallback* New()
{
return new myCallback;
}
void SetObject(vtkConeSource* cone)
{
m_cone = cone;
}
virtual void Execute(vtkObject* caller, unsigned long eventId, void* callData)
{
std::cout << "LeftButton has been pressed: " << std::endl
<< "The Height: " << m_cone->GetHeight() << std::endl
<< "The Radius: " << m_cone->GetRadius() << std::endl;
}
private:
vtkConeSource* m_cone;
};
int main()
{
vtkSmartPointer<vtkConeSource> cone =
vtkSmartPointer<vtkConeSource>::New();
cone->SetHeight(10);
cone->SetRadius(4);
cone->Update();
/*************************************************************/
vtkSmartPointer<vtkPolyDataMapper> mapper =
vtkSmartPointer<vtkPolyDataMapper>::New();
mapper->SetInputConnection(cone->GetOutputPort());
vtkSmartPointer<vtkActor> actor =
vtkSmartPointer<vtkActor>::New();
actor->SetMapper(mapper);
vtkSmartPointer<vtkRenderer> render =
vtkSmartPointer<vtkRenderer>::New();
render->AddActor(actor);
render->SetBackground(1, 1, 1);
vtkSmartPointer<vtkRenderWindow> rw =
vtkSmartPointer<vtkRenderWindow>::New();
rw->AddRenderer(render);
rw->SetWindowName("Interaction By SubCommand");
rw->SetSize(320, 320);
vtkSmartPointer<vtkRenderWindowInteractor> rwi =
vtkSmartPointer<vtkRenderWindowInteractor>::New();
rwi->SetRenderWindow(rw);
vtkSmartPointer<vtkInteractorStyleTrackballCamera> style =
vtkSmartPointer<vtkInteractorStyleTrackballCamera>::New();
rwi->SetInteractorStyle(style);
vtkSmartPointer<myCallback> callback =
vtkSmartPointer<myCallback>::New();
callback->SetObject(cone);
rwi->AddObserver(vtkCommand::LeftButtonPressEvent, callback);
rwi->Initialize();
rwi->Start();
return 0;
}
基于“观察者-vtkCommand子类”的实现方案也遵循三个步骤。
- 从vtkCommand类中派生出子类,并实现vtkCommand::Execute()虚函数。
该函数原型为:
virtual void Execute(vtkObject* caller, unsigned long eventId, void* callData )= 0;
Execute()时纯虚函数,所以,从vtkCommand派生类中都必须要实现这个方法。
2.实例化vtkCommand子类的对象,并调用相关的方法。
3.调用观察者函数。
调用AddObserver()函数监听感兴趣的事件,如果所监听的事件发生,就会调用vtkCommand子类中定义的Execute()函数。
因此,针对所监听的事件,程序需要把实现的功能放在Execute函数中。