Module enthought.mayavi.scripts.mayavi2

API Reference for Enthought Tool Suite 3.0.1

The MayaVi application standalone script.

This script parses the command line arguments and launches MayaVi2 suitably. It is meant to be used by those using MayaVi2 as a standalone application.

MayaVi2 wiki page: http://svn.enthought.com/enthought/wiki/MayaVi

Author: Prabhu Ramachandran <prabhu_r@users.sf.net>

Variables
Classes
Functions
Imported Names

Variables

mayavi

A global mayavi instance so we can close it correctly.
```
mayavi = None
```
OFFSCREEN

Globals.
```
OFFSCREEN = False
```

Classes

MayaviApp
MayaviOffscreen - The mayavi application used for offscreen rendering.

Function summary

close()
contains_mayavi(namespace)
get_mayavi_script_instance()
main()
off_screen_viewer()
parse_cmd_line(arguments)
process_cmd_line(app, opts, args)
run_script(mayavi, script_name)
standalone(func)
usage()

Functions

close()

This closes the mayavi2 application.
contains_mayavi(namespace)

Returns if the given namespace contains a 'mayavi' name bound to a mayavi script instance.
get_mayavi_script_instance()

Return the mayavi Script instance from the first available set of envisage engines registered in the registry.
main()

This starts up the mayavi2 application.
off_screen_viewer()

A factory that creates an offscreen viewer.
parse_cmd_line(arguments)

Returns the options and arguments parsed via getopts.

Due to the special needs (order of args is important and repeated options will be supplied) of this command line parser we must use getopts and not optparse.

Input Arguments:

arguments -- This can be either a list of arguments as in

sys.argv[1:] or a string that is similar to the one passed on the command line. If it is a string the string is split to create a list of arguments.
process_cmd_line(app, opts, args)

Processes the passed command line arguments.

Input Arguments:

app -- A MayaVi application instance.

opts -- The list of options returned by getopt.

args -- The remaining arguments returned by getopt.
run_script(mayavi, script_name)

Execfiles a given script. The name mayavi is bound to the mayavi script instance just like in the embedded interpreter. script_name is the name of the script to execute.

Note that this function uses execfile. You should be careful when using this.

It returns False if everything was OK and True if not.
standalone(func)

A decorator to run a function from within mayavi. This lets users write a normal Python function and have that run from within mayavi. It implicitly assumes that the name 'mayavi' refers the the Script instance and will overwrite it if not.
usage()

Imported Names