Feature: Lights and Shadows

ipyvolume/test_all.py

@@ -4,6 +4,7 @@
 import shutil
 import json
 import contextlib
+import math
 
 import numpy as np
 import pytest
@@ -449,3 +450,276 @@ def test_datasets():
     ipyvolume.datasets.aquariusA2.fetch()
     ipyvolume.datasets.hdz2000.fetch()
     ipyvolume.datasets.zeldovich.fetch()
+
+
+def test_mesh_material():
+    def test_material_components(mesh=None, is_scatter=False):
+        assert mesh.lighting_model == 'DEFAULT'
+        assert mesh.opacity == 1
+        assert mesh.specular_color == 'white'
+        assert mesh.shininess == 1
+        assert mesh.emissive_color == 'black'
+        assert mesh.emissive_intensity == 1
+        assert mesh.roughness == 0
+        assert mesh.metalness == 0
+        if is_scatter == False:
+            assert mesh.cast_shadow == False
+            assert mesh.receive_shadow == False
+
+        mesh.lighting_model = 'PHYSICAL'
+        mesh.opacity = 0
+        mesh.specular_color = 'blue'
+        mesh.shininess = 10
+        mesh.emissive_color = 'red'
+        mesh.emissive_intensity = 2
+        mesh.roughness = 1
+        mesh.metalness = 5
+        if is_scatter == False:
+            mesh.cast_shadow = True
+            mesh.receive_shadow = True
+
+        assert mesh.lighting_model == 'PHYSICAL'
+        assert mesh.opacity == 0
+        assert mesh.specular_color == 'blue'
+        assert mesh.shininess == 10
+        assert mesh.emissive_color == 'red'
+        assert mesh.emissive_intensity == 2
+        assert mesh.roughness == 1
+        assert mesh.metalness == 5
+        if is_scatter == False:
+            assert mesh.cast_shadow == True
+            assert mesh.receive_shadow == True
+
+    x, y, z, u, v = ipyvolume.examples.klein_bottle(draw=False)
+
+    ipyvolume.figure()
+    mesh = ipyvolume.plot_mesh( x, y, z)
+    test_material_components(mesh)
+
+    k = 20
+    h = -15
+    tx = np.array([k, -k, -k, k])
+    tz = np.array([k, k, -k, -k])
+    ty = np.array([h, h, h, h])
+
+    tri = [(0, 1, 2), (0, 2, 3)]
+    trisurf = ipyvolume.plot_trisurf(tx, ty, tz, triangles=tri)
+    test_material_components(trisurf)
+
+    X = np.arange(-10, 10, 0.25*1)-10
+    Y = np.arange(-10, 10, 0.25*1)
+    X, Y = np.meshgrid(X, Y)
+    R = np.sqrt(X**2 + Y**2)
+    Z = np.sin(R)
+
+    surf = ipyvolume.plot_surface(X, Z, Y)
+    test_material_components(surf)
+
+    x, y, z = np.random.random((3, 10000))
+    scatter = ipyvolume.scatter(x, y, z, size=1, marker="sphere")
+    test_material_components(scatter, True)
+
+
+def test_light_components():
+    ambient = ipyvolume.ambient_light()
+    assert ambient.light_type == 'AMBIENT'
+    assert ambient.light_color == 'white'
+    assert ambient.intensity == 1
+    assert ambient.cast_shadow == False
+
+    ambient.light_color = 'blue'
+    ambient.intensity = 2
+
+    ambient.light_color == 'blue'
+    assert ambient.intensity == 2
+    #
+    hemisphere = ipyvolume.hemisphere_light()
+    assert hemisphere.light_color == 'white' 
+    assert hemisphere.light_color2 == 'red' 
+    assert hemisphere.intensity == 1
+    assert hemisphere.position_x == 0
+    assert hemisphere.position_y == 1
+    assert hemisphere.position_z == 0
+    assert hemisphere.cast_shadow == False
+
+    hemisphere.light_color = 'orange' 
+    hemisphere.light_color2 = 'green' 
+    hemisphere.intensity = 0.5
+    hemisphere.position_x = 100
+    hemisphere.position_y = 100
+    hemisphere.position_z = -100
+
+    assert hemisphere.light_color == 'orange' 
+    assert hemisphere.light_color2 == 'green' 
+    assert hemisphere.intensity == 0.5
+    assert hemisphere.position_x == 100
+    assert hemisphere.position_y == 100
+    assert hemisphere.position_z == -100
+    #
+    directional = ipyvolume.directional_light()
+    assert directional.light_color == 'white' 
+    assert directional.intensity == 1
+    assert directional.position_x == 0
+    assert directional.position_y == 1
+    assert directional.position_z == 0
+    assert directional.target_x == 0
+    assert directional.target_y == 0
+    assert directional.target_z == 0
+    assert directional.cast_shadow==False
+    assert directional.shadow_map_size==512
+    assert directional.shadow_bias==-0.0005
+    assert directional.shadow_radius==1
+    assert directional.shadow_camera_near==0.5
+    assert directional.shadow_camera_far==500
+    assert directional.shadow_camera_orthographic_size==100
+    assert directional.shadow_map_type=='PCF_SOFT'
+
+    directional.light_color = 'black' 
+    directional.intensity = 0
+    directional.position_x = 50.5
+    directional.position_y = 50.5
+    directional.position_z = 50.5
+    directional.target_x = 0.2
+    directional.target_y = -0.2
+    directional.target_z = 0.8
+    directional.cast_shadow=True
+    directional.shadow_map_size=1024
+    directional.shadow_bias=-0.0009
+    directional.shadow_radius=6
+    directional.shadow_camera_near=0.1
+    directional.shadow_camera_far=5000
+    directional.shadow_camera_orthographic_size=200
+    directional.shadow_map_type='BASIC'
+
+    assert directional.light_color == 'black' 
+    assert directional.intensity == 0
+    assert directional.position_x == 50.5
+    assert directional.position_y == 50.5
+    assert directional.position_z == 50.5
+    assert directional.target_x == 0.2
+    assert directional.target_y == -0.2
+    assert directional.target_z == 0.8
+    assert directional.cast_shadow==True
+    assert directional.shadow_map_size==1024
+    assert directional.shadow_bias==-0.0009
+    assert directional.shadow_radius==6
+    assert directional.shadow_camera_near==0.1
+    assert directional.shadow_camera_far==5000
+    assert directional.shadow_camera_orthographic_size==200
+    assert directional.shadow_map_type=='BASIC'
+    #
+    point = ipyvolume.point_light()
+    assert point.light_color == 'white' 
+    assert point.intensity == 1
+    assert point.position_x == 0
+    assert point.position_y == 1
+    assert point.position_z == 0
+    assert point.angle==math.pi/3 
+    assert point.distance==0
+    assert point.decay==1
+    assert point.cast_shadow==False
+    assert point.shadow_map_size==512
+    assert point.shadow_bias==-0.0005
+    assert point.shadow_radius==1
+    assert point.shadow_camera_near==0.5
+    assert point.shadow_camera_far==500
+    assert point.shadow_map_type=='PCF_SOFT'
+
+    point.light_color = 'grey' 
+    point.intensity = 10
+    point.position_x = 50.50
+    point.position_y = -50.50
+    point.position_z = 10.10
+    point.angle=math.pi/6 
+    point.distance=70
+    point.decay=10
+    point.cast_shadow=True
+    point.shadow_map_size=256
+    point.shadow_bias=0
+    point.shadow_radius=10
+    point.shadow_camera_near=2
+    point.shadow_camera_far=10000
+    point.shadow_map_type='PCF'
+
+    assert point.light_color == 'grey' 
+    assert point.intensity == 10
+    assert point.position_x == 50.50
+    assert point.position_y == -50.50
+    assert point.position_z == 10.10
+    assert point.angle==math.pi/6 
+    assert point.distance==70
+    assert point.decay==10
+    assert point.cast_shadow==True
+    assert point.shadow_map_size==256
+    assert point.shadow_bias==0
+    assert point.shadow_radius==10
+    assert point.shadow_camera_near==2
+    assert point.shadow_camera_far==10000
+    assert point.shadow_map_type=='PCF'
+    #
+    spot = ipyvolume.spot_light()
+    assert spot.light_color == 'white' 
+    assert spot.intensity == 1
+    assert spot.position_x == 0
+    assert spot.position_y == 1
+    assert spot.position_z == 0
+    assert spot.target_x == 0
+    assert spot.target_y == 0
+    assert spot.target_z == 0
+    assert spot.angle==math.pi/3 
+    assert spot.distance==0
+    assert spot.decay==1
+    assert spot.penumbra==0
+    assert spot.cast_shadow==False
+    assert spot.shadow_map_size==512
+    assert spot.shadow_bias==-0.0005
+    assert spot.shadow_radius==1
+    assert spot.shadow_camera_near==0.5
+    assert spot.shadow_camera_far==500
+    assert spot.shadow_camera_perspective_fov==50
+    assert spot.shadow_camera_perspective_aspect==1
+    assert spot.shadow_map_type=='PCF_SOFT'
+
+    spot.light_color = 'red' 
+    spot.intensity = 100.45
+    spot.position_x = -5.1
+    spot.position_y = -5.01
+    spot.position_z = -5.001
+    spot.target_x = 1.1
+    spot.target_y = 1.001
+    spot.target_z = 1.0001
+    spot.angle=math.pi/20 
+    spot.distance=5.5
+    spot.decay=6.7
+    spot.penumbra=3.1
+    spot.cast_shadow=True
+    spot.shadow_map_size=2001
+    spot.shadow_bias=-0.000005
+    spot.shadow_radius=6.6
+    spot.shadow_camera_near=0.509
+    spot.shadow_camera_far=500.03
+    spot.shadow_camera_perspective_fov=50.56
+    spot.shadow_camera_perspective_aspect=1
+    spot.shadow_map_type='PCF'
+
+    assert spot.light_color == 'red' 
+    assert spot.intensity == 100.45
+    assert spot.position_x == -5.1
+    assert spot.position_y == -5.01
+    assert spot.position_z == -5.001
+    assert spot.target_x == 1.1
+    assert spot.target_y == 1.001
+    assert spot.target_z == 1.0001
+    assert spot.angle==math.pi/20 
+    assert spot.distance==5.5
+    assert spot.decay==6.7
+    assert spot.penumbra==3.1
+    assert spot.cast_shadow==True
+    assert spot.shadow_map_size==2001
+    assert spot.shadow_bias==-0.000005
+    assert spot.shadow_radius==6.6
+    assert spot.shadow_camera_near==0.509
+    assert spot.shadow_camera_far==500.03
+    assert spot.shadow_camera_perspective_fov==50.56
+    assert spot.shadow_camera_perspective_aspect==1
+    assert spot.shadow_map_type=='PCF'