VTK：vtk.vtkSplineWidget()用法解释

vtkSplineWidget 是一个交互式的控件，主要用于在 VTK 中创建和编辑样条曲线。

一些重要属性及其用法：

Interactor：设置与 widget 互动的 vtkRenderWindowInteractor。

   splineWidget.SetInteractor(renderWindowInteractor)

Enabled：开启或关闭 widget 的功能。

   splineWidget.SetEnabled(1)  # 或使用 splineWidget.EnabledOn()
   splineWidget.SetEnabled(0)  # 或使用 splineWidget.EnabledOff()

Handle Size：设置曲线上控制点的大小。

   splineWidget.SetHandleSize(0.01)

Resolution：设置样条曲线的分辨率，即曲线的细分程度。

   splineWidget.SetResolution(20)

Number of Handles：设置样条曲线上控制柄的数量，可以用来定义曲线的复杂度。

   splineWidget.SetNumberOfHandles(4)

ProjectionNormal：设置投影的法线方向，可以是 X 轴、Y 轴或 Z 轴。

   splineWidget.SetProjectionNormalToXAxis()
   splineWidget.SetProjectionNormalToYAxis()
   splineWidget.SetProjectionNormalToZAxis()

ProjectionPosition：沿着法线方向设置投影的位置。

   splineWidget.SetProjectionPosition(0.5)

Projection：设置是否将控制点投影到某个轴平面上。

   splineWidget.ProjectToXPlaneOn()
   splineWidget.ProjectToYPlaneOn()
   splineWidget.ProjectToZPlaneOn()
   splineWidget.ProjectToPlaneOff()

ParametricSpline：获取或设置样条曲线的 vtkParametricSpline 对象，该对象定义了曲线的实际形状。

   parametricSpline = splineWidget.GetParametricSpline()

Closed：设置曲线是否闭合。

splineWidget.ClosedOn()
splineWidget.ClosedOff()

Visibility：控制 widget 可视性。

splineWidget.SetVisibility(1)
splineWidget.VisibilityOn()

示例用法：

这个示例展示了如何创建一个 vtkSplineWidget，并设置其一些属性，然后启动渲染流程。

import vtk

# 创建一个回调函数，当样条曲线改变时，打印控制点的位置
def SplineCallback(obj, event):
    spline = obj.GetParametricSpline()
    points = spline.GetPoints()
    for i in range(points.GetNumberOfPoints()):
        print(f"Point {i}: {points.GetPoint(i)}")

# 创建渲染器、渲染窗口和交互器
renderer = vtk.vtkRenderer()
renderWindow = vtk.vtkRenderWindow()
renderWindow.AddRenderer(renderer)
renderWindowInteractor = vtk.vtkRenderWindowInteractor()
renderWindowInteractor.SetRenderWindow(renderWindow)

# 创建 vtkSplineWidget
splineWidget = vtk.vtkSplineWidget()
splineWidget.SetInteractor(renderWindowInteractor)
splineWidget.SetNumberOfHandles(6)
splineWidget.SetResolution(50)
splineWidget.SetHandleSize(0.05)
splineWidget.SetProjectionNormalToYAxis()
splineWidget.SetProjectionPosition(0.5)
splineWidget.ClosedOn()

# 注册回调函数
splineWidget.AddObserver('EndInteractionEvent', SplineCallback)

# 激活 widget
splineWidget.On()

# 开始渲染流程
renderWindow.Render()
renderWindowInteractor.Initialize()
renderWindowInteractor.Start()

在这个例子中，创建了一个有6个控制点的样条曲线 widget，设置其分辨率为50（曲线将在控制点之间有更多细分点），并将其投影到 Y 轴。

当样条曲线的编辑操作结束时，会通过回调函数打印每个控制点的位置。

通过调用 renderWindowInteractor.Start() 开始了渲染和交互循环，用户可以拖动控制点来编辑曲线。

将 vtkSplineWidget 的手柄（控制点）限制在一个单一的平面上

在VTK中，如果想将 vtkSplineWidget 的手柄（控制点）限制在一个单一的平面上，可以通过设置 Projection 和 ProjectionNormal 的属性来实现。这将确保控制点在用户互动的时候仅在指定的平面上移动。

以下是如何设置 vtkSplineWidget 让手柄限制在平面上的一个例子：

• 首先需要确定你想要控制点保持在哪个平面上。可能的选项包括 XY 平面、YZ 平面或 XZ 平面。
• 假设想要手柄限制在 XY 平面上，你可以按照以下步骤来设置：

import vtk

# 创建渲染器、渲染窗口和交互器
renderer = vtk.vtkRenderer()
renderWindow = vtk.vtkRenderWindow()
renderWindow.AddRenderer(renderer)
renderWindowInteractor = vtk.vtkRenderWindowInteractor()
renderWindowInteractor.SetRenderWindow(renderWindow)

# 创建 vtkSplineWidget
splineWidget = vtk.vtkSplineWidget()
splineWidget.SetInteractor(renderWindowInteractor)
splineWidget.SetNumberOfHandles(4)
splineWidget.SetResolution(20)

# 将控制点限制在 XY 平面上
splineWidget.ProjectToXYPlaneOn()
splineWidget.SetProjectionNormalToZAxis()  # 使用 Z 轴作为投影法线，于是控制点被限制在 XY 平面上

# 激活 widget
splineWidget.On()

# 初始化并开始渲染流程
renderWindow.Render()
renderWindowInteractor.Initialize()
renderWindowInteractor.Start()

在这个例子中，通过调用 splineWidget.ProjectToXYPlaneOn() 和 splineWidget.SetProjectionNormalToZAxis()，希望控制点保持在 XY 平面上，并且仅在该平面内部移动。

可以根据要求改变投影的平面，选择 ProjectToXZPlaneOn() 或 ProjectToYZPlaneOn()，并配合不同的投影法线，比如 SetProjectionNormalToXAxis() 或 SetProjectionNormalToYAxis()。

运行上述代码后，应该会看到一个 vtkSplineWidget，其控制点被限制在一个平面内移动。

在某些版本的VTK中，不支持这一操作。一般来说，vtkSplineWidget用于创建和操作三维空间中的样条线，它并不限制手柄在一个特定平面上。
但是，如果要强制控制点保持在某个平面上，通常会使用相应的约束逻辑在回调函数中实现这一功能。下面的例子演示了如何使用一个回调函数来将控制点约束在XY平面上：

import vtk

def plane_constraint(obj, event):
    # 当控制点被移动时调用
    for i in range(obj.GetNumberOfHandles()):
        handle_representation = obj.GetHandleRepresentation(i)
        pos = list(handle_representation.GetWorldPosition())
        pos[2] = 0  # 强制将 Z 坐标设置为 0，即 XY 平面
        handle_representation.SetWorldPosition(pos)

# 创建渲染器、渲染窗口和交互器
renderer = vtk.vtkRenderer()
renderWindow = vtk.vtkRenderWindow()
renderWindow.AddRenderer(renderer)
renderWindowInteractor = vtk.vtkRenderWindowInteractor()
renderWindowInteractor.SetRenderWindow(renderWindow)

# 创建 vtkSplineWidget
splineWidget = vtk.vtkSplineWidget()
splineWidget.SetInteractor(renderWindowInteractor)
splineWidget.SetNumberOfHandles(4)
splineWidget.SetResolution(20)

# 添加约束回调函数
splineWidget.AddObserver("InteractionEvent", plane_constraint)

# 激活 widget
splineWidget.On()

# 初始化并开始渲染过程
renderWindow.Render()
renderWindowInteractor.Initialize()
renderWindowInteractor.Start()

在这段代码中，创建了一个名为 plane_constraint 的回调函数。该函数将在用户与 vtkSplineWidget 交互时调用，例如移动控制点。

这个函数遍历所有控制柄，获取它们的位置，并强制将 Z 轴坐标设置为0，这样控制柄就会被限制在XY平面上。

如果还是不能解决，尝试另一种方法：使用 vtkPlane 和 vtkImplicitPlaneWidget 来约束 vtkSplineWidget 的控制点。

这种方式不直接作用于 vtkSplineWidget，而是使用一个隐式平面作为参照，在手动移动控制点的事件响应中将其约束到这个平面上。

这里的关键步骤是创建一个 vtkCallbackCommand 并将其添加到你希望建立约束的事件。

下面的示例代码展示了如何使用这种技术：

import vtk

def ConstraintHandleToPlane(caller, event):
    handle_widget = caller
    handle_representation = handle_widget.GetRepresentation()
    current_point = [0.0, 0.0, 0.0]
    handle_representation.GetWorldPosition(current_point)
    
    plane = vtk.vtkPlane()
    plane.SetOrigin(0, 0, 0)    # 设置平面原点为(0, 0, 0)
    plane.SetNormal(0, 0, 1)    # 设置平面法线朝Z方向

    projected_point = [0.0, 0.0, 0.0]
    plane.ProjectPoint(current_point, projected_point)
    handle_representation.SetWorldPosition(projected_point)

# 创建渲染器、渲染窗口和交互器
renderer = vtk.vtkRenderer()
renderWindow = vtk.vtkRenderWindow()
renderWindow.AddRenderer(renderer)
renderWindowInteractor = vtk.vtkRenderWindowInteractor()
renderWindowInteractor.SetRenderWindow(renderWindow)

# 创建并设置SplineWidget
splineWidget = vtk.vtkSplineWidget()
splineWidget.SetInteractor(renderWindowInteractor)
splineWidget.SetNumberOfHandles(4)

# 创建一个回调命令
callback = vtk.vtkCallbackCommand()
callback.SetCallback(ConstraintHandleToPlane)

# 使每一个控制点都链接到回调函数，约束到平面
for handle_idx in range(0, splineWidget.GetNumberOfHandles()):
    handle = splineWidget.GetHandleRepresentation(handle_idx)
    handle.AddObserver("InteractionEvent", callback)

# 初始化并开始交互
splineWidget.EnabledOn()
renderWindow.Render()
renderWindowInteractor.Start()

上述代码在控制点移动时，都将调用 ConstraintHandleToPlane 函数，将控制点约束在指定的平面内。这个平面被设置为 Z=0 的 XY 平面。