High-level interface for 3D visualization and rendering. More...

Detailed Description

High-level interface for 3D visualization and rendering.

This class provides a user-friendly wrapper around the native Helios visualizer plugin with automatic plugin availability checking and graceful error handling.

The visualizer provides OpenGL-based 3D rendering with interactive controls, image export, and comprehensive scene configuration options.

Definition at line 126 of file Visualizer.py.

Public Member Functions
	__init__ (self, int width, int height, int antialiasing_samples=1, bool headless=False)
	Initialize Visualizer with graceful plugin handling.

	__enter__ (self)
	Context manager entry.

	__exit__ (self, exc_type, exc_value, traceback)
	Context manager exit with proper cleanup.

None	buildContextGeometry (self, Context context, Optional[List[int]] uuids=None)
	Build Context geometry in the visualizer.

None	plotInteractive (self)
	Open interactive visualization window.

None	plotUpdate (self)
	Update visualization (non-interactive).

None	printWindow (self, str filename, Optional[str] image_format=None)
	Save current visualization to image file.

None	closeWindow (self)
	Close visualization window.

None	setCameraPosition (self, vec3 position, vec3 lookAt)
	Set camera position using Cartesian coordinates.

None	setCameraPositionSpherical (self, SphericalCoord angle, vec3 lookAt)
	Set camera position using spherical coordinates.

None	setBackgroundColor (self, RGBcolor color)
	Set background color.

None	setBackgroundTransparent (self)
	Enable transparent background mode (v1.3.53+).

None	setBackgroundImage (self, str texture_file)
	Set custom background image texture (v1.3.53+).

None	setBackgroundSkyTexture (self, Optional[str] texture_file=None, int divisions=50)
	Set sky sphere texture background with automatic scaling (v1.3.53+).

None	setLightDirection (self, vec3 direction)
	Set light direction.

None	setLightingModel (self, Union[int, str] lighting_model)
	Set lighting model.

None	colorContextPrimitivesByData (self, str data_name, Optional[List[int]] uuids=None)
	Color context primitives based on primitive data values.

None	setCameraFieldOfView (self, float angle_FOV)
	Set camera field of view angle.

Tuple[vec3, vec3]	getCameraPosition (self)
	Get current camera position and look-at point.

RGBcolor	getBackgroundColor (self)
	Get current background color.

None	setLightIntensityFactor (self, float intensity_factor)
	Set light intensity scaling factor.

Tuple[int, int]	getWindowSize (self)
	Get window size in pixels.

Tuple[int, int]	getFramebufferSize (self)
	Get framebuffer size in pixels.

None	printWindowDefault (self)
	Print window with default filename.

None	displayImageFromPixels (self, List[int] pixel_data, int width, int height)
	Display image from RGBA pixel data.

None	displayImageFromFile (self, str filename)
	Display image from file.

None	getWindowPixelsRGB (self, List[int] buffer)
	Get RGB pixel data from current window.

Tuple[List[float], int, int]	getDepthMap (self)
	Get depth map from current window.

None	plotDepthMap (self)
	Plot depth map visualization.

None	clearGeometry (self)
	Clear all geometry from visualizer.

None	clearContextGeometry (self)
	Clear context geometry from visualizer.

None	deleteGeometry (self, int geometry_id)
	Delete specific geometry by ID.

None	updateContextPrimitiveColors (self)
	Update context primitive colors.

List[vec3]	getGeometryVertices (self, int geometry_id)
	Get vertices of a geometry primitive.

None	setGeometryVertices (self, int geometry_id, List[vec3] vertices)
	Set vertices of a geometry primitive.

None	addCoordinateAxes (self)
	Add coordinate axes at origin with unit length.

None	addCoordinateAxesCustom (self, vec3 origin, vec3 length, str sign="both")
	Add coordinate axes with custom properties.

None	disableCoordinateAxes (self)
	Remove coordinate axes.

None	addGridWireFrame (self, vec3 center, vec3 size, List[int] subdivisions)
	Add grid wireframe.

None	enableColorbar (self)
	Enable colorbar.

None	disableColorbar (self)
	Disable colorbar.

None	setColorbarPosition (self, vec3 position)
	Set colorbar position.

None	setColorbarSize (self, float width, float height)
	Set colorbar size.

None	setColorbarRange (self, float min_val, float max_val)
	Set colorbar range.

None	setColorbarTicks (self, List[float] ticks)
	Set colorbar tick marks.

None	setColorbarTitle (self, str title)
	Set colorbar title.

None	setColorbarFontColor (self, RGBcolor color)
	Set colorbar font color.

None	setColorbarFontSize (self, int font_size)
	Set colorbar font size.

None	setColormap (self, Union[int, str] colormap)
	Set predefined colormap.

None	setCustomColormap (self, List[RGBcolor] colors, List[float] divisions)
	Set custom colormap.

None	colorContextPrimitivesByObjectData (self, str data_name, Optional[List[int]] obj_ids=None)
	Color context primitives by object data.

None	colorContextPrimitivesRandomly (self, Optional[List[int]] uuids=None)
	Color context primitives randomly.

None	colorContextObjectsRandomly (self, Optional[List[int]] obj_ids=None)
	Color context objects randomly.

None	clearColor (self)
	Clear primitive colors from previous coloring operations.

None	hideWatermark (self)
	Hide Helios logo watermark.

None	showWatermark (self)
	Show Helios logo watermark.

None	updateWatermark (self)
	Update watermark geometry to match current window size.

None	hideNavigationGizmo (self)
	Hide navigation gizmo (coordinate axes indicator in corner).

None	showNavigationGizmo (self)
	Show navigation gizmo (coordinate axes indicator in corner).

None	enableMessages (self)
	Enable standard output from visualizer plugin.

None	disableMessages (self)
	Disable standard output from visualizer plugin.

None	plotOnce (self, bool get_keystrokes=True)
	Run one rendering loop.

None	plotUpdateWithVisibility (self, bool hide_window=False)
	Update visualization with window visibility control.

	__del__ (self)
	Destructor to ensure proper cleanup.

Public Attributes
	width = width

	height = height

	antialiasing_samples = antialiasing_samples

	headless = headless

	visualizer = None

Static Public Attributes
int	LIGHTING_NONE = 0

int	LIGHTING_PHONG = 1

int	LIGHTING_PHONG_SHADOWED = 2

int	COLORMAP_HOT = 0

int	COLORMAP_COOL = 1

int	COLORMAP_RAINBOW = 2

int	COLORMAP_LAVA = 3

int	COLORMAP_PARULA = 4

int	COLORMAP_GRAY = 5

Constructor & Destructor Documentation

◆ init()

pyhelios.Visualizer.Visualizer.__init__	(		self,
		int	width,
		int	height,
		int	antialiasing_samples = 1,
		bool	headless = False )

Initialize Visualizer with graceful plugin handling.

Parameters

width	Window width in pixels
height	Window height in pixels
antialiasing_samples	Number of antialiasing samples (default: 1)
headless	Enable headless mode for offscreen rendering (default: False)

Exceptions

VisualizerError	If visualizer plugin is not available
ValueError	If parameters are invalid

Definition at line 154 of file Visualizer.py.

◆ del()

pyhelios.Visualizer.Visualizer.__del__ ( self )

Destructor to ensure proper cleanup.

Definition at line 1846 of file Visualizer.py.

Member Function Documentation

◆ enter()

pyhelios.Visualizer.Visualizer.__enter__ ( self )

Context manager entry.

Definition at line 245 of file Visualizer.py.

◆ exit()

pyhelios.Visualizer.Visualizer.__exit__	(	self,
		exc_type,
		exc_value,
		traceback )

Context manager exit with proper cleanup.

Definition at line 249 of file Visualizer.py.

◆ addCoordinateAxes()

None pyhelios.Visualizer.Visualizer.addCoordinateAxes ( self )

Add coordinate axes at origin with unit length.

Exceptions

VisualizerError If operation fails

Definition at line 1205 of file Visualizer.py.

◆ addCoordinateAxesCustom()

None pyhelios.Visualizer.Visualizer.addCoordinateAxesCustom	(		self,
		vec3	origin,
		vec3	length,
		str	sign = "both" )

Add coordinate axes with custom properties.

Parameters

origin	Axes origin position
length	Axes length in each direction
sign	Axis direction ("both" or "positive")

Exceptions

ValueError	If parameters are invalid
VisualizerError	If operation fails

Definition at line 1226 of file Visualizer.py.

◆ addGridWireFrame()

None pyhelios.Visualizer.Visualizer.addGridWireFrame	(		self,
		vec3	center,
		vec3	size,
		List[int]	subdivisions )

Add grid wireframe.

Parameters

center	Grid center position
size	Grid size in each direction
subdivisions	Grid subdivisions [x, y, z]

Exceptions

ValueError	If parameters are invalid
VisualizerError	If operation fails

Definition at line 1271 of file Visualizer.py.

◆ buildContextGeometry()

None pyhelios.Visualizer.Visualizer.buildContextGeometry	(		self,
		Context	context,
		Optional[List[int]]	uuids = None )

Build Context geometry in the visualizer.

   This method loads geometry from a Helios Context into the visualizer
   for rendering. If no UUIDs are specified, all geometry is loaded.

Parameters

context	Helios Context instance containing geometry
uuids	Optional list of primitive UUIDs to visualize (default: all)

Exceptions

VisualizerError	If geometry building fails
ValueError	If parameters are invalid

Definition at line 275 of file Visualizer.py.

◆ clearColor()

None pyhelios.Visualizer.Visualizer.clearColor ( self )

Clear primitive colors from previous coloring operations.

Exceptions

VisualizerError If operation fails

Definition at line 1678 of file Visualizer.py.

◆ clearContextGeometry()

None pyhelios.Visualizer.Visualizer.clearContextGeometry ( self )

Clear context geometry from visualizer.

Exceptions

VisualizerError If operation fails

Definition at line 1072 of file Visualizer.py.

◆ clearGeometry()

None pyhelios.Visualizer.Visualizer.clearGeometry ( self )

Clear all geometry from visualizer.

Exceptions

VisualizerError If operation fails

Definition at line 1057 of file Visualizer.py.

◆ closeWindow()

None pyhelios.Visualizer.Visualizer.closeWindow ( self )

Close visualization window.

   This method closes any open visualization window. It's safe to call
   even if no window is open.

Exceptions

VisualizerError If window closing fails

Definition at line 433 of file Visualizer.py.

◆ colorContextObjectsRandomly()

None pyhelios.Visualizer.Visualizer.colorContextObjectsRandomly	(		self,
		Optional[List[int]]	obj_ids = None )

Color context objects randomly.

Parameters

obj_ids Optional list of object IDs to color (None for all)

Exceptions

ValueError	If object IDs are invalid
VisualizerError	If operation fails

Definition at line 1651 of file Visualizer.py.

◆ colorContextPrimitivesByData()

None pyhelios.Visualizer.Visualizer.colorContextPrimitivesByData	(		self,
		str	data_name,
		Optional[List[int]]	uuids = None )

Color context primitives based on primitive data values.

   This method maps primitive data values to colors using the current colormap.
   The visualization will be updated to show data variations across primitives.

   The data must have been previously set on the primitives in the Context using
   context.setPrimitiveDataFloat(UUID, data_name, value) before calling this method.

Parameters

data_name	Name of the primitive data to use for coloring. This should match the data label used with setPrimitiveDataFloat().
uuids	Optional list of specific primitive UUIDs to color. If None, all primitives in context will be colored.

Exceptions

VisualizerError	If visualizer is not initialized or operation fails
ValueError	If data_name is invalid or UUIDs are malformed

Examples

>>> # Set data on primitives in context
>>> context.setPrimitiveDataFloat(patch_uuid, "radiation_flux_SW", 450.2)
>>> context.setPrimitiveDataFloat(triangle_uuid, "radiation_flux_SW", 320.1)
>>>
>>> # Build geometry and color by data
>>> visualizer.buildContextGeometry(context)
>>> visualizer.colorContextPrimitivesByData("radiation_flux_SW")
>>> visualizer.plotInteractive()
 
>>> # Color only specific primitives
>>> visualizer.colorContextPrimitivesByData("temperature", [uuid1, uuid2, uuid3])

Definition at line 725 of file Visualizer.py.

◆ colorContextPrimitivesByObjectData()

None pyhelios.Visualizer.Visualizer.colorContextPrimitivesByObjectData	(		self,
		str	data_name,
		Optional[List[int]]	obj_ids = None )

Color context primitives by object data.

Parameters

data_name	Name of object data to use for coloring
obj_ids	Optional list of object IDs to color (None for all)

Exceptions

ValueError	If parameters are invalid
VisualizerError	If operation fails

Definition at line 1586 of file Visualizer.py.

◆ colorContextPrimitivesRandomly()

None pyhelios.Visualizer.Visualizer.colorContextPrimitivesRandomly	(		self,
		Optional[List[int]]	uuids = None )

Color context primitives randomly.

Parameters

uuids Optional list of primitive UUIDs to color (None for all)

Exceptions

ValueError	If UUIDs are invalid
VisualizerError	If operation fails

Definition at line 1620 of file Visualizer.py.

◆ deleteGeometry()

None pyhelios.Visualizer.Visualizer.deleteGeometry	(		self,
		int	geometry_id )

Delete specific geometry by ID.

Parameters

geometry_id ID of geometry to delete

Exceptions

ValueError	If geometry ID is invalid
VisualizerError	If operation fails

Definition at line 1091 of file Visualizer.py.

◆ disableColorbar()

None pyhelios.Visualizer.Visualizer.disableColorbar ( self )

Disable colorbar.

Exceptions

VisualizerError If operation fails

Definition at line 1315 of file Visualizer.py.

◆ disableCoordinateAxes()

None pyhelios.Visualizer.Visualizer.disableCoordinateAxes ( self )

Remove coordinate axes.

Exceptions

VisualizerError If operation fails

Definition at line 1250 of file Visualizer.py.

◆ disableMessages()

None pyhelios.Visualizer.Visualizer.disableMessages ( self )

Disable standard output from visualizer plugin.

Exceptions

VisualizerError If operation fails

Definition at line 1799 of file Visualizer.py.

◆ displayImageFromFile()

None pyhelios.Visualizer.Visualizer.displayImageFromFile	(		self,
		str	filename )

Display image from file.

Parameters

filename Path to image file

Exceptions

ValueError	If filename is invalid
VisualizerError	If operation fails

Definition at line 960 of file Visualizer.py.

◆ displayImageFromPixels()

None pyhelios.Visualizer.Visualizer.displayImageFromPixels	(		self,
		List[int]	pixel_data,
		int	width,
		int	height )

Display image from RGBA pixel data.

Parameters

pixel_data	RGBA pixel data as list of integers (0-255)
width	Image width in pixels
height	Image height in pixels

Exceptions

ValueError	If parameters are invalid
VisualizerError	If operation fails

Definition at line 928 of file Visualizer.py.

◆ enableColorbar()

None pyhelios.Visualizer.Visualizer.enableColorbar ( self )

Enable colorbar.

Exceptions

VisualizerError If operation fails

Definition at line 1300 of file Visualizer.py.

◆ enableMessages()

None pyhelios.Visualizer.Visualizer.enableMessages ( self )

Enable standard output from visualizer plugin.

Exceptions

VisualizerError If operation fails

Definition at line 1784 of file Visualizer.py.

◆ getBackgroundColor()

RGBcolor pyhelios.Visualizer.Visualizer.getBackgroundColor ( self )

Get current background color.

Returns: Background color as RGBcolor object

Exceptions

VisualizerError If operation fails

Definition at line 813 of file Visualizer.py.

◆ getCameraPosition()

Tuple[vec3, vec3] pyhelios.Visualizer.Visualizer.getCameraPosition ( self )

Get current camera position and look-at point.

Returns: Tuple of (camera_position, look_at_point) as vec3 objects

Exceptions

VisualizerError If operation fails

Definition at line 788 of file Visualizer.py.

◆ getDepthMap()

Tuple[List[float], int, int] pyhelios.Visualizer.Visualizer.getDepthMap ( self )

Get depth map from current window.

Returns: Tuple of (depth_pixels, width, height)

Exceptions

VisualizerError If operation fails

Definition at line 1011 of file Visualizer.py.

◆ getFramebufferSize()

Tuple[int, int] pyhelios.Visualizer.Visualizer.getFramebufferSize ( self )

Get framebuffer size in pixels.

Returns: Tuple of (width, height) in pixels

Exceptions

VisualizerError If operation fails

Definition at line 887 of file Visualizer.py.

◆ getGeometryVertices()

List[vec3] pyhelios.Visualizer.Visualizer.getGeometryVertices	(		self,
		int	geometry_id )

Get vertices of a geometry primitive.

Parameters

geometry_id Unique identifier of the geometry primitive

Returns: List of vertices as vec3 objects

Exceptions

ValueError	If geometry ID is invalid
VisualizerError	If operation fails

Examples

>>> # Get vertices of a specific geometry
>>> vertices = visualizer.getGeometryVertices(geometry_id)
>>> for vertex in vertices:
...     print(f"Vertex: ({vertex.x}, {vertex.y}, {vertex.z})")

Definition at line 1141 of file Visualizer.py.

◆ getWindowPixelsRGB()

None pyhelios.Visualizer.Visualizer.getWindowPixelsRGB	(		self,
		List[int]	buffer )

Get RGB pixel data from current window.

Parameters

buffer Pre-allocated buffer to store pixel data

Exceptions

ValueError	If buffer is invalid
VisualizerError	If operation fails

Definition at line 984 of file Visualizer.py.

◆ getWindowSize()

Tuple[int, int] pyhelios.Visualizer.Visualizer.getWindowSize ( self )

Get window size in pixels.

Returns: Tuple of (width, height) in pixels

Exceptions

VisualizerError If operation fails

Definition at line 864 of file Visualizer.py.

◆ hideNavigationGizmo()

None pyhelios.Visualizer.Visualizer.hideNavigationGizmo ( self )

Hide navigation gizmo (coordinate axes indicator in corner).

   The navigation gizmo shows XYZ axes orientation and can be clicked
   to snap the camera to standard views (top, front, side, etc.).

Exceptions

VisualizerError If operation fails

Definition at line 1745 of file Visualizer.py.

◆ hideWatermark()

None pyhelios.Visualizer.Visualizer.hideWatermark ( self )

Hide Helios logo watermark.

Exceptions

VisualizerError If operation fails

Definition at line 1695 of file Visualizer.py.

◆ plotDepthMap()

None pyhelios.Visualizer.Visualizer.plotDepthMap ( self )

Plot depth map visualization.

Exceptions

VisualizerError If operation fails

Definition at line 1040 of file Visualizer.py.

◆ plotInteractive()

None pyhelios.Visualizer.Visualizer.plotInteractive ( self )

Open interactive visualization window.

   This method opens a window with the current scene and allows user
   interaction (camera rotation, zooming, etc.). The program will pause
   until the window is closed by the user.

   Interactive controls:
   - Mouse scroll: Zoom in/out
   - Left mouse + drag: Rotate camera
   - Right mouse + drag: Pan camera
   - Arrow keys: Camera movement
   - +/- keys: Zoom in/out

Exceptions

VisualizerError If visualization fails

Definition at line 316 of file Visualizer.py.

◆ plotOnce()

None pyhelios.Visualizer.Visualizer.plotOnce	(		self,
		bool	get_keystrokes = True )

Run one rendering loop.

Parameters

get_keystrokes Whether to process keystrokes

Exceptions

VisualizerError If operation fails

Definition at line 1817 of file Visualizer.py.

◆ plotUpdate()

None pyhelios.Visualizer.Visualizer.plotUpdate ( self )

Update visualization (non-interactive).

   This method updates the visualization window without user interaction.
   The program continues immediately after rendering. Useful for batch
   processing or creating image sequences.

Exceptions

VisualizerError If visualization update fails

Definition at line 337 of file Visualizer.py.

◆ plotUpdateWithVisibility()

None pyhelios.Visualizer.Visualizer.plotUpdateWithVisibility	(		self,
		bool	hide_window = False )

Update visualization with window visibility control.

Parameters

hide_window Whether to hide the window during update

Exceptions

VisualizerError If operation fails

Definition at line 1835 of file Visualizer.py.

◆ printWindow()

None pyhelios.Visualizer.Visualizer.printWindow	(		self,
		str	filename,
		Optional[str]	image_format = None )

Save current visualization to image file.

   This method exports the current visualization to an image file.
   Starting from v1.3.53, supports both JPEG and PNG formats.

Parameters

filename	Output filename for image Can be absolute or relative to user's current working directory Extension (.jpg, .png) is recommended but not required
image_format	Image format - "jpeg" or "png" (v1.3.53+) If None, automatically detects from filename extension
Default	"jpeg" if not detectable from extension

Exceptions

VisualizerError	If image saving fails
ValueError	If filename or format is invalid

Note: PNG format is required to preserve transparent backgrounds when using setBackgroundTransparent(). JPEG format will render transparent areas as black.

Examples

>>> visualizer.printWindow("output.jpg")  # Auto-detects JPEG
>>> visualizer.printWindow("output.png")  # Auto-detects PNG
>>> visualizer.printWindow("output.img", image_format="png")  # Explicit PNG

Definition at line 378 of file Visualizer.py.

◆ printWindowDefault()

None pyhelios.Visualizer.Visualizer.printWindowDefault ( self )

Print window with default filename.

Exceptions

VisualizerError If operation fails

Definition at line 907 of file Visualizer.py.

◆ setBackgroundColor()

None pyhelios.Visualizer.Visualizer.setBackgroundColor	(		self,
		RGBcolor	color )

Set background color.

Parameters

color Background color as RGBcolor with values in range [0, 1]

Exceptions

VisualizerError	If color setting fails
ValueError	If color values are invalid

Definition at line 507 of file Visualizer.py.

◆ setBackgroundImage()

None pyhelios.Visualizer.Visualizer.setBackgroundImage	(		self,
		str	texture_file )

Set custom background image texture (v1.3.53+).

Parameters

texture_file Path to background image file Can be absolute or relative to working directory

Exceptions

VisualizerError	If background image setting fails
ValueError	If texture file path is invalid

Definition at line 558 of file Visualizer.py.

◆ setBackgroundSkyTexture()

None pyhelios.Visualizer.Visualizer.setBackgroundSkyTexture	(		self,
		Optional[str]	texture_file = None,
		int	divisions = 50 )

Set sky sphere texture background with automatic scaling (v1.3.53+).

   Creates a sky sphere that automatically scales with the scene.
   Replaces the deprecated addSkyDomeByCenter() method.

Parameters

texture_file	Path to spherical/equirectangular texture image If None, uses default gradient sky texture
divisions	Number of sphere tessellation divisions (default: 50) Higher values create smoother sphere but use more GPU

Exceptions

VisualizerError	If sky texture setting fails
ValueError	If parameters are invalid

Examples

>>> visualizer.setBackgroundSkyTexture() # Default gradient sky

>>> visualizer.setBackgroundSkyTexture("sky_hdri.jpg", divisions=100)

Definition at line 596 of file Visualizer.py.

◆ setBackgroundTransparent()

None pyhelios.Visualizer.Visualizer.setBackgroundTransparent ( self )

Enable transparent background mode (v1.3.53+).

   Sets the background to transparent with checkerboard pattern display.
   Requires PNG output format to preserve transparency.

Note: When using transparent background, use printWindow() with PNG format to save transparent images.

Exceptions

VisualizerError If transparent background setting fails

Definition at line 537 of file Visualizer.py.

◆ setCameraFieldOfView()

None pyhelios.Visualizer.Visualizer.setCameraFieldOfView	(		self,
		float	angle_FOV )

Set camera field of view angle.

Parameters

angle_FOV Field of view angle in degrees

Exceptions

ValueError	If angle is invalid
VisualizerError	If operation fails

Definition at line 765 of file Visualizer.py.

◆ setCameraPosition()

None pyhelios.Visualizer.Visualizer.setCameraPosition	(		self,
		vec3	position,
		vec3	lookAt )

Set camera position using Cartesian coordinates.

Parameters

position	Camera position as vec3 in world coordinates
lookAt	Camera look-at point as vec3 in world coordinates

Exceptions

VisualizerError	If camera positioning fails
ValueError	If parameters are invalid

Definition at line 454 of file Visualizer.py.

◆ setCameraPositionSpherical()

None pyhelios.Visualizer.Visualizer.setCameraPositionSpherical	(		self,
		SphericalCoord	angle,
		vec3	lookAt )

Set camera position using spherical coordinates.

Parameters

angle	Camera position as SphericalCoord (radius, elevation, azimuth)
lookAt	Camera look-at point as vec3 in world coordinates

Exceptions

VisualizerError	If camera positioning fails
ValueError	If parameters are invalid

Definition at line 481 of file Visualizer.py.

◆ setColorbarFontColor()

None pyhelios.Visualizer.Visualizer.setColorbarFontColor	(		self,
		RGBcolor	color )

Set colorbar font color.

Parameters

color Font color

Exceptions

ValueError	If color is invalid
VisualizerError	If operation fails

Definition at line 1460 of file Visualizer.py.

◆ setColorbarFontSize()

None pyhelios.Visualizer.Visualizer.setColorbarFontSize	(		self,
		int	font_size )

Set colorbar font size.

Parameters

font_size Font size

Exceptions

ValueError	If font size is invalid
VisualizerError	If operation fails

Definition at line 1483 of file Visualizer.py.

◆ setColorbarPosition()

None pyhelios.Visualizer.Visualizer.setColorbarPosition	(		self,
		vec3	position )

Set colorbar position.

Parameters

position Colorbar position

Exceptions

ValueError	If position is invalid
VisualizerError	If operation fails

Definition at line 1334 of file Visualizer.py.

◆ setColorbarRange()

None pyhelios.Visualizer.Visualizer.setColorbarRange	(		self,
		float	min_val,
		float	max_val )

Set colorbar range.

Parameters

min_val	Minimum value
max_val	Maximum value

Exceptions

ValueError	If range is invalid
VisualizerError	If operation fails

Definition at line 1384 of file Visualizer.py.

◆ setColorbarSize()

None pyhelios.Visualizer.Visualizer.setColorbarSize	(		self,
		float	width,
		float	height )

Set colorbar size.

Parameters

width	Colorbar width
height	Colorbar height

Exceptions

ValueError	If size is invalid
VisualizerError	If operation fails

Definition at line 1358 of file Visualizer.py.

◆ setColorbarTicks()

None pyhelios.Visualizer.Visualizer.setColorbarTicks	(		self,
		List[float]	ticks )

Set colorbar tick marks.

Parameters

ticks List of tick values

Exceptions

ValueError	If ticks are invalid
VisualizerError	If operation fails

Definition at line 1410 of file Visualizer.py.

◆ setColorbarTitle()

None pyhelios.Visualizer.Visualizer.setColorbarTitle	(		self,
		str	title )

Set colorbar title.

Parameters

title Colorbar title

Exceptions

ValueError	If title is invalid
VisualizerError	If operation fails

Definition at line 1438 of file Visualizer.py.

◆ setColormap()

None pyhelios.Visualizer.Visualizer.setColormap	(		self,
		Union[int, str]	colormap )

Set predefined colormap.

Parameters

colormap Colormap ID (0-5) or name ("HOT", "COOL", "RAINBOW", "LAVA", "PARULA", "GRAY")

Exceptions

ValueError	If colormap is invalid
VisualizerError	If operation fails

Definition at line 1507 of file Visualizer.py.

◆ setCustomColormap()

None pyhelios.Visualizer.Visualizer.setCustomColormap	(		self,
		List[RGBcolor]	colors,
		List[float]	divisions )

Set custom colormap.

Parameters

colors	List of RGB colors
divisions	List of division points (same length as colors)

Exceptions

ValueError	If parameters are invalid
VisualizerError	If operation fails

Definition at line 1543 of file Visualizer.py.

◆ setGeometryVertices()

None pyhelios.Visualizer.Visualizer.setGeometryVertices	(		self,
		int	geometry_id,
		List[vec3]	vertices )

Set vertices of a geometry primitive.

   This allows dynamic modification of geometry shapes during visualization.
   Useful for animating geometry or adjusting shapes based on simulation results.

Parameters

geometry_id	Unique identifier of the geometry primitive
vertices	List of new vertices as vec3 objects

Exceptions

ValueError	If parameters are invalid
VisualizerError	If operation fails

Examples

>>> # Modify vertices of an existing geometry
>>> vertices = visualizer.getGeometryVertices(geometry_id)
>>> # Scale all vertices by 2x
>>> scaled_vertices = [vec3(v.x*2, v.y*2, v.z*2) for v in vertices]
>>> visualizer.setGeometryVertices(geometry_id, scaled_vertices)

Definition at line 1178 of file Visualizer.py.

◆ setLightDirection()

None pyhelios.Visualizer.Visualizer.setLightDirection	(		self,
		vec3	direction )

Set light direction.

Parameters

direction Light direction vector as vec3 (will be normalized)

Exceptions

VisualizerError	If light direction setting fails
ValueError	If direction is invalid

Definition at line 633 of file Visualizer.py.

◆ setLightingModel()

None pyhelios.Visualizer.Visualizer.setLightingModel	(		self,
		Union[int, str]	lighting_model )

Set lighting model.

Parameters

lighting_model

Lighting model, either:

0 or "none": No lighting
1 or "phong": Phong shading
2 or "phong_shadowed": Phong shading with shadows

Exceptions

VisualizerError	If lighting model setting fails
ValueError	If lighting model is invalid

Definition at line 664 of file Visualizer.py.

◆ setLightIntensityFactor()

None pyhelios.Visualizer.Visualizer.setLightIntensityFactor	(		self,
		float	intensity_factor )

Set light intensity scaling factor.

Parameters

intensity_factor Light intensity scaling factor (typically 0.1 to 10.0)

Exceptions

ValueError	If intensity factor is invalid
VisualizerError	If operation fails

Definition at line 839 of file Visualizer.py.

◆ showNavigationGizmo()

None pyhelios.Visualizer.Visualizer.showNavigationGizmo ( self )

Show navigation gizmo (coordinate axes indicator in corner).

   The navigation gizmo shows XYZ axes orientation and can be clicked
   to snap the camera to standard views (top, front, side, etc.).

Note: Navigation gizmo is shown by default in v1.3.53+.

Exceptions

VisualizerError If operation fails

Definition at line 1766 of file Visualizer.py.

◆ showWatermark()

None pyhelios.Visualizer.Visualizer.showWatermark ( self )

Show Helios logo watermark.

Exceptions

VisualizerError If operation fails

Definition at line 1710 of file Visualizer.py.

◆ updateContextPrimitiveColors()

None pyhelios.Visualizer.Visualizer.updateContextPrimitiveColors ( self )

Update context primitive colors.

Exceptions

VisualizerError If operation fails

Definition at line 1109 of file Visualizer.py.

◆ updateWatermark()

None pyhelios.Visualizer.Visualizer.updateWatermark ( self )

Update watermark geometry to match current window size.

Exceptions

VisualizerError If operation fails

Definition at line 1725 of file Visualizer.py.

Member Data Documentation

◆ antialiasing_samples

pyhelios.Visualizer.Visualizer.antialiasing_samples = antialiasing_samples

Definition at line 173 of file Visualizer.py.

◆ COLORMAP_COOL

int pyhelios.Visualizer.Visualizer.COLORMAP_COOL = 1

static

Definition at line 135 of file Visualizer.py.

◆ COLORMAP_GRAY

int pyhelios.Visualizer.Visualizer.COLORMAP_GRAY = 5

static

Definition at line 139 of file Visualizer.py.

◆ COLORMAP_HOT

int pyhelios.Visualizer.Visualizer.COLORMAP_HOT = 0

static

Definition at line 134 of file Visualizer.py.

◆ COLORMAP_LAVA

int pyhelios.Visualizer.Visualizer.COLORMAP_LAVA = 3

static

Definition at line 137 of file Visualizer.py.

◆ COLORMAP_PARULA

int pyhelios.Visualizer.Visualizer.COLORMAP_PARULA = 4

static

Definition at line 138 of file Visualizer.py.

◆ COLORMAP_RAINBOW

int pyhelios.Visualizer.Visualizer.COLORMAP_RAINBOW = 2

static

Definition at line 136 of file Visualizer.py.

◆ headless

pyhelios.Visualizer.Visualizer.headless = headless

Definition at line 174 of file Visualizer.py.

◆ height

pyhelios.Visualizer.Visualizer.height = height

Definition at line 172 of file Visualizer.py.

◆ LIGHTING_NONE

pyhelios.Visualizer.Visualizer.LIGHTING_NONE = 0

static

Definition at line 129 of file Visualizer.py.

◆ LIGHTING_PHONG

pyhelios.Visualizer.Visualizer.LIGHTING_PHONG = 1

static

Definition at line 130 of file Visualizer.py.

◆ LIGHTING_PHONG_SHADOWED

int pyhelios.Visualizer.Visualizer.LIGHTING_PHONG_SHADOWED = 2

static

Definition at line 131 of file Visualizer.py.

◆ visualizer

pyhelios.Visualizer.Visualizer.visualizer = None

Definition at line 175 of file Visualizer.py.

◆ width

pyhelios.Visualizer.Visualizer.width = width

Definition at line 171 of file Visualizer.py.

The documentation for this class was generated from the following file:

pyhelios/Visualizer.py

Detailed Description

Public Member Functions

Public Attributes

Static Public Attributes

Constructor & Destructor Documentation

◆ __init__()

◆ __del__()

Member Function Documentation

◆ __enter__()

◆ __exit__()

◆ addCoordinateAxes()

◆ addCoordinateAxesCustom()

◆ addGridWireFrame()

◆ buildContextGeometry()

◆ clearColor()

◆ clearContextGeometry()

◆ clearGeometry()

◆ closeWindow()

◆ colorContextObjectsRandomly()

◆ colorContextPrimitivesByData()

◆ colorContextPrimitivesByObjectData()

◆ colorContextPrimitivesRandomly()

◆ deleteGeometry()

◆ disableColorbar()

◆ disableCoordinateAxes()

◆ disableMessages()

◆ displayImageFromFile()

◆ displayImageFromPixels()

◆ enableColorbar()

◆ enableMessages()

◆ getBackgroundColor()

◆ getCameraPosition()

◆ getDepthMap()

◆ getFramebufferSize()

◆ getGeometryVertices()

◆ getWindowPixelsRGB()

◆ getWindowSize()

◆ hideNavigationGizmo()

◆ hideWatermark()

◆ plotDepthMap()

◆ plotInteractive()

◆ plotOnce()

◆ plotUpdate()

◆ plotUpdateWithVisibility()

◆ printWindow()

◆ printWindowDefault()

◆ setBackgroundColor()

◆ setBackgroundImage()

◆ setBackgroundSkyTexture()

◆ setBackgroundTransparent()

◆ setCameraFieldOfView()

◆ setCameraPosition()

◆ setCameraPositionSpherical()

◆ setColorbarFontColor()

◆ setColorbarFontSize()

◆ setColorbarPosition()

◆ setColorbarRange()

◆ setColorbarSize()

◆ setColorbarTicks()

◆ setColorbarTitle()

◆ setColormap()

◆ setCustomColormap()

◆ setGeometryVertices()

◆ setLightDirection()

◆ setLightingModel()

◆ setLightIntensityFactor()

◆ showNavigationGizmo()

◆ showWatermark()

◆ updateContextPrimitiveColors()

◆ updateWatermark()

Member Data Documentation

◆ antialiasing_samples

◆ COLORMAP_COOL

◆ COLORMAP_GRAY

◆ COLORMAP_HOT

◆ COLORMAP_LAVA

◆ COLORMAP_PARULA

◆ COLORMAP_RAINBOW

◆ headless

◆ height

◆ init()

◆ del()

◆ enter()

◆ exit()