前言:本博文为系列博文,尝试将vtk交互功能讲清楚,包括常用的接口分析、常用的交互逻辑以及常用的交互Widget。若各位小伙伴有需要请多多关注,也希望能给各位小伙伴有所帮助。
小结:本博文主要讲述vtk交互功能中的callback/observe模式。
目录
callback/observe模式
callback/observe模式是指一个Object可以有多个Observer,它定义了对象间的一种一对多的依赖关系,当一个Object的状态发生改变时,所有依赖于它的Observer对象都得到通知而被自动更新。
在vtk中,通过两种方式来实现callback/observe模式,分别为事件回调函数和从vtkCommand派生处的具体的子类。
事件回调函数
1. 定义回调函数
1)定义回调函数,回调函数的形式为
void callbackFunc( vtkObject* obj, unsigned long eid, void* clientdata, void* calldata);
其中,obj为调用事件的对象,
eid为所要监听的事件ID,
clientdata是与vtkCallbackCommand实例相关联的数据,也就是回调函数里需要访问主程序里的数据时,由主程序向回调函数传递的数据,可以通过vtkCallbackCommand::SetClientData()函数设置。
calldata是执行vtkObject::InvokeEvent()函数时,随着回调函数发送的数据。比如当调用ProgessEvent事件时,会自动发送当前的进度值作为calldata。
2. 创建vtkCallbackCommand对象,并调用vtkCallbackCommand::SetCallback()函数设置所定义的回调函数。
vtkCallbackCommand* mouseCallback = vtkCallbackCommand::New();
mouseCallback->SetCallback(callbackFunc);
3. 针对某个事件添加观察者,关联回调函数
object->AddObserver(vtkCommand::LeftButtonPressEvent, mouseCallback);
回调函数实例
#include <vtkSmartPointer.h>
#include <vtkPNGReader.h>
#include <vtkImageViewer2.h>
#include <vtkRenderWindowInteractor.h>
#include <vtkCallbackCommand.h>
#include <vtkRenderWindow.h>
#include <vtkRenderer.h>
long pressCounts = 0;
//第一步,定义回调函数。注意回调函数的签名,不能更改。
void MyCallbackFunc(vtkObject*, unsigned long eid, void* clientdata, void *calldata)
{
std::cout<<"You have clicked: "<<++pressCounts<<" times."<<std::endl;
}
//测试图像:../data/VTK-logo.png
int main(int argc, char* argv[])
{
if (argc < 2)
{
std::cout<<argv[0]<<" "<<"ImageFile(*.png)"<<std::endl;
return 0;
}
vtkSmartPointer<vtkPNGReader> reader = vtkSmartPointer<vtkPNGReader>::New();
reader->SetFileName(argv[1]);
vtkSmartPointer<vtkImageViewer2> viewer = vtkSmartPointer<vtkImageViewer2>::New();
viewer->SetInput(reader->GetOutput());
vtkSmartPointer<vtkRenderWindowInteractor> interactor = vtkSmartPointer<vtkRenderWindowInteractor>::New();
viewer->SetupInteractor(interactor);
viewer->Render();
viewer->GetRenderer()->SetBackground(1.0, 1.0, 1.0);
viewer->SetSize(640, 480);
viewer->GetRenderWindow()->SetWindowName("ObserverCommandDemo1");
//第二步,设置回调函数。
vtkSmartPointer<vtkCallbackCommand> mouseCallback =
vtkSmartPointer<vtkCallbackCommand>::New();
mouseCallback->SetCallback ( MyCallbackFunc );
//第三步,将vtkCallbackCommand对象添加到观察者列表。
interactor->SetRenderWindow(viewer->GetRenderWindow());
interactor->AddObserver(vtkCommand::LeftButtonPressEvent, mouseCallback);
interactor->Initialize();
interactor->Start();
return EXIT_SUCCESS;
}
vtkCommand子类
callback/observe模式另一种实现方式,直接从vtkCommand类中派生出子类来实现。
示例
#include <vtkSmartPointer.h>
#include <vtkConeSource.h>
#include <vtkPolyDataMapper.h>
#include <vtkRenderWindow.h>
#include <vtkRenderWindowInteractor.h>
#include <vtkCamera.h>
#include <vtkActor.h>
#include <vtkRenderer.h>
#include <vtkCommand.h>
#include <vtkBoxWidget.h>
#include <vtkTransform.h>
#include <vtkInteractorStyleTrackballCamera.h>
//第一步
class vtkMyCallback : public vtkCommand
{
public:
static vtkMyCallback *New()
{ return new vtkMyCallback; }
void SetObject(vtkConeSource* cone)
{
m_Cone = cone;
}
virtual void Execute(vtkObject *caller, unsigned long eventId, void* callData)
{
std::cout<<"Left button pressed.\n"
<<"The Height: "<<m_Cone->GetHeight()<<"\n"
<<"The Radius: "<<m_Cone->GetRadius()<<std::endl;
}
private:
vtkConeSource *m_Cone;
};
int main()
{
vtkSmartPointer<vtkConeSource> cone = vtkSmartPointer<vtkConeSource>::New();
cone->SetHeight( 3.0 );
cone->SetRadius( 1.0 );
cone->SetResolution( 10 );
vtkSmartPointer<vtkPolyDataMapper> coneMapper =
vtkSmartPointer<vtkPolyDataMapper>::New();
coneMapper->SetInputConnection( cone->GetOutputPort() );
vtkSmartPointer<vtkActor> coneActor = vtkSmartPointer<vtkActor>::New();
coneActor->SetMapper( coneMapper );
vtkSmartPointer<vtkRenderer> ren1= vtkSmartPointer<vtkRenderer>::New();
ren1->AddActor( coneActor );
ren1->SetBackground( 1.0, 1.0, 1.0 );
vtkSmartPointer<vtkRenderWindow> renWin =
vtkSmartPointer<vtkRenderWindow>::New();
renWin->AddRenderer( ren1 );
renWin->SetSize( 640, 480 );
renWin->Render();
renWin->SetWindowName("ObserverCommandDemo2");
vtkSmartPointer<vtkRenderWindowInteractor> iren =
vtkSmartPointer<vtkRenderWindowInteractor>::New();
iren->SetRenderWindow(renWin);
vtkSmartPointer<vtkInteractorStyleTrackballCamera> style =
vtkSmartPointer<vtkInteractorStyleTrackballCamera>::New();
iren->SetInteractorStyle(style);
//第二步
vtkSmartPointer<vtkMyCallback> callback = vtkSmartPointer<vtkMyCallback>::New();
callback->SetObject(cone);
//第三步
iren->AddObserver(vtkCommand::LeftButtonPressEvent, callback);
iren->Initialize();
iren->Start();
return EXIT_SUCCESS;
}
参考:VTK图形图像开发进阶_张晓东,罗火灵编著