Pipelineベースオブジェクト

これは，パイプラインオブジェクトの基本クラスのAPIリファレンスです．使用方法は Mayaviの高度な利用 を参照してください．

Scene

class mayavi.core.api.Scene

ベースクラス: Base

Mayavi scene クラス

add_child(child)

このメソッドはMayaViパイプラインのこのオブジェクトに子をインテリジェントに追加します．

on_mouse_pick(callback, type='point', button='Left', remove=False)

マウスクリックで選択コールバックを追加します．

マウスボタンを押すと，オブジェクトの選択が呼び出され，結果の選択を引数として指定されたコールバックが呼び出されます．

キーワード引数

Type:

'point', 'cell', または 'world' ．ピッキングに使用するピッカーの型．

Button:

'Left' ， 'Middle' または 'Right' ．選択イベントをトリガするマウスボタン．

Remove:

boolean removeがTrueの場合，コールバックのリストからコールバックが削除されます．

Returns ピッカー: tvtk picker

ピッキングに使用するピッカー．

注記

コールバックは，TVTKピッカーという引数を1つ受け入れる必要があります．

同じコールバックを複数回追加できます．

remove()

mayaviパイプラインから自分自身を削除します．

remove_child(child)

指定した子を子から除去します．

start()

これは，このオブジェクトがmayaviパイプラインに追加されたときに呼び出されます．

stop()

このオブジェクトがmayaviパイプラインから削除されると呼び出されます．

tno_can_add(node, add_object)

指定されたオブジェクトがノード上でドロップ可能かどうかを返します．

tno_drop_object(node, dropped_object)

指定したオブジェクトのドロップ可能なバージョンを返します．

Source

class mayavi.core.api.Source

ベースクラス: PipelineBase

パイプライン内のソースオブジェクトの基本クラス．

add_child(child)

このメソッドはMayaViパイプラインのこのオブジェクトに子をインテリジェントに追加します．

add_module(module)

モジュールをスマートに追加します．ModuleManagerインスタンスが子でない場合は，まず新しいModuleManagerを作成してから，モジュールを追加します．そうでない場合は，モジュールを最初に使用可能なModuleManagerインスタンスに追加します．

remove_child(child)

指定した子を子から除去します．

save_output(**kw)

出力(デフォルトでは最初の出力)を，指定したファイル名でVTKファイルとして保存します．古いスタイルのXMLファイルと新しいスタイルのXMLファイルの両方がサポートされています．

start()

これは，このオブジェクトがmayaviパイプラインに追加されたときに呼び出されます．

stop()

このオブジェクトがmayaviパイプラインから削除されると呼び出されます．

tno_can_add(node, add_object)

指定されたオブジェクトがノード上でドロップ可能かどうかを返します．

tno_drop_object(node, dropped_object)

指定したオブジェクトのドロップ可能なバージョンを返します．

Filter

class mayavi.core.api.Filter(**traits)

ベースクラス: Source

すべてのMayaviフィルタの基本クラスです．

setup_pipeline()

このメソッドをオーバーライドして，tvtkパイプラインを 作成 します．

このメソッドは， __init__ を介してオブジェクトが初期化されたときに呼び出されます．このメソッドが呼び出された時点では，tvtkデータパイプラインはまだ設定されていないことに注意してください．したがって，アップストリームデータは使用できません．基本的なオブジェクトを作成し，上流のソースおよびフィルタに依存 しない パイプラインのこれらの部分を設定するだけです．

start()

これは，このオブジェクトがmayaviパイプラインに追加されたときに呼び出されます．startを呼び出したときに，パイプラインのその他すべての情報がすでに設定されている必要があります．

stop()

このオブジェクトがmayaviパイプラインから削除されると呼び出されます．ここで，シーンからアクターを削除します．

update_data()

アップストリームデータが変更された場合に必要な処理を実行するには，このメソッドをオーバーライドします．

このメソッドは，入力のいずれかが data_changed イベントを送信したときに(自動的に)呼び出されます．

update_pipeline()

上流のデータが変更されたことがわかっている場合にtvtkパイプラインを 更新 するように，このメソッドをオーバーライドします．

このメソッドは，入力が pipeline_changed イベントを起動すると(自動的に)呼び出されます．

ModuleManager

class mayavi.core.api.ModuleManager

ベースクラス: Base

モジュールマネージャーノード( '色と凡例' として表現されます)．

add_child(child)

このメソッドはMayaViパイプラインのこのオブジェクトに子をインテリジェントに追加します．

remove_child(child)

指定した子を子から除去します．

start()

これは，このオブジェクトがmayaviパイプラインに追加されたときに呼び出されます．

stop()

このオブジェクトがmayaviパイプラインから削除されると呼び出されます．

tno_can_add(node, add_object)

指定されたオブジェクトがノード上でドロップ可能かどうかを返します．

tno_drop_object(node, dropped_object)

指定したオブジェクトのドロップ可能なバージョンを返します．

update()

内部データを更新します．

これは，ソースが変更された場合，または上流でパイプライン/データが変更された場合に呼び出されます．

Module

class mayavi.core.api.Module(**traits)

ベースクラス: PipelineBase

Mayaviモジュールの基本クラス．

add_child(child)

このメソッドはMayaViパイプラインのこのオブジェクトに子をインテリジェントに追加します．

setup_pipeline()

このメソッドをオーバーライドして，tvtkパイプラインを 作成 します．

このメソッドは， __init__ を介してオブジェクトが初期化されたときに呼び出されます．このメソッドが呼び出された時点では，tvtkデータパイプラインはまだ設定されていないことに注意してください．したがって，アップストリームデータは使用できません．基本的なオブジェクトを作成し，上流のソースおよびフィルタに依存 しない パイプラインのこれらの部分を設定するだけです．この時点で actors 属性も設定する必要があります．

start()

これは，このオブジェクトがmayaviパイプラインに追加されたときに呼び出されます．startを呼び出したときに，パイプラインのその他すべての情報がすでに設定されている必要があります．

stop()

このオブジェクトがmayaviパイプラインから削除されると呼び出されます．

tno_allows_children(node)

このオブジェクトの子が許可されているかどうかを返します．

tno_get_children(node)

オブジェクトの子を取得します．

tno_has_children(node)

オブジェクトに子があるかどうかを返します．

update_data()

必要に応じてvtkパイプラインがフラッシュされるように，このメソッドをオーバーライドします．

このメソッドは，入力のいずれかが data_changed イベントを送信したときに(自動的に)呼び出されます．

update_pipeline()

上流のデータが変更されたことがわかっている場合にtvtkパイプラインを 更新 するように，このメソッドをオーバーライドします．

このメソッドは，入力が pipeline_changed イベントを起動すると(自動的に)呼び出されます．

PipelineBase

class mayavi.core.api.PipelineBase

ベースクラス: Base

パイプライン内のすべてのSource，Filters，およびModulesの基本クラス．

add_actors()

シーンに self.actors を追加します．

これは通常，startが呼び出されたときに呼び出されます．自分が何をしているかを知らない限り，これを呼ぶのは避けるべきです．

configure_connection(obj, inp)

vtkパイプラインobjのトポロジを設定します．

configure_input(inp, op)

opコマンドを使ってinpを設定します．

configure_input_data(obj, data)

vtkパイプラインオブジェクトobjの入力データを設定します．

configure_source_data(obj, data)

vtkパイプラインオブジェクトobjのソースデータを設定します．

get_output_dataset()

このオブジェクトの出力データセットを返します．

get_output_object()

古いパイプライントポロジを仮定します．そのため，最初の出力を返します．

has_output_port()

古いパイプライントポロジを仮定します．したがって，output_portが存在しないと仮定します．

remove_actors()

シーンから self.actors を削除します．

これは通常，stopが呼び出されたときに呼び出されます．自分が何をしているかを知らない限り，これを呼ぶのは避けるべきです．

render()

シーンのレンダリングを呼び出し，次にVTKパイプラインのレンダリングを呼び出します．

start()

これは，このオブジェクトがmayaviパイプラインに追加されたときに呼び出されます．startを呼び出したときに，パイプラインのその他すべての情報がすでに設定されている必要があります．

stop()

このオブジェクトがmayaviパイプラインから削除されると呼び出されます．

Engine

class mayavi.core.api.Engine(**traits)

ベースクラス: HasStrictTraits

Mayaviエンジンの基本クラス．

add_filter(**kw)

パイプラインの適切なポイントにフィルタを追加します．選択したオブジェクト，またはkwarg obj として渡されたオブジェクトに追加します．

add_module(**kw)

適切なポイントでパイプラインにモジュールを追加します．選択したオブジェクト，またはkwarg obj を介して渡されたオブジェクトに追加します．

add_scene(scene, name=None)

指定された scene ( pyface.tvtk.scene.Scene インスタンス)をmayaviエンジンに追加して，mayaviがシーンを管理できるようにします．これは，ユーザがシーンを作成するときに使用されます． EnvisageEngine の場合，TVTK シーンプラグインを使用して新しいシーンを作成すると，この処理が自動的に行われます．

パラメータ:

scene - pyface.tvtk.scene.Scene

mayaviから管理する必要があるシーン．

name - str

シーンに割り当てられた名前．渡されたシーンインスタンスからシーンの名前を決定しようとします．これが不可能な場合は，デフォルトの 'Mayavi Scene' が使用されます．

add_source(**kw)

ソースをパイプラインに追加します．sceneキーワード引数でシーンが指定されていない場合は，現在のシーンを使用します．

close_scene(**kw)

new_sceneから作成されたシーンがある場合，このメソッドはそのシーンを閉じ，管理するシーンのリストからそのシーンを削除します．

パラメータ:

scene - pyface.tvtk.scene.Scene または scene アトリビュート内の pyface.tvtk.scene.Scene へのリファレンスを保持するオブジェクト．

dialog_view()

Engineオブジェクトのデフォルトのダイアログビュー．

get_viewer(scene)

特定のシーンに関連付けられたビューアを返します．

パラメータ:

scene - mayavi.core.scene.Scene インスタンス．

load_visualization(**kw)

ファイル/ファイル名を指定すると，ビジュアライゼーションがロードされます．

new_scene(**kw)

新しいVTKシーンウィンドウを作成または管理します． viewer 引数が指定されていない場合は， self.scene_factory を使用して新しいビューアが作成されます． self.scene_factory が None の場合は， ivtk ビューアが作成されます．このコードでは， viewer が pyface.tvtk.scene.Scene である scene 属性/traitを持っている必要があります．また，ビューアが closing および activated イベントをサポートしている場合にも最適です．

作成されたビューアを返します．

パラメータ:

viewer -なしの場合はビューアオブジェクトが作成されます．

name - ビューアの名前属性

**kwargs - 追加のキーワード引数がシーンファクトリに渡されます．

open(**kw)

可能であれば，カレントシーンまたは渡された scene でファイル名を指定してファイルを開きます．

record(msg)

これは単に，スクリプトレコーダにメッセージを記録するための便利な方法です．

remove_scene(**kw)

指定したAAA(BBBインスタンス)がmayaviによってすでに管理されている場合は，mayaviエンジンから削除します．CCCの場合，TVTK シーンプラグインを使用して開始したシーンを閉じると，この処理が自動的に行われます．

パラメータ:

scene - pyface.tvtk.scene.Scene

mayaviから削除する必要があるシーン．

save_visualization(**kw)

ファイル名またはファイル名を指定すると，現在のビジュアライゼーションがファイルに保存されます．

start()

これは，プラグインが実際に起動したときにプラグインによって呼び出されます．