Improve the documentation of HLRBRep.Algo
This commit is contained in:
Pieter Hijma
@@ -14,99 +14,170 @@
|
||||
Delete="false">
|
||||
<Documentation>
|
||||
<Author Licence="LGPL" Name="Werner Mayer" EMail="wmayer[at]users.sourceforge.net" />
|
||||
<UserDocu>Describes functions to use HLR algorithm.</UserDocu>
|
||||
<UserDocu>A framework to compute a shape as seen in a projection
|
||||
plane. This is done by calculating the visible and the hidden parts
|
||||
of the shape. HLRBRep_Algo works with three types of entity:
|
||||
|
||||
- shapes to be visualized
|
||||
- edges in these shapes (these edges are the basic entities which will be
|
||||
visualized or hidden), and
|
||||
- faces in these shapes which hide the edges.
|
||||
|
||||
HLRBRep_Algo is based on the principle of comparing each edge of the shape to
|
||||
be visualized with each of its faces, and calculating the visible and the
|
||||
hidden parts of each edge. For a given projection, HLRBRep_Algo calculates a
|
||||
set of lines characteristic of the object being represented. It is also used in
|
||||
conjunction with the HLRBRep_HLRToShape extraction utilities, which reconstruct
|
||||
a new, simplified shape from a selection of calculation results. This new shape
|
||||
is made up of edges, which represent the shape visualized in the
|
||||
projection. HLRBRep_Algo takes the shape itself into account whereas
|
||||
HLRBRep_PolyAlgo works with a polyhedral simplification of the shape. When you
|
||||
use HLRBRep_Algo, you obtain an exact result, whereas, when you use
|
||||
HLRBRep_PolyAlgo, you reduce computation time but obtain polygonal segments. In
|
||||
the case of complicated shapes, HLRBRep_Algo may be time-consuming. An
|
||||
HLRBRep_Algo object provides a framework for:
|
||||
|
||||
- defining the point of view
|
||||
- identifying the shape or shapes to be visualized
|
||||
- calculating the outlines
|
||||
- calculating the visible and hidden lines of the shape. Warning
|
||||
- Superimposed lines are not eliminated by this algorithm.
|
||||
- There must be no unfinished objects inside the shape you wish to visualize.
|
||||
- Points are not treated.
|
||||
- Note that this is not the sort of algorithm used in generating shading, which
|
||||
calculates the visible and hidden parts of each face in a shape to be
|
||||
visualized by comparing each face in the shape with every other face in the
|
||||
same shape.
|
||||
|
||||
</UserDocu>
|
||||
</Documentation>
|
||||
<Methode Name="add">
|
||||
<Documentation>
|
||||
<UserDocu>Adds the shape S to this framework, and
|
||||
specifies the number of isoparameters nbiso desired in visualizing S.
|
||||
You may add as many shapes as you wish. Use the function Add once for each shape.
|
||||
<UserDocu>add(S, nbIso=0)
|
||||
|
||||
Adds the shape S to this framework, and specifies the number of isoparameters
|
||||
nbiso desired in visualizing S. You may add as many shapes as you wish. Use
|
||||
the function add once for each shape.
|
||||
</UserDocu>
|
||||
</Documentation>
|
||||
</Methode>
|
||||
<Methode Name="remove">
|
||||
<Documentation>
|
||||
<UserDocu>Remove the shape S from this framework.</UserDocu>
|
||||
<UserDocu>remove(i)
|
||||
|
||||
Remove the shape of index i from this framework.
|
||||
</UserDocu>
|
||||
</Documentation>
|
||||
</Methode>
|
||||
<Methode Name="index">
|
||||
<Documentation>
|
||||
<UserDocu>return the index of the Shape S and
|
||||
return 0 if the Shape S is not found.</UserDocu>
|
||||
<UserDocu>index(S) -> int
|
||||
|
||||
Return the index of the Shape S and return 0 if the Shape S is not found.
|
||||
</UserDocu>
|
||||
</Documentation>
|
||||
</Methode>
|
||||
<Methode Name="outLinedShapeNullify">
|
||||
<Documentation>
|
||||
<UserDocu> Nullify all the results of OutLiner from HLRTopoBRep.
|
||||
<UserDocu>outlinedShapeNullify()
|
||||
|
||||
Nullify all the results of OutLiner from HLRTopoBRep.
|
||||
</UserDocu>
|
||||
</Documentation>
|
||||
</Methode>
|
||||
<Methode Name="setProjector" Keyword="true">
|
||||
<Documentation>
|
||||
<UserDocu>set the projector.
|
||||
<UserDocu>setProjector(Origin=(0, 0, 0), ZDir=(0,0,0), XDir=(0,0,0), focus=NaN)
|
||||
|
||||
Set the projector. With focus left to NaN, an axonometric projector is
|
||||
created. Otherwise, a perspective projector is created with focus focus.
|
||||
</UserDocu>
|
||||
</Documentation>
|
||||
</Methode>
|
||||
<Methode Name="nbShapes">
|
||||
<Documentation>
|
||||
<UserDocu>This function is a const member function that returns the number of shapes in the collection.
|
||||
It does not modify the object's state and is used to retrieve the count of shapes.
|
||||
<UserDocu>nbShapes()
|
||||
|
||||
Returns the number of shapes in the collection. It does not modify the
|
||||
object's state and is used to retrieve the count of shapes.
|
||||
</UserDocu>
|
||||
</Documentation>
|
||||
</Methode>
|
||||
<Methode Name="showAll">
|
||||
<Documentation>
|
||||
<UserDocu> set to visible all the edges.
|
||||
<UserDocu>showAll(i=-1)
|
||||
|
||||
If i < 1, then set all the edges to visible.
|
||||
Otherwise, set to visible all the edges of the shape of index i.
|
||||
</UserDocu>
|
||||
</Documentation>
|
||||
</Methode>
|
||||
<Methode Name="hide">
|
||||
<Documentation>
|
||||
<UserDocu>hide the Shape S by itself.
|
||||
<UserDocu>hide(i=-1, j=-1)
|
||||
|
||||
If i < 1, hide all of the datastructure.
|
||||
Otherwise, if j < 1, hide the shape of index i.
|
||||
Otherwise, hide the shape of index i by the shape of index j.
|
||||
</UserDocu>
|
||||
</Documentation>
|
||||
</Methode>
|
||||
<Methode Name="hideAll">
|
||||
<Documentation>
|
||||
<UserDocu>set to hide all the edges of the Shape S.
|
||||
<UserDocu>hideAll(i=-1)
|
||||
|
||||
If i < 1, hide all the edges.
|
||||
Otherwise, hide all the edges of shape of index i.
|
||||
</UserDocu>
|
||||
</Documentation>
|
||||
</Methode>
|
||||
<Methode Name="partialHide">
|
||||
<Documentation>
|
||||
<UserDocu>own hiding of all the shapes of the DataStructure
|
||||
without hiding by each other.
|
||||
<UserDocu>partialHide()
|
||||
|
||||
Own hiding of all the shapes of the DataStructure without hiding by each other.
|
||||
</UserDocu>
|
||||
</Documentation>
|
||||
</Methode>
|
||||
<Methode Name="select">
|
||||
<Documentation>
|
||||
<UserDocu>select all the DataStructure.
|
||||
<UserDocu>select(i=-1)
|
||||
|
||||
If i < 1, select all the DataStructure.
|
||||
Otherwise, only select the shape of index i.
|
||||
</UserDocu>
|
||||
</Documentation>
|
||||
</Methode>
|
||||
<Methode Name="selectEdge">
|
||||
<Documentation>
|
||||
<UserDocu>select only the edges of the Shape S
|
||||
<UserDocu>selectEdge(i)
|
||||
|
||||
Select only the edges of the shape of index i.
|
||||
</UserDocu>
|
||||
</Documentation>
|
||||
</Methode>
|
||||
<Methode Name="selectFace">
|
||||
<Documentation>
|
||||
<UserDocu>select only the faces of the Shape S.
|
||||
<UserDocu>selectFace(i)
|
||||
|
||||
Select only the faces of the shape of index i.
|
||||
</UserDocu>
|
||||
</Documentation>
|
||||
</Methode>
|
||||
<Methode Name="initEdgeStatus">
|
||||
<Documentation>
|
||||
<UserDocu>init the status of the selected edges depending of
|
||||
the back faces of a closed shell.
|
||||
<UserDocu>initEdgeStatus()
|
||||
|
||||
Init the status of the selected edges depending of the back faces of a closed
|
||||
shell.
|
||||
</UserDocu>
|
||||
</Documentation>
|
||||
</Methode>
|
||||
<Methode Name="update">
|
||||
<Documentation>
|
||||
<UserDocu>update the DataStructure.
|
||||
<UserDocu>update()
|
||||
|
||||
Update the DataStructure.
|
||||
</UserDocu>
|
||||
</Documentation>
|
||||
</Methode>
|
||||
|
||||
Reference in New Issue
Block a user