Inherits from
- PipelineBase: enthought.mayavi.core.pipeline_base.PipelineBase
Attributes
- components
The (optional) components used by this module. NOTE: This is not pickled. It is the developers responsibility to setup the components when the component traits are set in the handler.
components = List
- icon
The icon
icon = Str('module.ico')
- module_manager
The ModuleManager associated with this module. A Module is always a child of a ModuleManager. When the module is added to the mayavi pipeline (as a child of the module manager), the module manager automatically sets this trait.
module_manager = Instance('enthought.mayavi.core.module_manager.ModuleManager')
- type
The human-readable type for this object
type = Str(' module')
Inherited from base classes
Method summary
- __get_pure_state__(self)
- __init__(self, **traits)
- add_child(self, child)
- setup_pipeline(self)
- start(self)
- stop(self)
- tno_allows_children(self, node)
- tno_get_children(self, node)
- tno_has_children(self, node)
- update_data(self)
- update_pipeline(self)
Inherited from base classes
- __deepcopy__(self, memo)
- __getstate__(self)
- __icon_path_default(self)
- __menu_default(self)
- __prefix_trait__(self, name)
- __reduce_ex__(self, protocol)
- __setstate__(self, str_state)
- add_actors(self)
- add_class_trait(cls, name, *trait)
- add_trait(self, name, *trait)
- add_trait_category(cls, category)
- add_trait_listener(self, object, prefix = '')
- all_trait_names(self)
- base_trait(self, name)
- class_default_traits_view(cls)
- class_editable_traits(cls)
- class_trait_names(cls, **metadata)
- class_trait_view(cls, name = None, view_element = None)
- class_trait_view_elements(cls)
- class_traits(cls, **metadata)
- clone_traits(self, traits = None, memo = None, copy = None, **metadata)
- configure_traits(self, filename = None, view = None, kind = None, edit = True, context = None, handler = None, id = '', scrollable = None, **args)
- copy_traits(self, other, traits = None, memo = None, copy = None, **metadata)
- copyable_trait_names(self, **metadata)
- default_traits_view(self)
- dialog_view(self)
- edit_traits(self, view = None, parent = None, kind = None, context = None, handler = None, id = '', scrollable = None, **args)
- editable_traits(self)
- get(self, *names, **metadata)
- on_trait_change(self, handler, name = None, remove = False, dispatch = 'same')
- print_traits(self, show_help = False, **metadata)
- remove_actors(self)
- remove_trait(self, name)
- remove_trait_listener(self, object, prefix = '')
- render(self)
- reset_traits(self, traits = None, **metadata)
- set(self, trait_change_notify = True, **traits)
- set_trait_dispatch_handler(cls, name, klass, override = False)
- sync_trait(self, trait_name, object, alias = None, mutual = True, remove = False)
- tno_append_child(self, node, child)
- tno_can_add(self, node, add_object)
- tno_can_auto_close(self, node)
- tno_can_auto_open(self, node)
- tno_can_copy(self, node)
- tno_can_delete(self, node)
- tno_can_delete_me(self, node)
- tno_can_insert(self, node)
- tno_can_rename(self, node)
- tno_can_rename_me(self, node)
- tno_confirm_delete(self, node)
- tno_dclick(self, node)
- tno_delete_child(self, node, index)
- tno_drop_object(self, node, dropped_object)
- tno_get_add(self, node)
- tno_get_drag_object(self, node)
- tno_get_icon(self, node, is_expanded)
- tno_get_icon_path(self, node)
- tno_get_label(self, node)
- tno_get_menu(self, node)
- tno_get_name(self, node)
- tno_get_view(self, node)
- tno_insert_child(self, node, index, child)
- tno_is_node_for(self, node)
- tno_select(self, node)
- tno_set_label(self, node, label)
- tno_when_children_changed(self, node, listener, remove)
- tno_when_children_replaced(self, node, listener, remove)
- tno_when_label_changed(self, node, listener, remove)
- trait(self, name, force = False, copy = False)
- trait_context(self)
- trait_monitor(cls, handler, remove = False)
- trait_names(self, **metadata)
- trait_subclasses(cls, all = False)
- trait_view(self, name = None, view_element = None)
- trait_view_elements(self)
- trait_views(self, klass = None)
- traits(self, **metadata)
- validate_trait(self, name, value)
Methods
- __get_pure_state__(self)
- __init__(self, **traits)
- add_child(self, child)
This method intelligently adds a child to this object in the MayaVi pipeline.
- setup_pipeline(self)
Override this method so that it creates the tvtk pipeline.
This method is invoked when the object is initialized via __init__. Note that at the time this method is called, the tvtk data pipeline will not yet be setup. So upstream data will not be available. The idea is that you simply create the basic objects and setup those parts of the pipeline not dependent on upstream sources and filters. You should also set the actors attribute up at this point.
- start(self)
This is invoked when this object is added to the mayavi pipeline. Note that when start is invoked, all the other information for the pipeline should be already set.
- stop(self)
Invoked when this object is removed from the mayavi pipeline.
- tno_allows_children(self, node)
Returns whether chidren of this object are allowed or not.
- tno_get_children(self, node)
Gets the object's children.
- tno_has_children(self, node)
Returns whether or not the object has children.
- update_data(self)
Override this method so that it flushes the vtk pipeline if that is necessary.
This method is invoked (automatically) when any of the inputs sends a data_changed event.
- update_pipeline(self)
Override this method so that it updates the tvtk pipeline when data upstream is known to have changed.
This method is invoked (automatically) when the input fires a pipeline_changed event.