vispy.scene package

Subpackages

• vispy.scene.cameras package
  • Subpackages
    • vispy.scene.cameras.tests package
      • Submodules
      • Module contents
  • Submodules
    • vispy.scene.cameras.arcball module
      • ArcballCamera
    • vispy.scene.cameras.base_camera module
      • BaseCamera
      • nested_getattr()
      • nested_setattr()
    • vispy.scene.cameras.fly module
      • FlyCamera
    • vispy.scene.cameras.magnify module
      • Magnify1DCamera
      • MagnifyCamera
    • vispy.scene.cameras.panzoom module
      • PanZoomCamera
    • vispy.scene.cameras.perspective module
      • Base3DRotationCamera
      • PerspectiveCamera
    • vispy.scene.cameras.turntable module
      • TurntableCamera
  • Module contents
    • ArcballCamera
    • BaseCamera
      • BaseCamera.center
      • BaseCamera.depth_value
      • BaseCamera.flip
      • BaseCamera.fov
      • BaseCamera.get_state()
      • BaseCamera.interactive
      • BaseCamera.link()
      • BaseCamera.on_canvas_change()
      • BaseCamera.pre_transform
      • BaseCamera.reset()
      • BaseCamera.set_default_state()
      • BaseCamera.set_range()
      • BaseCamera.set_state()
      • BaseCamera.up
      • BaseCamera.view_changed()
      • BaseCamera.viewbox
      • BaseCamera.viewbox_key_event()
      • BaseCamera.viewbox_mouse_event()
      • BaseCamera.viewbox_resize_event()
      • BaseCamera.zoom_factor
    • FlyCamera
      • FlyCamera.auto_roll
      • FlyCamera.keymap
      • FlyCamera.on_timer()
      • FlyCamera.rotation
      • FlyCamera.rotation1
      • FlyCamera.rotation2
      • FlyCamera.viewbox_key_event()
      • FlyCamera.viewbox_mouse_event()
    • Magnify1DCamera
      • Magnify1DCamera.transform_class
    • MagnifyCamera
      • MagnifyCamera.on_timer()
      • MagnifyCamera.transform_class
      • MagnifyCamera.view_changed()
      • MagnifyCamera.viewbox_mouse_event()
      • MagnifyCamera.viewbox_resize_event()
    • PanZoomCamera
      • PanZoomCamera.aspect
      • PanZoomCamera.center
      • PanZoomCamera.pan()
      • PanZoomCamera.rect
      • PanZoomCamera.viewbox_mouse_event()
      • PanZoomCamera.viewbox_resize_event()
      • PanZoomCamera.zoom()
    • TurntableCamera
      • TurntableCamera.azimuth
      • TurntableCamera.elevation
      • TurntableCamera.orbit()
      • TurntableCamera.roll
• vispy.scene.tests package
  • Submodules
    • vispy.scene.tests.test_canvas module
      • test_blend_presets()
      • test_canvas_render()
      • test_picking_basic()
    • vispy.scene.tests.test_node module
      • EventCheck
      • test_topology()
      • test_transforms()
    • vispy.scene.tests.test_visuals module
      • test_docstrings()
      • test_picking_context()
      • test_pop_empty_gl_state()
      • test_push_gl_state()
      • test_push_gl_state_update()
      • test_set_gl_state()
      • test_set_gl_state_context_manager()
      • test_update_gl_state()
      • test_update_gl_state_context_manager()
      • test_visual_node_generation()
  • Module contents
• vispy.scene.widgets package
  • Subpackages
    • vispy.scene.widgets.tests package
      • Submodules
      • Module contents
  • Submodules
    • vispy.scene.widgets.anchor module
      • Anchor
    • vispy.scene.widgets.axis module
      • AxisWidget
    • vispy.scene.widgets.colorbar module
      • ColorBarWidget
    • vispy.scene.widgets.console module
      • Console
      • ConsoleVisual
    • vispy.scene.widgets.grid module
      • Grid
    • vispy.scene.widgets.label module
      • Label
    • vispy.scene.widgets.viewbox module
      • ViewBox
    • vispy.scene.widgets.widget module
      • Widget
  • Module contents
    • AxisWidget
      • AxisWidget.link_view()
      • AxisWidget.on_resize()
    • ColorBarWidget
      • ColorBarWidget.border_color
      • ColorBarWidget.border_width
      • ColorBarWidget.clim
      • ColorBarWidget.cmap
      • ColorBarWidget.label
      • ColorBarWidget.on_resize()
      • ColorBarWidget.orientation
      • ColorBarWidget.ticks
    • Console
      • Console.clear()
      • Console.font_size
      • Console.on_resize()
      • Console.text_color
      • Console.write()
    • Grid
      • Grid.add_grid()
      • Grid.add_view()
      • Grid.add_widget()
      • Grid.grid_size
      • Grid.layout_array
      • Grid.next_row()
      • Grid.remove_widget()
      • Grid.resize_widget()
    • Label
      • Label.on_resize()
      • Label.text
    • ViewBox
      • ViewBox.add()
      • ViewBox.camera
      • ViewBox.get_scene_bounds()
      • ViewBox.is_in_scene()
      • ViewBox.on_resize()
      • ViewBox.scene
    • Widget
      • Widget.add_grid()
      • Widget.add_view()
      • Widget.add_widget()
      • Widget.bgcolor
      • Widget.border_color
      • Widget.height
      • Widget.height_max
      • Widget.height_min
      • Widget.inner_rect
      • Widget.margin
      • Widget.padding
      • Widget.picking
      • Widget.pos
      • Widget.rect
      • Widget.remove_widget()
      • Widget.size
      • Widget.stretch
      • Widget.width
      • Widget.width_max
      • Widget.width_min

Submodules

• vispy.scene.canvas module
  • SceneCanvas
    • SceneCanvas.bgcolor
    • SceneCanvas.central_widget
    • SceneCanvas.draw_visual()
    • SceneCanvas.on_close()
    • SceneCanvas.on_draw()
    • SceneCanvas.on_resize()
    • SceneCanvas.pop_fbo()
    • SceneCanvas.pop_viewport()
    • SceneCanvas.push_fbo()
    • SceneCanvas.push_viewport()
    • SceneCanvas.render()
    • SceneCanvas.scene
    • SceneCanvas.update()
    • SceneCanvas.visual_at()
    • SceneCanvas.visuals_at()
• vispy.scene.events module
  • SceneMouseEvent
    • SceneMouseEvent.button
    • SceneMouseEvent.buttons
    • SceneMouseEvent.copy()
    • SceneMouseEvent.delta
    • SceneMouseEvent.last_event
    • SceneMouseEvent.pos
    • SceneMouseEvent.press_event
    • SceneMouseEvent.scale
    • SceneMouseEvent.visual
• vispy.scene.node module
  • Node
    • Node.canvas
    • Node.children
    • Node.clip_children
    • Node.clipper
    • Node.common_parent()
    • Node.describe_tree()
    • Node.document
    • Node.document_node
    • Node.is_child()
    • Node.name
    • Node.node_path()
    • Node.node_path_to_child()
    • Node.node_path_transforms()
    • Node.node_transform()
    • Node.on_parent_change()
    • Node.opacity
    • Node.order
    • Node.parent
    • Node.parent_chain()
    • Node.picking
    • Node.root_node
    • Node.scene_node
    • Node.set_picking()
    • Node.set_transform()
    • Node.transform
    • Node.update()
    • Node.visible
• vispy.scene.subscene module
  • SubScene
• vispy.scene.visuals module
  • Arrow
  • Axis
  • Box
  • ColorBar
  • ComplexImage
  • Compound
  • Cube
  • Ellipse
  • Graph
  • GridLines
  • GridMesh
  • Histogram
  • Image
  • InfiniteLine
  • InstancedMesh
  • Isocurve
  • Isoline
  • Isosurface
  • Line
  • LinePlot
  • LinearRegion
  • Markers
  • Mesh
  • MeshNormals
  • Plane
  • Polygon
  • Rectangle
  • RegularPolygon
  • ScrollingLines
  • Spectrogram
  • Sphere
  • SurfacePlot
  • Text
  • Tube
  • VisualNode
    • VisualNode.draw()
    • VisualNode.interactive
    • VisualNode.picking
  • Volume
  • Windbarb
  • XYZAxis

Module contents

The vispy.scene subpackage provides high-level, flexible, and easy to use functionality for creating scenes composed of multiple visual objects.

Overview

Scenegraphs are a commonly used system for describing a scene as a hierarchy of visual objects. Users need only create these visual objects and specify their location in the scene, and the scenegraph system will automatically draw the entire scene whenever an update is required.

Using the vispy scenegraph requires only a few steps:

1. Create a SceneCanvas to display the scene. This object has a scene property that is the top-level Node in the scene.

2. Create one or more Node instances (see vispy.scene.visuals)

3. Add these Node instances to the scene by making them children of canvas.scene, or children of other nodes that are already in the scene.

For more information see:

• complete scenegraph documentation

• scene examples

• scene API reference