OpenCascade/occt
1
0
Fork 0
mirror of https://git.dev.opencascade.org/repos/occt.git synced 2025-04-03 17:56:21 +03:00
Code Packages Releases Activity

0033753: Updating OCCT documentation

Browse Source 
Added description and an example for the "offsetperform", "offsetload", "offsetonface" functions in the "Draw Test Harness" section.
Added description for  "offsetperform" function in the "Modeling Algorithms" section.
This commit is contained in:
astromko 2024-07-02 12:49:59 +01:00
parent ca066529b7
commit d79b8f6cce
2 changed files with 37 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
dox/user_guides/draw_test_harness/draw_test_harness.md
View File

@ -4408,9 +4408,32 @@ ellipse e 0 0 0 50 50*sin(angle)
offset l1 e 20 0 0 1
~~~~
@subsubsection occt_draw_6_3_10 offsetperform
@subsubsection occt_draw_6_3_10 offsetload
Creates a new figure by moving faces of an initial figure. Can move any number of faces. The offset direction is set by a positive or negative step value in the «offsetload» or «offsetonface» commands.
Syntax:
~~~~{.php}
offsetload shape step
~~~~
The offsetload function defines the step by which all the shape's faces will be offset. The step value can be positive or negative that defines the direction of the offset.
@subsubsection occt_draw_6_3_11 offsetonface
Syntax:
~~~~{.php}
offsetonface face_1 step_1 face_2 step_2 ... face_n step_n
~~~~
The offsetonface function defines specific faces of the shape and the specific step for each face by which they will be offset. The step value can be positive or negative that defines the direction of the offset.
@subsubsection occt_draw_6_3_12 offsetperform
Syntax:
~~~~{.php}
offsetperform name
~~~~
The offsetperform function creates a new figure by moving faces of an initial figure. Can move any number of faces. The offset direction is set by a positive or negative step value in the «offsetload» or «offsetonface» commands.
**Example:**
~~~~{.php}
@ -4435,13 +4458,13 @@ offsetonface b_2 5 b_3 5 b_6 -2
offsetperform r
~~~~
If you want to move all faces for example on step=2 you should specify it in the «offsetload» command like this:
If you want to move all the faces for example on step=2 you should specify it in the «offsetload» command like this:
~~~~{.php}
offsetload b 2
~~~~
The «offsetonface» command is not needed in this case.
@subsubsection occt_draw_6_3_11 revsurf
@subsubsection occt_draw_6_3_13 revsurf
Syntax:
~~~~{.php}
@ -4461,7 +4484,7 @@ circle c 50 0 0 20
revsurf s c 0 0 0 0 1 0
~~~~
@subsubsection occt_draw_6_3_12 extsurf
@subsubsection occt_draw_6_3_14 extsurf
Syntax:
~~~~{.php}
@ -4483,7 +4506,7 @@ extsurf s e 0 0 1
trimv s s 0 10
~~~~
@subsubsection occt_draw_6_3_13 convert
@subsubsection occt_draw_6_3_15 convert
Syntax:
~~~~{.php}

16
dox/user_guides/modeling_algos/modeling_algos.md
View File

@ -2237,27 +2237,27 @@ The snippets below show usage examples:
NewShape = OffsetMaker2.Shape();
~~~~
@subsubsection occt_modalg_7_2 “offsetperform“ function.
This functon uses 2 algorithms presented by 2 methods of the *BRepOffset_MakeOffset* class:
@subsubsection occt_modalg_7_2 Offsetperform function.
The offsetperform functon uses 2 algorithms presented by 2 methods of the *BRepOffset_MakeOffset* class:
* MakeThickSolid: makes a thick solid from the initial one.
* MakeOffsetShape: makes offset of the initial shape.
Let’s consider the *MakeOffsetShape* method.
*MakeOffsetShape* method.
*MakeOffsetShape* can use 2 algorithms:
* BuildOffsetByArc: simply makes offset faces and then creates arcs between them.
* BuildOffsetByInter: constructs offset using intersections.
The *BuildOffsetByArc* algorithm is quite simple while *BuildOffsetByInter* is more complex.
Let’s consider *BuildOffsetByInter* in detail.
*BuildOffsetByInter* calls *MakeOffsetFaces* and passes to it a map of faces that should be offset.
~~~~{.cpp}
MakeOffsetFaces(/*BRepOffset_DataMapOfShapeOffset&*/ theMapSF,
/*const Message_ProgressRange&*/ theRange)
BRepOffset_MakeOffset theOffsetShape;
theOffsetShape.MakeOffsetFaces(/*BRepOffset_DataMapOfShapeOffset&*/ theMapSF,
/*const Message_ProgressRange&*/ theRange);
~~~~
To make an offset, *MakeOffsetFaces* uses the *BRepOffset_Offset* class.
~~~~{.cpp}
BRepOffset_Offset OF(/*const TopoDS_Face&*/ Face,
BRepOffset_Offset theOffset(/*const TopoDS_Face&*/ Face,
/*const Standard_Real*/ Offset,
/*const Standard_Boolean*/ OffsetOutside,
/*const GeomAbs_JoinType*/ JoinType);
@ -2266,7 +2266,7 @@ BRepOffset_Offset OF(/*const TopoDS_Face&*/ Face,
After the *MakeOffsetFaces* function is finished, *BuildOffsetByInter* uses the *BRepOffset_Inter3d* class to extend our faces if needed and to find intersections between them.
~~~~{.cpp}
BRepOffset_Inter3d Inter3 (/*const Handle (BRepAlgo_AsDes)&*/ AsDes,
BRepOffset_Inter3d theInter3d (/*const Handle (BRepAlgo_AsDes)&*/ AsDes,
/*const TopAbs_State*/ Side,
/*const Standard_Real*/ Tol);