Skip to content

Free Motion Capture for Everyone πŸ’€βœ¨

TypeScript

adding mermaid flow diagrams of FMC_Camera Class/Main file

jon6c9657cbd514
diff --git a/.gitignore b/.gitignore
index 9b3e4e91..a5e5f60d 100644
--- a/.gitignore
+++ b/.gitignore
@@ -138,3 +138,5 @@ dmypy.json
update_pip.txt
freemocap/user_preferences.yaml
freemocap/fmc_startup/user_preferences.yaml
+
+.obsidian/
diff --git a/freemocap/dev_scratchpad/dev_alpha/FreeMoCap_Alpha_Mermaid_Flow_Diagram.md b/freemocap/dev_scratchpad/dev_alpha/FreeMoCap_Alpha_Mermaid_Flow_Diagram.md
new file mode 100644
index 00000000..e56f1b56
--- /dev/null
+++ b/freemocap/dev_scratchpad/dev_alpha/FreeMoCap_Alpha_Mermaid_Flow_Diagram.md
@@ -0,0 +1,34 @@
+# FMC_Camera
+
+```mermaid
+graph TD
+ M[__Main__]--1-create-as-context-manger-->I[FMC_Camera.__init__];
+ I--2-creates-->C[FMC_Camera_Object->'cam']
+ I--3-returns-cam-obj-->M
+ M--4-calls-->Cs[cam.Show]
+```
+
+
+```mermaid
+classDiagram
+ class FMC_Camera{
+ +[int] cam_num = 0
+ +[queue] frame_queue = None
+ +[barrier] barrier = None
+ +[event] exit_event = None
+ +[bool] show_cam_stream = False
+ +[rich_console] rich_console = None,
+ +[bool] show_console = False,
+ +[dict] cap_parameters_dict = cap_default_parameters_dict,
+ +[bool] vid_save_path=None,
+ __init__()
+ show_cam_stream(self, show_cam_stream_bool=True)
+ open(self)
+ show(self)
+ run_in_thread(self)
+ __enter__()
+ __exit__()
+ }
+
+```
+