Commit 31c1bf2c authored by Sreekanth Arikatla's avatar Sreekanth Arikatla

DOC: Add short description for examples

1 or 2 line descriptions are added for each example.
parent 8593b7c5
......@@ -31,7 +31,6 @@
using namespace imstk;
// Example modified from SFML/Examples
void playSound(const std::string& filename)
{
#ifdef iMSTK_AUDIO_ENABLED
......@@ -78,7 +77,6 @@ void playSound(const std::string& filename)
#endif
}
// Example modified from SFML/Examples
void playMusic(const std::string& filename)
{
#ifdef iMSTK_AUDIO_ENABLED
......@@ -115,6 +113,10 @@ void playMusic(const std::string& filename)
#endif
}
///
/// \brief This example demonstrates the audio feature in imstk.
/// NOTE: Example modified from SFML/Examples
///
void main()
{
// Initialize g3logger
......
......@@ -50,6 +50,10 @@ const std::string phantomOmni1Name = "Phantom1";
using namespace imstk;
///
/// \brief This example demonstrates bone drilling.
/// NOTE: Requires GeoMagic Touch device
///
int main()
{
// SDK and Scene
......
......@@ -34,6 +34,10 @@ const std::string phantomOmni1Name = "Phantom1";
using namespace imstk;
///
/// \brief This example demonstrates controlling the camera
/// using external device. NOTE: Requires GeoMagic Touch device
///
int main()
{
// SDK and Scene
......
......@@ -35,6 +35,10 @@
using namespace imstk;
///
/// \brief This example demonstrates the soft body simulation
/// using FEM
///
int main()
{
// a. SDK and Scene
......
......@@ -25,6 +25,10 @@
using namespace imstk;
///
/// \brief This example shows how to extract the triangular surface
/// mesh from a volumetric tetrahedral mesh
///
void extractSurfaceMesh()
{
auto sdk = std::make_shared<SimulationManager>();
......
......@@ -28,6 +28,9 @@
using namespace imstk;
///
/// \brief This example demonstrates the geometry transforms in imstk
///
int main()
{
// SDK and Scene
......@@ -73,9 +76,9 @@ int main()
// Rotate the dragon every frame
auto rotateFunc =
[&surfaceMesh](Module* module)
{
surfaceMesh->rotate(Vec3d(1., 0, 0), PI / 1000, Geometry::TransformType::ApplyToData);
};
{
surfaceMesh->rotate(Vec3d(1., 0, 0), PI / 1000, Geometry::TransformType::ApplyToData);
};
sdk->getSceneManager(scene)->setPostUpdateCallback(rotateFunc);
// Set Camera configuration
......
......@@ -25,6 +25,9 @@
using namespace imstk;
///
/// \brief This example demonstrates the imstk graph usage
///
int main()
{
Graph g1(5);
......
......@@ -29,11 +29,11 @@ const std::string phantomOmni1Name = "Phantom1";
using namespace imstk;
void lapToolController()
{
}
///
/// \brief This example demonstrates controlling laparoscopic
/// tool with two jaws with an external device.
/// NOTE: Requires GeoMagic Touch device
///
int main()
{
#ifdef iMSTK_USE_OPENHAPTICS
......
......@@ -25,6 +25,9 @@
using namespace imstk;
///
/// \brief This example demonstrates I/O of the mesh
///
int main()
{
// SDK and Scene
......
......@@ -25,6 +25,9 @@
using namespace imstk;
///
/// \brief This example shows how to read .msh and .veg files
///
void MshAndVegaIO()
{
// SDK and Scene
......
......@@ -30,6 +30,10 @@ const std::string phantomOmni1Name = "Phantom1";
using namespace imstk;
///
/// \brief This example demonstrates controlling the object
/// using external device. NOTE: Requires GeoMagic Touch device
///
int main()
{
#ifdef iMSTK_USE_OPENHAPTICS
......
......@@ -26,10 +26,12 @@
using namespace imstk;
///
/// \brief This example demonstrates the cloth simulation
/// using Position based dynamics
///
int main()
{
auto sdk = std::make_shared<SimulationManager>();
auto scene = sdk->createNewScene("PBDCloth");
......@@ -126,7 +128,7 @@ int main()
// Start
sdk->setActiveScene(scene);
sdk->startSimulation(SimulationStatus::PAUSED);
return 0;
}
......@@ -28,6 +28,10 @@
using namespace imstk;
///
/// \brief This example demonstrates the collision interaction
/// using Position based dynamics
///
int main()
{
auto sdk = std::make_shared<SimulationManager>();
......
......@@ -28,6 +28,10 @@
using namespace imstk;
///
/// \brief This example demonstrates the fluids simulation
/// using Position based dynamics
///
int main()
{
auto sdk = std::make_shared<SimulationManager>();
......
......@@ -28,6 +28,10 @@
using namespace imstk;
///
/// \brief This example demonstrates the soft body simulation
/// using Position based dynamics
///
int main()
{
auto sdk = std::make_shared<SimulationManager>();
......@@ -48,7 +52,7 @@ int main()
if (!volTetMesh)
{
LOG(WARNING) << "Dynamic pointer cast from PointSet to TetrahedralMesh failed!";
return 1 ;
return 1;
}
volTetMesh->extractSurfaceMesh(surfMesh, true);
......@@ -76,7 +80,7 @@ int main()
/*TimeStep*/ 0.01,
/*FixedPoint*/ "51 127 178",
/*NumberOfIterationInConstraintSolver*/ 5
);
);
deformableObj->setDynamicalModel(pbdModel);
deformableObj->setVisualGeometry(surfMesh);
......
......@@ -38,6 +38,10 @@ const std::string phantomOmni1Name = "Phantom1";
using namespace imstk;
///
/// \brief This example demonstrates picking nodes of soft object.
/// NOTE: Requires GeoMagic Touch device
///
int main()
{
// SDK and Scene
......
......@@ -23,6 +23,9 @@
using namespace imstk;
///
/// \brief This example show how to write plotting code for matlab and python
///
int main()
{
Vectord a;
......
......@@ -24,6 +24,10 @@
using namespace imstk;
///
/// \brief This example demonstrates configuring the rendered
/// objects, lights etc.
///
int main()
{
// SDK and Scene
......
......@@ -23,6 +23,9 @@
using namespace imstk;
///
/// \brief This example demonstrates scene management features in imstk
///
int main()
{
// THIS TESTS NEEDS TO DISABLE STANDALONE VIEWER RENDERING
......
......@@ -26,6 +26,9 @@
using namespace imstk;
///
/// \brief This example demonstrates how to capture the screenshot
///
int main()
{
// SDK and Scene
......
......@@ -24,6 +24,10 @@
using namespace imstk;
///
/// \brief This example demonstrates various pieces of the rendering
/// scene i.e., objects, lights, camera etc.
///
int main()
{
// SDK and Scene
......
......@@ -32,6 +32,10 @@ const std::string phantomOmni1Name = "Phantom1";
using namespace imstk;
///
/// \brief This example demonstrates the concept of virtual coupling
/// for haptic interaction. NOTE: Requires GeoMagic Touch device
///
int main()
{
// SDK and Scene
......
......@@ -25,6 +25,10 @@
using namespace imstk;
///
/// \brief This example demonstrates decal rendering feature.
/// NOTE: Requires enabling Vulkan rendeing backend
///
int main()
{
// SDK and Scene
......
......@@ -25,6 +25,9 @@
using namespace imstk;
///
/// \brief This example demonstrates the continuous collision detection feature
///
int main()
{
// SDK and Scene
......@@ -69,9 +72,9 @@ int main()
// Rotate the obj1 every frame
auto rotateFunc = [&](Module* module)
{
mesh1->rotate(Vec3d(1., 0, 0), PI / 1000, Geometry::TransformType::ApplyToData);
};
{
mesh1->rotate(Vec3d(1., 0, 0), PI / 1000, Geometry::TransformType::ApplyToData);
};
sdk->getSceneManager(scene)->setPostUpdateCallback(rotateFunc);
// Light
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment