pyvista.plotting.widgets.WidgetHelper.add_mesh_clip_plane

WidgetHelper.add_mesh_clip_plane(

mesh,

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,

crinkle: bool = False,

interaction_event: pyvista.InteractionEventType = 'end',

origin=None,

outline_opacity=None,

**kwargs,

)

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

メッシュをインタラクティブにクリップするために使用するプレインウィジェットを使用して，メッシュをシーンに追加します．

クリップされたメッシュは，プロッタの .plane_clipped_meshes 属性に保存されます．

パラメータ:

mesh : pyvista.DataSet か vtk.vtkAlgorithmpyvista.DataSet か vtk.vtkAlgorithm

シーンに追加する入力データセットと，当該メッシュを生成するクリップやアルゴリズム．

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 になります．

crinklebool, optional

クリップに沿ったセル全体を抽出し，クリップをしわくちゃにします．

interaction_eventInteractionEventType, optional

コールバックのトリガーに使用するVTKインタラクションイベントです．文字列 'start', 'end', `` always'`` または vtk.vtkCommand.EventIds を受け付けます．

バージョン 0.38.0 で変更: 文字列または vtk.vtkCommand.EventIds のいずれかを受け付けるようになりました．

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_mesh() to control how the mesh is displayed.

戻り値:

vtk.vtkActor

メッシュのVTKアクター．

例

メッシュの切り抜きと保存に使用されるインタラクティブな平面を表示します．

>>> import pyvista as pv
>>> from pyvista import examples
>>> vol = examples.load_airplane()
>>> pl = pv.Plotter()
>>> _ = pl.add_mesh_clip_plane(vol, normal=[0, -1, 0])
>>> pl.show(cpos=[-2.1, 0.6, 1.5])

スタティックシーン

インタラクティブなシーン

>>> pl.plane_clipped_meshes  

完全な例は 平面ウィジェット を参照してください．