simple.light Module¶

paraview.simple.light.AddLight(view=None)[source]¶

Makes a new light and adds it to the designated or active view.

Parameters: view – The view to add the light to. Optional, defaults to the active view.
Returns: The new light
Return type: paraview.servermanager.Light

paraview.simple.light.CreateLight()[source]¶

Makes a new light and returns it, unattached to a view.

paraview.simple.light.GetLight(number, view=None)[source]¶

Get a previously added light.

Parameters

number (int) – The index of the light to obtain.
view (View proxy. Option, if not provided the active view is used.) – The view holding the light.

Returns

The requested light.

Return type

paraview.servermanager.Light or None

paraview.simple.light.GetViewForLight(proxy)[source]¶

Given a light proxy, find which view it belongs to

Parameters: proxy (Light proxy) – The light proxy whose view you want to retrieve.
Returns: The view associated with the light if found, otherwise None
Return type: View proxy or None

paraview.simple.light.RemoveLight(light)[source]¶

Removes an existing light from its view.

Parameters: light (paraview.servermanager.Light) – The light to be removed.