wolfhece.opengl.py3d

Author: HECE - University of Liege, Pierre Archambeau Date: 2024

Copyright (c) 2024 University of Liege. All rights reserved.

This script and its content are protected by copyright law. Unauthorized copying or distribution of this file, via any medium, is strictly prohibited.

Module Contents

wolfhece.opengl.py3d.print_program_resource_names(program, verbose=False)

Print the active resources in the program

class wolfhece.opengl.py3d.TypeOfView

Bases: enum.Enum

Type of view

PERSPECTIVE = 0

ORTHOGRAPHIC = 1

ORTHOGRAPHIC_2D = 2

class wolfhece.opengl.py3d.Cache_WolfArray_plot3D(parent: WolfArray_plot3D, context: wx.glcanvas.GLContext, canvas: CanvasOGL, idx: int = 0)

Cache for the WolfArray_plot3D class

A cache is created for each canvas. The cache is responsible for the OpenGL resources associated to context.

property sunposition

property sunintensity

initialize_color_palette()

Initialize the color palette

init_GL(quad_centers: numpy.ndarray, ztexture: numpy.ndarray)

init_shader()

loc_uniforms(which_prog=0)

Initialize the uniforms

set_uniforms(which_prog=0)

Set the uniforms

update_quads(data: numpy.ndarray)

Update the buffer with new data

update_mvp(mvp: glm.mat4x4)

Update the model view projection matrix

update_ztexture(ztexture: numpy.ndarray)

Update the ztexture

update_palette(color_palette: numpy.ndarray, color_values: numpy.ndarray)

Update the color palette

Draw()

class wolfhece.opengl.py3d.WolfArray_plot3D(quad_centers: numpy.ndarray, dx: float = 1.0, dy: float = 1.0, origx: float = 0.0, origy: float = 0.0, zscale: float = 0.0, ztexture: numpy.ndarray = None, color_palette: numpy.ndarray = None, color_values: numpy.ndarray = None)

Class to plot data in 3D viewer

reference for texture 2D : https://registry.khronos.org/OpenGL-Refpages/gl4/html/glTexImage2D.xhtml

OPENGL

The first element corresponds to the lower left corner of the texture image. Subsequent elements progress left-to-right through the remaining texels in the lowest row of the texture image,

and then in successively higher rows of the texture image.

The final element corresponds to the upper right corner of the texture image.

void glTexImage2D( GLenum target,

GLint level, GLint internalformat, GLsizei width, GLsizei height, GLint border, GLenum format, GLenum type, const void * data);

NUMPY

shape[0] is the number of rows and shape[1] is the number of columns.

The “data” buffer is row-major order or column-major order, depending on the value of the order parameter.

• row-major order : C order

• column-major order : ‘F’ order (Fortran)

So, in row-major order :

• OpenGL Texture width = shape[1]

• OpenGL Texture height = shape[0]

and in column-major order :

• OpenGL Texture width = shape[0]

• OpenGL Texture height = shape[1]

++ IMPORTANT

We assume that if data is row-major order, the indexing [i,j] is (y, x) and if data is column-major order, the indexing is (x, y)

Example :

• array[m,n] in row-major order is the element at the coordinate (n * dx + dx/2. + origx, m * dy + dy/2. + origy)

• array[m,n] in column-major order is the element at the coordinate (m * dx + dx/2. + origx, n * dy + dy/2. + origy)

So:

• the data buffer is the same as it is contiguous in memory. We ** don’t need to transpose ** the data buffer.

• Transposition is done by changing the indexing convention.

• “texture” calls in shaders is the same for both row-major and column-major order.

– IMPORTANT

property boundingbox

Return the bounding box of the quads

property cache: Cache_WolfArray_plot3D

property sunposition

property sunintensity

remove_parent(parent: CanvasOGL)

Remove the parent from the object

add_parent(parent: CanvasOGL, idx: int = 0)

Add the parent to the object

update_mvp(mvp: glm.mat4x4)

Update the model view projection matrix

update_ztexture(ztexture: numpy.ndarray)

Update the ztexture

update_palette(color_palette: numpy.ndarray, color_values: numpy.ndarray)

Update the color palette

Draw()

class wolfhece.opengl.py3d.CanvasOGL(parent)

Bases: wx.glcanvas.GLCanvas

property sunposition

property sunaltitude

property sunx

property suny

property sunintensity

property mvp

Return the model view projection matrix as np.array in column major order

property moves_matrix4x4

Return the list of moves as a list of glm.mat4

property mvp_glm

Return the model view projection matrix as glm.mat4

property right

Return the right vector of the camera

property distance

Return the distance between the eye and the center of the view

property ppi

Return the pixels per inch of the view

property boundingbox

Return the bounding box of the view

property z_extrema

Return the extrema of the ztexture

force_view(x: float, y: float, z: float)

Force the view to a specific position

init_gizmo_shader()

draw_gizmo()

draw_plane(a, b, c, d, e, f, g, h, i, j, k, l, colr, colg, colb)

add_array(name: str, array: WolfArray_plot3D)

Add an array to the canvas

ray_pick(x, y)

Get the ray direction from the camera to the mouse position

intersect_ray_plane(ray_direction, plane_point)

Calculer l’intersection entre un rayon et un plan horizontal

intersect_ray_quad(ray_direction, quad_lowerleft, quad_upperright)

Calculer l’intersection entre un rayon et un quad

update_view()

_direction()

_normalize(v)

_cross(v1, v2)

_dot(v1, v2)

_rotate(angle, axis)

Rotation matrix around axis by angle degrees

closer(factor=1.0)

Move the camera closer to the center of the view

further_away(factor=1.0)

Move the camera further away from the center of the view

rotate_up(angle)

Rotate the camera up by angle degrees

rotate_z_center(angle)

Rotate the camera around the z axis, passing at center, by angle degrees

rotate_x_center(angle)

Rotate the camera around the x axis, passing at center, by angle degrees

rotate_y_center(angle)

Rotate the camera around the y axis, passing at center, by angle degrees

add_move_rotation(angle: float, axis: glm.vec3, center: glm.vec3)

Add a rotation to the list of moves

add_move_translation(translation: glm.vec3)

Add a translation to the list of moves

rotate_right_eye(angle)

Rotate the camera to the right by angle degrees

rotate_right_center(angle)

Rotate the camera to the right by angle degrees

translate(amplitude, orient)

Translate the camera by amplitude in the direction of the vector orient

OnPaint(event)

Called when the window is exposed.

OnSize(event)

Called when the window is resized

OnWheel(event: wx.MouseEvent)

Called when the mouse wheel is scrolled.

OnLeftDown(event: wx.MouseEvent)

Called when the left mouse button is pressed.

OnRightDown(event: wx.MouseEvent)

Called when the right mouse button is pressed.

OnRightUp(event: wx.MouseEvent)

Called when the right mouse button is released.

OnLeftUp(event: wx.MouseEvent)

Called when the left mouse button is released.

OnMouseMove(event: wx.MouseEvent)

Called when the mouse is in motion.

autoscale()

Auto scale the view to fit all the arrays

copy_to_clipboard()

Copy the image to the clipboard

save_to_file()

Save the image to a file

print_shortcuts() → str

Print shortcuts

OnKeyDown(event)

Called when a key is pressed.

OnKeyUp(event)

InitGL()

create_fbo()

Create a framebuffer object

Draw()

update_palette(idx, color_palette, color_values)

Update the color palette of the array

class wolfhece.opengl.py3d.Wolf_Viewer3D(parent, title)

Bases: wx.Frame

property context

property xmin

property xmax

property ymin

property ymax

GetSize()

add_array(name: str, array: WolfArray_plot3D)

Add an array to the canvas

force_view(x, y, z)

Force the view to the specified coordinates

autoscale()

Auto scale the view to fit all the arrays

update_palette(idx, color_palette, color_values)

Update the color palette of the array

wolfhece.opengl.py3d.main_test()

Test the Wolf_Viewer3D class

2 arrays can be added to the canvas. The first one is in row major order and the second one is in column major order. The plt must be the same for both arrays.