mirror of
https://git.dev.opencascade.org/repos/occt.git
synced 2025-08-04 13:13:25 +03:00
0024431: Using svg-images in the documentation
Documentation generator improved to automatically convert SVG images to PDF when PDF documents are generated. This is done with Inkscape thus it becomes necessary for generation of PDF documents. Doxygen alias "figure" added for easy insertion of images with single command for both HTML and PDF output. Documentation is updated. Reviewed documentation.md and added more recommendations on Document Syntax. Introduced existing svg images in the documentation. Description of formatting of plain text, code blocks, and references revised. Snapshot of structure of dox folder is updated. Copyright year is corrected in PDF documents to be always the current one. Some grammar corrections.
This commit is contained in:
@@ -52,8 +52,7 @@ This modeling requires four steps:
|
||||
|
||||
To create the bottle's profile, you first create characteristic points with their coordinates as shown below in the (XOY) plane. These points will be the supports that define the geometry of the profile.
|
||||
|
||||
@image html /tutorial/images/tutorial_image003.png
|
||||
@image latex /tutorial/images/tutorial_image003.png
|
||||
@figure{/tutorial/images/tutorial_image003.svg}
|
||||
|
||||
There are two classes to describe a 3D Cartesian point from its X, Y and Z coordinates in Open CASCADE Technology:
|
||||
|
||||
@@ -67,7 +66,7 @@ To choose the best class for this application, consider the following:
|
||||
* *Geom_CartesianPoint* is manipulated by handle and may have multiple references and a long lifetime.
|
||||
|
||||
Since all the points you will define are only used to create the profile's curves, an object with a limited lifetime will do. Choose the *gp_Pnt* class.
|
||||
To instantiate a *gp_Pnt* object, just specify the X, Y, and Z coordinates of the points in the global cartesian coordinate system:
|
||||
To instantiate a *gp_Pnt* object, just specify the X, Y, and Z coordinates of the points in the global Cartesian coordinate system:
|
||||
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
|
||||
gp_Pnt aPnt1(-myWidth / 2., 0, 0);
|
||||
|
Reference in New Issue
Block a user