Archived issue #0031732
Documentation - move Tutorials and Samples into dedicated section
Description
Currently, OCCT samples and messed up in documentation structure making them harder to access. In scope of #0027191 it was proposed to move Tutorials and Sample into dedicated section.
This bug proposes the following structure and descriptions for this section:
This bug proposes the following structure and descriptions for this section:
Tutorials & Samples
- Bottle Tutorial
This tutorial shows step-by-step how to create a 3D object.
- MFC Interactive Samples
MFC sample located within samples\mfc\standard folder represents
an interactive tutorial for learning OCCT components.
Each sub-sample is devoted to specific OCCT domain,
provides a set of small actions like creation of a point or a B-Spline surface,
which is displayed in 3D Viewer and accompanied by a code snippet.
It consists of the following parts:
* Geometry
Shows creation of geometrical objects (points, curves, surfaces).
* Modeling
Shows creation of topological objects (primitives, Boolean operations).
* Convert
Shows conversion of primitive geometry
(circle, cylinder, Bézier, revolution) into B-Spline geometry.
* Triangulation
Shows usage of meshing algorithm on shapes.
* Viewer2D
Shows displaying various 2D objects in the Viewer.
* Viewer3D
Shows displaying 3D objects, configuring light sources,
shading model, applying textures in the 3D Viewer, etc.
* Animation
Shows an animated 3D object in 3D Viewer.
* OCAF
Shows various operations on OCAF document.
* HLR
Shows usage of HLR algorithm.
- Draw Harness samples
Draw Harness includes a set of Samples written in Tcl language
demonstrating usage of OCCT components.
Source code of Tcl Scripts is directly accessible and provided with comments.
Samples are arranged into several groups:
* Modeling
Shows creation of a shape.
* XDE
Shows filling in exploration of XDE document (with colors, assembly structure, etc.).
* Visualization
Shows various 3D Viewer capabilities (materials, shading models, markers, Ray-Tracing).
* Demos
Various demonstrations.
- 3D Viewer integration
* Qt/QWidget Viewer sample
Qt IESample sample demonstrates OCCT 3D Viewer integration into Qt/QWidget application
as well as model import/export functionality from/to external file.
* Qt/QtQuick Viewer sample (Android)
AndroidQt sample demonstrates OCCT 3D Viewer integration into Qt/QtQuick (QML) application for Android
* C# C++/CLI WinForms sample
WinForms sample demonstrates OCCT 3D Viewer integration into C# application
using WinForms GUI framework via C++/CLI layer.
* C# C++/CLI WPF sample
WPF sample demonstrates OCCT 3D Viewer integration into C# application
using WPF GUI framework via C++/CLI layer.
* WebGL Viewer sample (WebAssembly)
WebGL sample demonstrates OCCT 3D Viewer integration into Web (HTML5/JavaScript) application.
* GLFW sample
GLFW sample demonstrates OCCT 3D Viewer integration into GLFW application.
* MFC Viewer sample /// TODO move out from "standard" tutorial-alike samples
MFC Import/Export sample demonstrates OCCT 3D Viewer integration into MFC application
as well as model import/export functionality from/to external file.
* Java/JNI Viewer sample (Android)
JniViewer sample demonstrates OCCT 3D Viewer integration
into Java+JNI application for Android.
(can be also used as a base for QtQuick-based applications for other platforms).
* UIKit Viewer sample (iOS)
UIKitSample sample demonstrates OCCT 3D Viewer integration into UIKit application for iOS.
- Advanced samples
* Qt OCAF FuncDemo
Demonstrates usage of an advanced function mechanism of OCAF.
- TODO remove useless "Qt Tutorial" ???
Public activity
7 archived notes
Participants are labeled by their role within this record.
Branch [archived branch] has been created by Participant.
[revision removed]
Detailed log of new commits:
Author: Vera Sdobnova
Date: Wed Oct 28 18:24:13 2020 +0300
0031732: Documentation - move Tutorials and Samples into dedicated section
All sample descriptions are collected in single document
[revision removed]
Detailed log of new commits:
Author: Vera Sdobnova
Date: Wed Oct 28 18:24:13 2020 +0300
0031732: Documentation - move Tutorials and Samples into dedicated section
All sample descriptions are collected in single document
--- a/samples/qt/AndroidQt/ReadMe.md +++ /dev/null
Removing basic description from the location of sample itself does not look like a good idea. In such context, OCCT overall documentation will be the only place to figure out how to use the sample, and this might be not a natural and trivial connection if user will start looking in opposite direction - will bury into samples directory and will found not a word on how to build a sample.
Branch [archived branch] has been updated forcibly by Participant.
[revision removed]
[revision removed]
I have tried using Docygen command \includ{doc} to insert description of sample from its own separate file md (see last commit). Alas, this does not work as expacted - neither of Doxygen or MarkDown mark-up for headings work in such a case.
Please close the issue - considered in scope of #0032551.
It doesn't look useful merged all samples into a single document.
It doesn't look useful merged all samples into a single document.
Closed.
Branch [archived branch] has been deleted by Commenter 3.
[revision removed]
[revision removed]
Related records
- #0028087 · related to · newOCCT Samples Redesign
- #0031570 · related to · closedSamples - add Qt samples similar to standard MFC samples
- #0032551 · related to · closedDocumentation - Novice user guide for OCCT Documentation
- #0027191 · child of · closedDocumentation - redesign of information architecture