repository·master·Indexed 18 days ago
https://github.com/coin3d/coinAn OpenGL-based, open-source C++ class library that implements the Open Inventor 2.1 API. Coin uses a scene graph-based, retained mode approach for 3D visualization and model manipulation, featuring support for GLSL shaders, 3D sound, and VRML97. It includes the coin-config utility for managing build and installation information, and provides tools for configuring rendering via SoRenderManager and application settings via SoConfigSettings.
Coin is an OpenGL-based, 3D graphics library that implements the Open Inventor 2.1 API. It is a scene graph based, retained mode, C++ class library designed for 3D visualization and model manipulation.
Key features include:
Coin is the core component of the larger 'Coin3D' library group.
Coin uses a three-digit versioning system (Major.Minor.Micro) to manage API and ABI compatibility:
Note on SDKs: You can only have one Software Development Kit (headers and link-time libraries) installed at a time for a specific major version. Installing a newer major version SDK will overwrite the headers of the previous major version. To develop against multiple major versions, you must manually manage include and libdir paths.
Coin introduces SoConfigSettings as a configuration settings database to manage application-level settings.
src/misc/SoConfigSettings.cppCoin comes with statically compiled scene graph geometries used as defaults for various draggers. You can override these defaults by setting the SO_DRAGGER_DIR environment variable to a directory containing replacement .iv files.
To ensure the draggers correctly recognize and extract the parts from your custom geometries, you must follow these two requirements:
.iv files as the original default geometries..iv files as specified in the original geometry specifications.For more detailed implementation guidance, refer to "Customizing a Dragger" in Chapter 15 of "The Inventor Mentor" (ISBN 0-201-62495-8).
# Example: Pointing Coin to a directory with custom dragger geometries
export SO_DRAGGER_DIR=/path/to/your/custom/geometriesCoin uses an in-tree, minimal test runner defined in testsuite/CoinTest.h which provides a subset of Boost.Test-style macros like BOOST_AUTO_TEST_CASE and BOOST_CHECK_MESSAGE.
To implement tests, wrap your test code inside an #ifdef COIN_TEST_SUITE block within the component's implementation (.cpp) file.
Requirements:
#include in the file must be the header declaring the component being tested. Alternatively, you can add specific #include directives inside the COIN_TEST_SUITE block.// COIN_TEST_SUITE after the #endif directive so the extractor can correctly identify the end of the block.#ifdef COIN_TEST_SUITE
#include "MyComponent.h"
BOOST_AUTO_TEST_CASE(test_name)
{
// test-code ...
}
#endif // COIN_TEST_SUITEThis example demonstrates how to build shared objects and load them dynamically. Note that this specific setup is configured for Coin and may require Makefile modifications to work with other Open Inventor implementations.
Build the shared objects using GNU make:
makeUpdate the dynamic load path to ensure the system can find the newly built shared objects:
export LD_LIBRARY_PATH=".:$LD_LIBRARY_PATH"Run the examinerviewer to load the scene file:
../SoGuiExamples/components/examinerviewer scene.ivInteract: Switch the viewer to interaction mode and use keyboard keys to observe the reaction in the 3D model.
Build the shared objects using GNU make:
makeUpdate the PATH (though often unnecessary for the current directory in Cygwin):
export PATH=".:$PATH"Run the examinerviewer:
../SoGuiExamples/components/examinerviewer scene.iv# UNIX Build and Run sequence
make
export LD_LIBRARY_PATH=".:$LD_LIBRARY_PATH"
../SoGuiExamples/components/examinerviewer scene.ivCoin supports an optional extension called superglu, which is a custom version of GLU 1.3. If you encounter issues with standard GLU, you can embed superglu into your Coin build.
To do this, clone the superglu repository into the src/extensions/ directory of your Coin source tree, then rerun the configure script and rebuild Coin.
hg clone http://hg.sim.no/superglu/default superglu
# Then rerun configure and rebuild CoinWhen you add a new .cpp file containing test cases, the CMake-based extractor (testsuite/CMakeLists.txt) will discover it, but the internal list of files containing test code is not updated automatically.
You must manually trigger an update of the file list by running the following command from the top-level directory:
make makefile-updateAs of recent updates (around version 4.0.8), Coin has removed its dependency on the Boost libraries.
Key changes for developers:
boost::intrusive_ptr or other Boost-specific pointer helpers. A new internal smart pointer header include/Inventor/misc/SoRefPtr.h has been introduced to replace them.Boost.Test with a custom in-tree test runner located in the testsuite/ directory.findNecessaryBoostIncludes.sh).If you are integrating Coin into a project that previously relied on Coin's Boost dependency, you should update your code to use SoRefPtr.h for reference counting and ensure your build environment no longer requires Boost for Coin-related tasks.
.iv files are compliant and behave correctly across different aspect ratios, resize the viewer window in both directions. Specifically, test the viewer by making the window larger in the vertical dimension than the horizontal dimension, and then vice versa. This ensures the camera settings handle varying window proportions as expected.After building Coin, you can execute the tests or debug crashes using the following commands from the top-level directory:
make testsuite-runmakemake verbose to see detailed output and pinpoint the failing case.make debug.Note: make debug is only supported on platforms using gcc and gdb (e.g., Linux, macOS, Unix) and is not currently supported on Windows.
# Run tests
make testsuite-run
# Debugging
make verbose
make debug