pyvista.plotting.widgets.WidgetHelper.add_volume_clip_plane

pyvista.plotting.widgets.WidgetHelper.add_volume_clip_plane#

WidgetHelper.add_volume_clip_plane(
volume,
normal='x',
invert: bool = False,
widget_color=None,
value=0.0,
assign_to_axis=None,
tubing: bool = False,
origin_translation: bool = True,
outline_translation: bool = False,
implicit: bool = True,
normal_rotation: bool = True,
interaction_event: pyvista.InteractionEventType = 'end',
origin=None,
outline_opacity=None,
**kwargs,
)[ソース]#

プレインウィジェットを使用してボリュームをクリップします．

パラメータ:
volumepyvista.plotting.volume.Volume or pyvista.ImageData or pyvista.RectilinearGrid

New dataset of type pyvista.ImageData or pyvista.RectilinearGrid, or the return value from pyvista.plotting.volume.Volume from pyvista.Plotter.add_volume().

normalstr or tuple(float), optional

平面の開始法線ベクトル．

invertbool, optional

クリップをフリップ/反転するかどうかを示すフラグ．

widget_colorColorLike, optional

文字列，RGBリスト，または16進カラー文字列．

valuefloat, optional

法線方向に沿ってクリップ値を設定します．デフォルト値は0.0です．

assign_to_axispython:str または python:int, optional

平面の法線を指定された軸と平行になるように割り当てます．オプションは (0, 'x'), (1, 'y')，または (2, 'z') です．

tubingbool, optional

When using an implicit plane widget, this controls whether or not tubing is shown around the plane's boundaries.

origin_translationbool, optional

False の場合，プレーンウィジェットは原点によって移動できず，指定された原点に厳密に配置される．インプリシット平面を使用する場合にのみ有効です．

outline_translationbool, optional

False の場合，ボックスウィジェットは変換できず，与えられた境界に厳密に配置されます．

implicitbool, optional

True の場合は vtkImplicitPlaneWidget が使用され， False の場合は vtkPlaneWidget が使用されます．

normal_rotationbool, optional

法線ベクトル矢印の不透明度を0に設定して，実質的に無効にします．これにより，ユーザは法線を回転できなくなります． assign_to_axis が設定されている場合，これは強制的に False になります．

interaction_eventvtk.vtkCommand.EventIds, optional

コールバックのトリガーに使用するVTKインタラクションイベントです．

origintuple(float), optional

平面の中心の開始座標．

outline_opacitybool or float, optional

アウトラインの可視を設定します．インプリシット平面を使用している場合のみ有効．boolまたはfloatのどちらか．

Added in version 0.44.0.

**kwargsdict, optional

All additional keyword arguments are passed to pyvista.Plotter.add_volume() to control how the volume is displayed. Only applicable if volume is either a pyvista.ImageData and pyvista.RectilinearGrid.

戻り値:
vtk.vtkPlaneWidget or vtk.vtkImplicitPlaneWidget

implicit の値に依存するVTK平面ウィジェット．

目次