Skip to content

Commit f6af727

Browse files
committed
update docs and comments
1 parent 2570e9a commit f6af727

File tree

4 files changed

+12
-8
lines changed

4 files changed

+12
-8
lines changed

CHANGELOG.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,8 @@ NVIDIA driver >= 450 is required to run this release.
99
Added
1010
~~~~~
1111

12-
- support for the normal buffer in AI denoiser
12+
- enabled normal buffer in AI denoiser
13+
- new geometries for curves: BSplineQuad and BSplineCubic approximating data points, SegmentChain for a piecewise-linear plot
1314

1415
Changes
1516
~~~~~~~

README.rst

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,7 @@ No need to write shaders, intersection algorithms, handle 3D scene technicalitie
3939
4040
... but PlotOptiX is much faster on large data and, with all the raytraced shades and DoF, more readable and eye catching.
4141

42-
`Documentation pages <https://plotoptix.rnd.team>`__ are currently generated from the source code docstrings. Please,
43-
see `examples on GitHub <https://github.com/rnd-team-dev/plotoptix/tree/master/examples>`__
44-
for practical code samples.
42+
Check `examples on GitHub <https://github.com/rnd-team-dev/plotoptix/tree/master/examples>`__ for practical code samples and `documentation pages <https://plotoptix.rnd.team>`__ for a complete API reference.
4543

4644
PlotOptiX is based on `NVIDIA OptiX 7.1 <https://developer.nvidia.com/optix>`_ framework. It is a set of CUDA shaders by `R&D Team <https://rnd.team>`_ wrapped in RnD.SharpOptiX C#/C++ libraries with a Python API. PlotOptiX makes use of RTX-capable GPU's.
4745

@@ -53,7 +51,7 @@ Features
5351

5452
- progressive path tracing with explicit light sampling
5553
- pinhole camera, thin-lens camera with depth of field simulation, panoramic camera for making 360 deg environment maps
56-
- geometries: particle (sphere), parallelepiped, parallelogram, tetrahedron, bezier line, mesh (generated from parametric surface or f(x,y) plots; defined with vertices and faces; import from Wavefront .obj file)
54+
- geometries: particle (sphere), parallelepiped, parallelogram, tetrahedron, linear segments, bezier curve, b-splines, mesh (automatically generated from parametric surface or f(x,y) data; or defined with vertices and faces, e.g. created with `pygmsh <https://github.com/nschloe/pygmsh>`__; or loaded from a Wavefront .obj file)
5755
- parameterized materials shading: flat, diffuse, reflective, refractive; including: light dispersion, surface roughness, subsurface scattering, and nested volumes
5856
- spherical and parallelogram light sources, light emission in volumes
5957
- environmental light, environment maps, and ambient occlusion

examples/1_basic_plot_making/2_parametric_line_plot_3d.py

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
Parametric line plot 3D.
33
44
This example shows how to:
5-
- create a line plot using bezier curves
5+
- create a line plot using one of curve geometries
66
- present data feature as a line thickness
77
- setup 2-color lighting
88
"""
@@ -45,9 +45,13 @@ def main():
4545
rt.set_background(0.99) # white background
4646
rt.set_ambient(0.2) # dim ambient light
4747

48-
# add plot, BezierChain geometry makes a smooth line interpolating data points
48+
# add plot: BezierChain geometry makes a smooth line interpolating data points
4949
rt.set_data("curve", pos=xyz, r=r, c=0.9, geom="BezierChain")
50+
51+
# or use SegmentChain for a piecewise-linear plot
5052
#rt.set_data("curve", pos=xyz, r=r, c=0.9, geom="SegmentChain")
53+
54+
# or use b-spline geometry (approximating data points, flat end caps)
5155
#rt.set_data("curve", pos=xyz, r=r, c=0.9, geom="BSplineQuad")
5256
#rt.set_data("curve", pos=xyz, r=r, c=0.9, geom="BSplineCubic")
5357

@@ -60,6 +64,7 @@ def main():
6064
# camera auto-configured to fit the plot
6165
rt.camera_fit()
6266

67+
# or fixed camera position, e.g. for comparison of geometry performance
6368
#rt.update_camera(eye=[200, -1000, 350], target=[0,180,0], fov=25)
6469

6570
# 2 spherical light sources, warm and cool, fit positions with respect to

plotoptix/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
__author__ = "Robert Sulej, R&D Team <dev@rnd.team>"
1414
__status__ = "beta"
1515
__version__ = "0.9.0"
16-
__date__ = "17 July 2020"
16+
__date__ = "20 July 2020"
1717

1818
import logging
1919

0 commit comments

Comments
 (0)