pyvista.Renderer.add_ruler

pyvista.Renderer.add_ruler#

Renderer.add_ruler(
pointa,
pointb,
flip_range=False,
number_labels=None,
show_labels=True,
font_size_factor=0.6,
label_size_factor=1.0,
label_format=None,
title='Distance',
number_minor_ticks=0,
tick_length=5,
minor_tick_length=3,
show_ticks=True,
tick_label_offset=2,
label_color=None,
tick_color=None,
scale=1.0,
)[ソース]#

ルーラーを追加します．

ルーラーは2Dオブジェクトであり，3Dオブジェクトにオクルードされることはありません．パースペクティブの問題を避けるために，平行投影，つまり Plotter.enable_parallel_projection() を使用し，ルーラーを表示方向と直交するように配置することが推奨されます．

タイトルやラベルは，ルーラーが pointa から pointb へと移動する際に，その右側に配置されます．必要であれば， flip_range を使用して 0 位置を反転させてください．

ルーラーが表示シーンにオーバーレイで配置されているため，カメラが自動的にリセットされてルーラーが表示に含まれることはありません．

パラメータ:
pointasequence[float]

ルーラーの開始点．

pointbsequence[float]

ルーラーの終了点．

flip_rangebool, default: False

もし True ならば，距離の範囲は pointb から pointa までとなります．

number_labelsint, optional

Number of labels to place on ruler. If not supplied, the number will be adjusted for "nice" values.

show_labelsbool, default: True

ラベルを表示するかどうか．

font_size_factorfloat, default: 0.6

フォントサイズを全体的に拡大縮小するファクター．

label_size_factorfloat, default: 1.0

タイトルサイズに対するラベルサイズの倍率を設定します．

label_formatstr, optional

ラベルのprintf形式のフォーマット，例：'%E' ．

titlestr, default: "Distance"

表示するタイトル．

number_minor_ticksint, default: 0

メジャーティック間のマイナーティックの数．

tick_lengthint, default: 5

目盛りのピクセル長さ．

minor_tick_lengthint, default: 3

軸小目盛りのピクセル長さ．

show_ticksbool, default: True

軸目盛りを表示するかどうか．

tick_label_offsetint, default: 2

ピクセル目盛りとラベルのオフセット．

label_colorColorLike, optional

ラベルとタイトルの色を表す文字列，RGBリスト，または16進カラー文字列のいずれかを，目盛りのテキストと目盛りの線の色に使用します．

警告

これは白か黒のどちらかです．

tick_colorColorLike, optional

文字列，RGBリスト，または16進カラー文字列のいずれかを，目盛りの線の色に使用します．

scalefloat, default: 1.0

Scale factor for the ruler.

Added in version 0.44.0.

戻り値:
vtk.vtkActor

ルーラーのVTKアクター．

例

>>> import pyvista as pv
>>> cone = pv.Cone(height=2.0, radius=0.5)
>>> plotter = pv.Plotter()
>>> _ = plotter.add_mesh(cone)

円錐のX方向を測定し，定規を少し下に置きます．

>>> _ = plotter.add_ruler(
...     pointa=[cone.bounds.x_min, cone.bounds.y_min - 0.1, 0.0],
...     pointb=[cone.bounds.x_max, cone.bounds.y_min - 0.1, 0.0],
...     title='X Distance',
... )

円錐のy方向を測定し，ルーラーを少し左側に置きます．タイトルとラベルは pointa から pointb へ移動するときにルーラーの右側に配置されます．

>>> _ = plotter.add_ruler(
...     pointa=[cone.bounds.x_min - 0.1, cone.bounds.y_max, 0.0],
...     pointb=[cone.bounds.x_min - 0.1, cone.bounds.y_min, 0.0],
...     flip_range=True,
...     title='Y Distance',
... )
>>> plotter.enable_parallel_projection()
>>> plotter.view_xy()
>>> plotter.show()
../../../_images/pyvista-Renderer-add_ruler-1_00_00.png
目次