add

m3sh.vis.add(obj, renderer=None)[source]

Queue object for display.

The renderer argument should be a value returned by canvas() or a window instance returned by window(). If not specified, the current viewport is used or a new one is created if this is the first object to be displayed.

Parameters:
  • obj (Prop or vtkActor) – Instance of a render object.

  • renderer (vtkRenderer or vtkRenderWindow, optional) – The viewport or window to display the object.

Returns:

The renderer instance used for display.

Return type:

vtkRenderer

Note

It is almost never necessary to use this function directly. It is used by all drawing and plotting commands automatically.