cadop / dhart Goto Github PK

The build instructions for Visual Studio are too conservative and ask users to install more packages than needed. A fresh windows installation needs to be setup to verify what the minimal requirements are.

Need two sets of examples:

• One setup showing just the python side.
• One setup for Rhino python, using the repo to save through json

The current github action does two checkouts, builds the docs for each, then pushes to gh pages. This causes on of the pushes to be cancelled.

The action needs to be rewritten following the advice here: https://github.com/orgs/community/discussions/39196#discussioncomment-4161927

CMake config comments out c_interface tests:

Need to look back and find when this happened and if all tests are covered by other ones, as the interface seems to be an older version:

There was an early decision to make packages that were not reliant on all the other packages.

There needs to be documentation showing how to compile and build only one part, such as the raytracing package.

Currently just experienced with Unity when creating a BVH with 0 vertices, the C API will crash when trying to use this invalid mesh for raycasting.

While this isn't a priority since it only happens when incorrectly setting the BVH, it would be nice to have a more graceful exit.

=================================================================
	Managed Stacktrace:
=================================================================
	  at <unknown> <0xffffffff>
	  at DHARTAPI.RayTracing.NativeMethods:DestroyRayTracer <0x00126>
	  at DHARTAPI.RayTracing.NativeMethods:C_DestroyRayTracer <0x00072>
	  at DHARTAPI.RayTracing.EmbreeBVH:ReleaseHandle <0x00072>
	  at System.Runtime.InteropServices.SafeHandle:DangerousReleaseInternal <0x00670>
	  at System.Runtime.InteropServices.SafeHandle:InternalFinalize <0x0009a>
	  at System.Runtime.InteropServices.SafeHandle:Dispose <0x000e2>
	  at System.Runtime.InteropServices.SafeHandle:Finalize <0x0006b>
	  at DHARTAPI.NativeUtils.NativeObject:Finalize <0x00142>
	  at System.Object:runtime_invoke_virtual_void__this__ <0x0018b>
=================================================================

and

0x00007FF88F7446DF (embree3) rtcReleaseScene
0x00007FF8A36CE273 (DHARTAPI) GetPathInfo
0x00007FF8A36C5573 (DHARTAPI) DestroyRayTracer

Another idea I had was to simplify another data conversion on the c++ side. What is the rationale behind the conversions in lines 273 & 274?

In the end, we need float values anyway:

If it's only to make looping over data more convenient, then it could be restructured to operating directly on a pointer to the float array we pass from c#. This could shave off another few ms per call.

Originally posted by @mariuszhermansdorfer in #33 (reply in thread)

Create table of contents and split up contributing guide so its easier to read and follow.

https://github.com/cadop/dhart/blob/main/CONTRIBUTING.md

There is an assumption of triangles, can cause issues later for bvh.

Need to double check we never get here without converting to triangles

Describe the bug
Building from the command line produces warnings. Build completes successfully but places build folder in unexpected directory.

To Reproduce
Follow build instructions for Python Release

Expected behavior
No warnings are expected
Build folder is expected at dhart/build/Python/

Screenshots
The following output is produced by the first step:

-- Selecting Windows SDK version 10.0.20348.0 to target Windows 10.0.19044.
cmake : CMake Warning:
At line:1 char:1
+ cmake ./src/  -G"Visual Studio 16 2019"  -DCMAKE_GENERATOR_PLATFORM=" ...
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo          : NotSpecified: (CMake Warning::String) [], RemoteException
    + FullyQualifiedErrorId : NativeCommandError
 
  Ignoring extra path from command line:
   ".\"
-- The C compiler identification is MSVC 19.29.30146.0
-- The CXX compiler identification is MSVC 19.29.30146.0
-- Detecting C compiler ABI info
-- Detecting C compiler ABI info - done
-- Check for working C compiler: C:/Program Files (x86)/Microsoft Visual Studio/2019/Community/VC/Tools/MSVC/14.29.30133/bin/Hostx64/x64/cl.exe - skipped
-- Detecting C compile features
-- Detecting C compile features - done
-- Detecting CXX compiler ABI info
-- Detecting CXX compiler ABI info - done
-- Check for working CXX compiler: C:/Program Files (x86)/Microsoft Visual Studio/2019/Community/VC/Tools/MSVC/14.29.30133/bin/Hostx64/x64/cl.exe - skipped
-- Detecting CXX compile features
-- Detecting CXX compile features - done
 EIGEN DIR 
 ROBIN_HOOD 
[STATUS]All Selected as the current DHARTAPI_Configuration
[STATUS]Generating all packages
[STATUS]Setting embree dir to C:/Users/USER/Documents/GitHub/dhart/src/external/Embree
Installing Python!
-- Configuring done
-- Generating done
CMake Warning:
  Manually-specified variables were not used by the project:
    INSTALL_GTEST
-- Build files have been written to: C:/Users/USER/Documents/GitHub/dhart

Build and install complete successfully.

Build folder appears in the parent directory.

Additional context

Some of the Visual Studio tools required in BUILD.md are not listed in the Visual Studio Community 2019 Installer by name. As many as could be found + anything related was used.

The current unity integration demo requires users to build and run the project, so it works for releasing and running a Unity project, but not for running with the editor.

The issue is when users drag the DLLs into Assets, there is no error, and can use the DLL in visual studio. However, when pressing play in the editor, it says that the C DLL is not found and errors with DLLNotFoundException: DHARTAPI.dll. When using build and run the target project does work.

I am not sure how to solve it, or how to make the process easier.

port optimizations from OcclusionRays to other methods such as this one ?

Originally posted by @mariuszhermansdorfer in #46 (comment)

Some API changes within embree interface will be required.

https://github.com/embree/embree/releases/tag/v4.0.0

Todo

• Check if new compiler changes legacy support
• Update tbb

There are a few function names such as 'ViewAnalysis' that are called 'SphericalViewAnalysis' in other interfaces. This should be standardized.

Edge type for step etc. is not exposed in C API.

EdgeSet is using intedge, which is 'lightweight', probably for performance. If performance isn't too bad, include an edgeset with cost type stored. Doesn't need to be returned with graph, but should act like a custom attribute or energy expenditure for query on an edge id.

Update dynamic scheduling functions to batch with size 128 to improve performance (based on empirical testing)

Pytest, doctest, and google tests are used within the repo, but they currently aren't integrated with workflows. Need to add them to pull request on main.

From the SHAPE paper, it shows how to make a path in the center of the room without removing nodes. This should be a default edge set value that takes in a specified distance and perhaps a falloff coefficient (function?)

Setup github actions to automatically create release/tags on pull to the main branch.

Currently, DHART only shoots single rays with the rtcOccluded1 method:

Embree, however, supports shooting streams of rays in various configurations:
rtcOccluded1M
rtcOccluded1Mp
rtcOccludedNp

Furthermore, 3 flags can be passed to the intersection context to speed up ray traversal:
https://spec.oneapi.io/oneart/latest/embree-spec.html#rtcinitintersectcontext

enum RTCIntersectContextFlags
{
  RTC_INTERSECT_CONTEXT_FLAG_NONE,
  RTC_INTERSECT_CONTEXT_FLAG_INCOHERENT,
  RTC_INTERSECT_CONTEXT_FLAG_COHERENT,
}; 

It would be great if these could be added to the c# wrapper as well.

Visibility graph all to all undirected is returned a value less than 0.

Currently users need to export the mesh data from grasshopper and load in visualization results. We need to add a build of the plugin for direct access.

There is a build.md in the main directory, but it does not contain any image guides and is not included in the C++/C#/Python docs.

Need to add a walkthrough of using visual studio to build the project from source, regenerating cmake, opening the build solution, using the cmake install (in VS).

Sphinx linkcode extension fails on github actions

Use case description:

I'm working with a large mesh (500.000 quads) against which I constantly cast single rays from mouse cursor's position. This mesh is then modified while the mouse moves. At any given time only a few dozen vertices are affected. Only vertex position changes, face indices remain unchanged.

Wish

I'd like to be able to keep the existing BVH and only update a subset of vertices.

@cadop, do you have any ideas on how to approach this?

The Load OBJ functions are available for an obj file and create a mesh info. It would be helpful to debug and recognize what is being used in an analysis if mesh info was able to be stored as an obj file (which can then be loaded in a graphics tool).

When trying to switch between branches or committing to the active one from VS 2022 I get the following error:

Git failed with a fatal error.
Git failed with a fatal error.
unable to parse command-line config

Error reading git config: error running C:\Users\MRHE\AppData\Local\Programs\Git\mingw64\bin\git.exe 'config' '-l': 'error: bogus format in GIT_CONFIG_PARAMETERS
unable to parse command-line config' 'exit status 128'

The Git for Windows Desktop App works fine.
This is the first time I encounter a similar problem and unfortunately don't really know how to troubleshoot it.

EDIT, here is the error message when I try to pull from remote:

Remote: Total 74 (delta 52), reused 71 (delta 49), pack-reused 0        
From https://github.com/mariuszhermansdorfer/dhart
   f78e70523..5155c7795  support-for-stream-of-rays-in-embree -> origin/support-for-stream-of-rays-in-embree
Updating f78e70523..5155c7795
Error: failed to call git rev-parse --git-dir: exit status 128 : error: bogus format in GIT_CONFIG_PARAMETERS
Git failed with a fatal error.
Git failed with a fatal error.
unable to parse command-line config

Error reading git config: error running C:\Users\MRHE\AppData\Local\Programs\Git\mingw64\bin\git.exe 'config' '-l': 'error: bogus format in GIT_CONFIG_PARAMETERS
unable to parse command-line config' 'exit status 128'

The CMakeSettings.json is deprecated and should move to CMakePresets.json

See: https://learn.microsoft.com/en-us/cpp/build/cmake-presets-vs?view=msvc-160

The current index.html simply defines some HTML buttons to navigate to individual docs. It would be nice to improve this landing/splash page.