def load_visualization(self, file_or_fname):
"""Given a file/file name this loads the visualization."""
# Save the state of VTK's global warning display.
o = vtk.vtkObject
w = o.GetGlobalWarningDisplay()
o.SetGlobalWarningDisplay(0) # Turn it off.
try:
# Get the state from the file.
state = state_pickler.load_state(file_or_fname)
state_pickler.update_state(state)
# Add the new scenes.
for scene_state in state.scenes:
self.new_scene()
scene = self.scenes[-1]
# Disable rendering initially.
if scene.scene is not None:
scene.scene.disable_render = True
# Update the state.
state_pickler.update_state(scene_state)
scene.__set_pure_state__(scene_state)
# Setting the state will automatically reset the
# disable_render.
scene.render()
finally:
# Reset the warning state.
o.SetGlobalWarningDisplay(w)
def load_visualization(self, file_or_fname):
"""Given a file/file name this loads the visualization."""
# Save the state of VTK's global warning display.
o = vtk.vtkObject
w = o.GetGlobalWarningDisplay()
o.SetGlobalWarningDisplay(0) # Turn it off.
try:
# Get the state from the file.
state = state_pickler.load_state(file_or_fname)
state_pickler.update_state(state)
# Add the new scenes.
for scene_state in state.scenes:
self.new_scene()
scene = self.scenes[-1]
# Disable rendering initially.
if scene.scene is not None:
scene.scene.disable_render = True
# Update the state.
state_pickler.update_state(scene_state)
scene.__set_pure_state__(scene_state)
# Setting the state will automatically reset the
# disable_render.
scene.render()
finally:
# Reset the warning state.
o.SetGlobalWarningDisplay(w)
def __setstate__(self, str_state):
# This method is unnecessary since this object will almost
# never be pickled by itself and only via the scene, therefore
# __init__ will be called when the scene is constructed.
# However, setstate is defined just for completeness.
#self.__init__()
state = state_pickler.loads_state(str_state)
state_pickler.update_state(state)
self.__set_pure_state__(state)
def __setstate__(self, str_state):
# This method is unnecessary since this object will almost
# never be pickled by itself and only via the scene, therefore
# __init__ will be called when the scene is constructed.
# However, setstate is defined just for completeness.
#self.__init__()
state = state_pickler.loads_state(str_state)
state_pickler.update_state(state)
self.__set_pure_state__(state)
def __setstate__(self, str_state):
"""Allows standard pickle to work via the state_pickler.
"""
self.__init__()
# Get the state from the string and update it.
state = state_pickler.loads_state(str_state)
state_pickler.update_state(state)
# Save the state and load it if we are running.
self._saved_state = pickle.dumps(state)
if self.running:
self._load_saved_state()
def __setstate__(self, str_state):
"""Allows standard pickle to work via the state_pickler.
"""
self.__init__()
# Get the state from the string and update it.
state = state_pickler.loads_state(str_state)
state_pickler.update_state(state)
# Save the state and load it if we are running.
self._saved_state = cPickle.dumps(state)
if self.running:
self._load_saved_state()
def __setstate__(self, str_state):
self.__init__()
state = state_pickler.loads_state(str_state)
state_pickler.update_state(state)
self.__set_pure_state__(state)
def __setstate__(self, str_state):
self.__init__()
state = state_pickler.loads_state(str_state)
state_pickler.update_state(state)
self.__set_pure_state__(state)
def restore_scene(saved_visualisation, scene_index=0):
''' Restore the current scene and modules settings
according to the scene saved in a visualisation
file.
Unmatched data sources are ignored. Say the current
scene has only two data sources while the saved scene has
three, setting for the third data source is ignored.
Parameters
----------
saved_visualisation : file or fileobj
scene_index : int
index of the scene in the saved visualisation.
default is 0 (first scene)
'''
if any(int(num) < 4 for num in MAYAVI_VERSION.split(".")[:3]):
msg = "restore_scene may not work properly for Mayavi version < 4.4.4"
logger.warning(msg)
# get the state of the visualisation
state = load_state(saved_visualisation)
update_state(state)
# reference scene
ref_scene = state.scenes[scene_index]
# data sources in the reference scene
ref_sources = ref_scene.children
# the scene to be restored
current_scene = mlab.gcf()
# data sources in the current scene
current_sources = current_scene.children
# warn the user about mismatch data sources
if len(current_sources) != len(ref_sources):
msg = ("Current scene has {} sources while the reference has {}. "
"Mismatch sources are ignored")
logger.warning(msg.format(len(current_sources), len(ref_sources)))
# Restore the children for each data source
# unmatched sources are ignored
for current_source, ref_source in izip(current_sources, ref_sources):
# Setup the children
handle_children_state(current_source.children, ref_source.children)
# Try restoring each child separately
# if __set_pure_state__ method is available,
# we are by-passing the state_pickler.set_state
for current_child, ref_child in zip(current_source.children,
ref_source.children):
if hasattr(current_child, "__set_pure_state__"):
current_child.__set_pure_state__(ref_child)
else:
set_state(current_child, ref_child)
# work around for the bug in restoring camera
# https://github.com/enthought/mayavi/issues/283
ref_scene.scene.camera.pop("distance", None)
# restore scene setting
try:
set_state(current_scene.scene, ref_scene.scene)
except StateSetterError:
# current scene is an instance of a different class
# at least restore the camera
set_state(current_scene.scene.camera,
ref_scene.scene.camera)