Skip to content

Commit 858c0d9

Browse files
committed
Add faq.rst
1 parent d443b86 commit 858c0d9

File tree

2 files changed

+38
-0
lines changed

2 files changed

+38
-0
lines changed

docs/source/index.rst

+1
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
tutorial/nonlinear_ccd.rst
1616
tutorial/simulation.rst
1717
tutorial/misc.rst
18+
tutorial/faq.rst
1819
tutorial/references.rst
1920

2021
.. toctree::

docs/source/tutorial/faq.rst

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
.. _faq:
2+
3+
Frequently Asked Questions
4+
==========================
5+
6+
.. role:: cpp(code)
7+
:language: c++
8+
.. role:: cmake(code)
9+
:language: cmake
10+
.. role:: python(code)
11+
:language: python
12+
13+
How do I include IPC Toolkit in my project?
14+
-------------------------------------------
15+
16+
If you are using CMake, the public include directory is added to the :cmake:`ipc::toolkit` cmake target which means that any lib/bin that includes :cmake:`ipc::toolkit` as a dependency also adds those include directories too.
17+
18+
If you are not using CMake, the include path is ``src``.
19+
20+
Files are included with the prefix :cpp:`#include <ipc/...>` in C++ and :python:`import ipctk` in Python.
21+
22+
How do I determine which edges intersect?
23+
-----------------------------------------
24+
25+
We do not provide an edge-edge intersection function in 3D, but you can approximate it by computing the distance between the two edges and checking if it is less than a threshold.
26+
27+
Inside any :cpp:`BroadPhase` classes, the function :cpp:`detect_edge_edge_candidates` determines which edges intersect based on their bounding boxes. You can then use :cpp:`edge_edge_distance` to check if they approximatly intersect by computing the distance.
28+
29+
How do I build the edge matrix from the face matrix?
30+
----------------------------------------------------
31+
32+
To build the edge matrix you can use :cpp:`igl::edges(faces, edges);` in C++ or :python:`ipctk.edges(faces)` in Python.
33+
34+
My question is not answered here. What should I do?
35+
---------------------------------------------------
36+
37+
Please open an issue on `GitHub <https://github.com/ipc-sim/ipc-toolkit/issues>`_ and we will do our best to help you.

0 commit comments

Comments
 (0)