File: core_view_objects.rst

package info (click to toggle)
mayavi2 4.8.3-2
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 21,892 kB
  • sloc: python: 49,447; javascript: 32,885; makefile: 129; fortran: 60
file content (52 lines) | stat: -rw-r--r-- 1,111 bytes parent folder | download | duplicates (7)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52

Main view and UI objects
=========================

This is an API reference of the views for the main objects.
The section :ref:`builing_applications` gives some context on
how to use them.

.. currentmodule:: mayavi.core.ui.api

Scene UIs: :class:`DecoratedScene` and :class:`MayaviScene`
--------------------------------------------------------------

.. autoclass:: DecoratedScene
    :members:
    :show-inheritance:

.. autoclass:: MayaviScene
    :members:
    :show-inheritance:


:class:`SceneEditor`
---------------------
.. autoclass:: SceneEditor
    :members:
    :show-inheritance:

:class:`MlabSceneModel`
-----------------------
.. autoclass:: MlabSceneModel
    :members:
    :show-inheritance:

:class:`EngineView` and  :class:`EngineRichView`
--------------------------------------------------

These are two objects to be used as views for an engine::

   from mayavi.core.ui.api import EngineView
   view = EngineView(engine=engine)
   view.edit_traits()


.. autoclass:: EngineView
    :members:
    :show-inheritance:

.. autoclass:: EngineRichView
    :members:
    :show-inheritance: