Merge pull request #1 from rerun-io/roym899/cpp_example

Add C++ example with OpenCV and Eigen

Author: Wumpf

.clang-format

@@ -0,0 +1,33 @@
+BasedOnStyle: Google
+
+# Make it slightly more similar to Rust.
+# Based loosely on https://gist.github.com/YodaEmbedding/c2c77dc693d11f3734d78489f9a6eea4
+AccessModifierOffset: -2
+AlignAfterOpenBracket: BlockIndent
+AllowAllArgumentsOnNextLine: false
+AllowShortBlocksOnASingleLine: false
+AllowShortCaseLabelsOnASingleLine: false
+AllowShortFunctionsOnASingleLine: Empty
+AllowShortIfStatementsOnASingleLine: Never
+AlwaysBreakAfterReturnType: None
+AlwaysBreakBeforeMultilineStrings: true
+BinPackArguments: false
+BreakStringLiterals: false
+ColumnLimit: 100
+ContinuationIndentWidth: 4
+DerivePointerAlignment: false
+EmptyLineBeforeAccessModifier: LogicalBlock
+IndentWidth: 4
+IndentWrappedFunctionNames: true
+InsertTrailingCommas: Wrapped
+MaxEmptyLinesToKeep: 1
+NamespaceIndentation: All
+PointerAlignment: Left
+ReflowComments: false
+SeparateDefinitionBlocks: Always
+SpacesBeforeTrailingComments: 1
+
+# Don't change include blocks, we want to control this manually.
+# Sorting headers however is allowed as all our headers should be standalone.
+IncludeBlocks: Preserve
+SortIncludes: CaseInsensitive

.gitignore

@@ -1,32 +1,5 @@
-# Prerequisites
-*.d
+# Build directory
+build
 
-# Compiled Object files
-*.slo
-*.lo
-*.o
-*.obj
-
-# Precompiled Headers
-*.gch
-*.pch
-
-# Compiled Dynamic libraries
-*.so
-*.dylib
-*.dll
-
-# Fortran module files
-*.mod
-*.smod
-
-# Compiled Static libraries
-*.lai
-*.la
-*.a
-*.lib
-
-# Executables
-*.exe
-*.out
-*.app
+# Pixi environment
+.pixi

CMakeLists.txt

@@ -0,0 +1,20 @@
+cmake_minimum_required(VERSION 3.16)
+
+project(rerun_external_cpp_proj LANGUAGES CXX)
+
+set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
+
+if(NOT DEFINED CMAKE_CXX_STANDARD)
+  set(CMAKE_CXX_STANDARD 17)
+endif()
+
+include(FetchContent)
+FetchContent_Declare(rerun_sdk URL https://build.rerun.io/commit/06dd483/rerun_cpp_sdk.zip) # 2023-10-20
+FetchContent_MakeAvailable(rerun_sdk)
+
+find_package(Eigen3 REQUIRED)
+find_package(OpenCV REQUIRED)
+
+add_executable(rerun_ext_example src/main.cpp)
+
+target_link_libraries(rerun_ext_example Eigen3::Eigen ${OpenCV_LIBS} rerun_sdk)

README.md

@@ -0,0 +1,45 @@
+# C++ Example with OpenCV and Eigen
+
+This is a minimal CMake project that shows how to use [Rerun](https://github.com/rerun-io/rerun) in your code in conjunction with [Eigen](https://eigen.tuxfamily.org/) and [OpenCV](https://opencv.org/).
+
+## Installing the Rerun viewer
+The Rerun C++ SDK works by connecting to an awaiting Rerun Viewer over TCP.
+
+#### Building from source
+* [Install `cargo`](https://rustup.rs/)
+* `cargo install rerun-cli`
+
+#### Using `pip`
+* `pip install rerun-sdk`
+
+### Running the Rerun viewer
+Just type `rerun` and the rerun viewer should show up. Then it is time to run this example!
+
+
+## Run this example
+
+### Using `pixi`
+The easiest way to get started is to install [pixi](https://prefix.dev/docs/pixi/overview).
+
+* Start the rerun viewer with `rerun` (see above)
+* Run the example with `rerun run run`
+
+
+### Manually
+First install the required dependencies:
+* `arrow-cpp`` (required by Rerun)
+* `eigen` and `opencv` (required by this example)
+* `cmake` and `ninja` (build tools)
+
+Build using:
+
+```bash
+mkdir build
+cd build
+cmake ..
+cmake --build . -- -j8
+```
+
+Then run the binary with:
+
+`build/rerun_ext_example`