mirror of
https://github.com/Open-Cascade-SAS/OCCT.git
synced 2026-09-11 03:17:27 +08:00
Documentation - Fix whitespaces and typos (#821)
- Removed excessive whitespace between words in comments
- Removed <br> syntax
- Fixed spelling errors ("hilight" → "highlights", "texte" → "text")
- Improved comment formatting and structure
This commit is contained in:
@@ -41,9 +41,12 @@ public:
|
||||
|
||||
//! Constructor. Creates connection with display specified in theDisplayName.
|
||||
//! Display name should be in format "hostname:number" or "hostname:number.screen_number", where:
|
||||
//! hostname - Specifies the name of the host machine on which the display is physically
|
||||
//! attached. number - Specifies the number of the display server on that host machine.
|
||||
//! screen_number - Specifies the screen to be used on that server. Optional variable.
|
||||
//! hostname
|
||||
//! - Specifies the name of the host machine on which the display is physically attached.
|
||||
//! number
|
||||
//! - Specifies the number of the display server on that host machine.
|
||||
//! screen_number
|
||||
//! - Specifies the screen to be used on that server. Optional variable.
|
||||
Standard_EXPORT Aspect_DisplayConnection(const TCollection_AsciiString& theDisplayName);
|
||||
|
||||
//! Constructor wrapping existing Display instance.
|
||||
|
||||
@@ -17,7 +17,7 @@
|
||||
#define _Aspect_TypeOfDeflection_HeaderFile
|
||||
|
||||
//! Defines if the maximal chordial deflection used when
|
||||
//! drawing an object is absolute or relative to the size
|
||||
//! drawing an object is absolute or relative to the size
|
||||
//! of the object.
|
||||
enum Aspect_TypeOfDeflection
|
||||
{
|
||||
|
||||
@@ -18,10 +18,12 @@
|
||||
|
||||
//! Define the style of the text.
|
||||
//!
|
||||
//! TOST_NORMAL Default text. The text is displayed like any other graphic object.
|
||||
//! TOST_NORMAL
|
||||
//! Default text. The text is displayed like any other graphic object.
|
||||
//! This text can be hidden by another object that is nearest from the
|
||||
//! point of view.
|
||||
//! TOST_ANNOTATION The text is always visible. The texte is displayed
|
||||
//! TOST_ANNOTATION
|
||||
//! The text is always visible. The text is displayed
|
||||
//! over the other object according to the priority.
|
||||
enum Aspect_TypeOfStyleText
|
||||
{
|
||||
|
||||
@@ -27,22 +27,22 @@ class Font_FTFont;
|
||||
|
||||
DEFINE_STANDARD_HANDLE(Font_TextFormatter, Standard_Transient)
|
||||
|
||||
//! This class is intended to prepare formatted text by using:<br>
|
||||
//! - font to string combination,<br>
|
||||
//! - alignment,<br>
|
||||
//! - wrapping.<br>
|
||||
//! This class is intended to prepare formatted text by using:
|
||||
//! - font to string combination,
|
||||
//! - alignment,
|
||||
//! - wrapping.
|
||||
//!
|
||||
//! After text formatting, each symbol of formatted text is placed in some position.
|
||||
//! Further work with the formatter is using an iterator.
|
||||
//! The iterator gives an access to each symbol inside the initial row.
|
||||
//! Also it's possible to get only significant/writable symbols of the text.<br>
|
||||
//! Also it's possible to get only significant/writable symbols of the text.
|
||||
//! Formatter gives an access to geometrical position of a symbol by the symbol index in the
|
||||
//! text.<br> Example of correspondence of some text symbol to an index in "row_1\n\nrow_2\n":<br>
|
||||
//! "row_1\n" - 0-5 indices;<br>
|
||||
//! "\n" - 6 index;<br>
|
||||
//! "\n" - 7 index;<br>
|
||||
//! "row_2\n" - 8-13 indices.<br>
|
||||
//! Pay attention that fonts should have the same LineSpacing value for correct formatting.<br>
|
||||
//! text. Example of correspondence of some text symbol to an index in "row_1\n\nrow_2\n":
|
||||
//! "row_1\n" - 0-5 indices;
|
||||
//! "\n" - 6 index;
|
||||
//! "\n" - 7 index;
|
||||
//! "row_2\n" - 8-13 indices.
|
||||
//! Pay attention that fonts should have the same LineSpacing value for correct formatting.
|
||||
//! Example of the formatter using:
|
||||
//! @code
|
||||
//! Handle(Font_TextFormatter) aFormatter = new Font_TextFormatter();
|
||||
@@ -209,7 +209,7 @@ public:
|
||||
//! Returns horizontal alignment style
|
||||
Graphic3d_HorizontalTextAlignment HorizontalTextAlignment() const { return myAlignX; }
|
||||
|
||||
//! Returns vertical alignment style
|
||||
//! Returns vertical alignment style
|
||||
Graphic3d_VerticalTextAlignment VerticalTextAlignment() const { return myAlignY; }
|
||||
|
||||
//! Sets text wrapping width, zero means that the text is not bounded by width
|
||||
|
||||
@@ -157,8 +157,8 @@ public:
|
||||
//! change if Center and Eye translation will be interpolated independently). E.g.:
|
||||
//! - When both Center and Eye are moved at the same vector -> both will be just translated by
|
||||
//! straight line;
|
||||
//! - When Center is not moved -> camera Eye will move around Center through arc;
|
||||
//! - When Eye is not moved -> camera Center will move around Eye through arc;
|
||||
//! - When Center is not moved -> camera Eye will move around Center through arc;
|
||||
//! - When Eye is not moved -> camera Center will move around Eye through arc;
|
||||
//! - When both Center and Eye are move by different vectors -> transformation will be something
|
||||
//! in between,
|
||||
//! and will try interpolate linearly the distance between Center and Eye.
|
||||
@@ -283,7 +283,7 @@ public:
|
||||
Standard_EXPORT Standard_Real Scale() const;
|
||||
|
||||
//! Sets camera scale. For orthographic projection the scale factor
|
||||
//! corresponds to parallel scale of view mapping (i.e. size
|
||||
//! corresponds to parallel scale of view mapping (i.e. size
|
||||
//! of viewport). For perspective camera scale is converted to
|
||||
//! distance. The scale specifies equal size of the view projection in
|
||||
//! both dimensions assuming that the aspect is 1.0. The projection height
|
||||
|
||||
@@ -718,7 +718,7 @@ public: //! @name Selection management
|
||||
//! transformation being applied:
|
||||
//! @code
|
||||
//! const Handle(StdSelect_BRepOwner) aBRepOwner = Handle(StdSelect_BRepOwner)::DownCast
|
||||
//! (SelectedOwner()); TopoDS_Shape aSelShape = aBRepOwner->Shape(); TopoDS_Shape
|
||||
//! (SelectedOwner()); TopoDS_Shape aSelShape = aBRepOwner->Shape(); TopoDS_Shape
|
||||
//! aLocatedShape = aSelShape.Located (aBRepOwner->Location() * aSelShape.Location());
|
||||
//! @endcode
|
||||
//! @sa SelectedOwner(), HasSelectedShape().
|
||||
|
||||
@@ -410,16 +410,16 @@ public: //! @name Presentation computation
|
||||
virtual Standard_Boolean IsAutoHilight() const Standard_OVERRIDE { return Standard_False; }
|
||||
|
||||
//! Method which clear all selected owners belonging
|
||||
//! to this selectable object ( for fast presentation draw ).
|
||||
//! to this selectable object (for fast presentation draw).
|
||||
Standard_EXPORT virtual void ClearSelected() Standard_OVERRIDE;
|
||||
|
||||
//! Method which draws selected owners ( for fast presentation draw ).
|
||||
//! Method which draws selected owners (for fast presentation draw).
|
||||
Standard_EXPORT virtual void HilightSelected(const Handle(PrsMgr_PresentationManager)& thePM,
|
||||
const SelectMgr_SequenceOfOwner& theSeq)
|
||||
Standard_OVERRIDE;
|
||||
|
||||
//! Method which hilight an owner belonging to
|
||||
//! this selectable object ( for fast presentation draw ).
|
||||
//! this selectable object (for fast presentation draw).
|
||||
Standard_EXPORT virtual void HilightOwnerWithColor(
|
||||
const Handle(PrsMgr_PresentationManager)& thePM,
|
||||
const Handle(Prs3d_Drawer)& theStyle,
|
||||
|
||||
@@ -38,7 +38,7 @@ class Geom_Plane;
|
||||
//! value for the representation of the axes. If you modify
|
||||
//! these dimensions, you must temporarily recover the
|
||||
//! Drawer object. From inside it, take the Aspects in
|
||||
//! which the values for length are stocked, for example,
|
||||
//! which the values for length are stocked, for example,
|
||||
//! PlaneAspect for planes and LineAspect for
|
||||
//! trihedra. Change these values and recalculate the presentation.
|
||||
class AIS_PlaneTrihedron : public AIS_InteractiveObject
|
||||
|
||||
@@ -23,7 +23,7 @@ class Poly_Triangulation;
|
||||
|
||||
DEFINE_STANDARD_HANDLE(AIS_Triangulation, AIS_InteractiveObject)
|
||||
|
||||
//! Interactive object that draws data from Poly_Triangulation, optionally with colors associated
|
||||
//! Interactive object that draws data from Poly_Triangulation, optionally with colors associated
|
||||
//! with each triangulation vertex. For maximum efficiency colors are represented as 32-bit integers
|
||||
//! instead of classic Quantity_Color values.
|
||||
//! Interactive selection of triangles and vertices is not yet implemented.
|
||||
|
||||
@@ -181,16 +181,16 @@ public:
|
||||
|
||||
public:
|
||||
//! Method which clear all selected owners belonging
|
||||
//! to this selectable object ( for fast presentation draw ).
|
||||
//! to this selectable object (for fast presentation draw).
|
||||
Standard_EXPORT virtual void ClearSelected() Standard_OVERRIDE;
|
||||
|
||||
//! Method which draws selected owners ( for fast presentation draw ).
|
||||
//! Method which draws selected owners (for fast presentation draw).
|
||||
Standard_EXPORT virtual void HilightSelected(const Handle(PrsMgr_PresentationManager)& thePM,
|
||||
const SelectMgr_SequenceOfOwner& theOwners)
|
||||
Standard_OVERRIDE;
|
||||
|
||||
//! Method which hilight an owner belonging to
|
||||
//! this selectable object ( for fast presentation draw ).
|
||||
//! Method which highlights an owner belonging to
|
||||
//! this selectable object (for fast presentation draw).
|
||||
Standard_EXPORT virtual void HilightOwnerWithColor(
|
||||
const Handle(PrsMgr_PresentationManager)& thePM,
|
||||
const Handle(Prs3d_Drawer)& theStyle,
|
||||
|
||||
@@ -32,7 +32,7 @@ DEFINE_STANDARD_HANDLE(AIS_TypeFilter, SelectMgr_Filter)
|
||||
//! to determine whether it has an non-null owner, and if
|
||||
//! so, whether it is of the desired type. If the object
|
||||
//! returns true in each case, it is kept. If not, it is rejected.
|
||||
//! By default, the interactive object has a None type
|
||||
//! By default, the interactive object has a None type
|
||||
//! and a signature of 0. A filter for type specifies a
|
||||
//! choice of type out of a range at any level enumerated
|
||||
//! for type or kind. The choice could be for kind of
|
||||
@@ -40,7 +40,7 @@ DEFINE_STANDARD_HANDLE(AIS_TypeFilter, SelectMgr_Filter)
|
||||
//! plane or attribute.
|
||||
//! If you want to give a particular type and signature to
|
||||
//! your Interactive Object, you must redefine two virtual
|
||||
//! methods: Type and Signature.
|
||||
//! methods: Type and Signature.
|
||||
//! This filter is used in both Neutral Point and open local contexts.
|
||||
//! In the Collector viewer, you can only locate
|
||||
//! Interactive Objects which answer positively to the
|
||||
|
||||
@@ -50,7 +50,7 @@ class WNT_HIDSpaceMouse;
|
||||
//! - Mapping mouse/multi-touch input to View camera manipulations (panning/rotating/zooming).
|
||||
//! - Input events are not applied immediately but queued for separate processing from two working
|
||||
//! threads
|
||||
//! UI thread receiving user input and Rendering thread for OCCT 3D Viewer drawing.
|
||||
//! UI thread receiving user input and Rendering thread for OCCT 3D Viewer drawing.
|
||||
class AIS_ViewController : public Aspect_WindowInputListener
|
||||
{
|
||||
public:
|
||||
|
||||
@@ -66,7 +66,7 @@ public:
|
||||
const gp_Dir& dir2,
|
||||
const gp_Pnt& OffsetPoint);
|
||||
|
||||
//! Same as above, but <thevalstring> contains conversion
|
||||
//! Same as above, but <thevalstring> contains conversion
|
||||
//! in Session units....
|
||||
Standard_EXPORT static void Add(const Handle(Prs3d_Presentation)& aPresentation,
|
||||
const Handle(Prs3d_Drawer)& aDrawer,
|
||||
@@ -79,8 +79,8 @@ public:
|
||||
const gp_Dir& dir2,
|
||||
const gp_Pnt& OffsetPoint);
|
||||
|
||||
//! Same as above, may add one or
|
||||
//! two Arrows according to <ArrowSide> value
|
||||
//! Same as above, may add one or
|
||||
//! two Arrows according to <ArrowSide> value
|
||||
Standard_EXPORT static void Add(const Handle(Prs3d_Presentation)& aPresentation,
|
||||
const Handle(Prs3d_Drawer)& aDrawer,
|
||||
const Standard_Real theval,
|
||||
@@ -93,7 +93,7 @@ public:
|
||||
const gp_Pnt& OffsetPoint,
|
||||
const DsgPrs_ArrowSide ArrowSide);
|
||||
|
||||
//! Same as above, but axisdir contains the axis direction
|
||||
//! Same as above, but axisdir contains the axis direction
|
||||
//! useful for Revol that can be opened with 180 degrees
|
||||
Standard_EXPORT static void Add(const Handle(Prs3d_Presentation)& aPresentation,
|
||||
const Handle(Prs3d_Drawer)& aDrawer,
|
||||
@@ -107,8 +107,8 @@ public:
|
||||
const gp_Dir& axisdir,
|
||||
const gp_Pnt& OffsetPoint);
|
||||
|
||||
//! Same as above,may add one or
|
||||
//! two Arrows according to <ArrowSide> value
|
||||
//! Same as above,may add one or
|
||||
//! two Arrows according to <ArrowSide> value
|
||||
Standard_EXPORT static void Add(const Handle(Prs3d_Presentation)& aPresentation,
|
||||
const Handle(Prs3d_Drawer)& aDrawer,
|
||||
const Standard_Real theval,
|
||||
@@ -125,9 +125,9 @@ public:
|
||||
const DsgPrs_ArrowSide ArrowSide);
|
||||
|
||||
//! simple representation of a poor lonesome angle dimension
|
||||
//! Draw a line from <theCenter> to <AttachmentPoint1>, then operates
|
||||
//! a rotation around the perpmay add one or
|
||||
//! two Arrows according to <ArrowSide> value. The
|
||||
//! Draw a line from <theCenter> to <AttachmentPoint1>, then operates
|
||||
//! a rotation around the perpmay add one or
|
||||
//! two Arrows according to <ArrowSide> value. The
|
||||
//! attributes (color,arrowsize,...) are driven by the Drawer.
|
||||
Standard_EXPORT static void Add(const Handle(Prs3d_Presentation)& aPresentation,
|
||||
const Handle(Prs3d_Drawer)& aDrawer,
|
||||
|
||||
@@ -108,7 +108,7 @@ public:
|
||||
gp_Pnt& theLastPnt2,
|
||||
const Handle(Geom_Plane)& thePlane);
|
||||
|
||||
//! Used by dimensions only.Computes the 3d geometry
|
||||
//! Used by dimensions only.Computes the 3d geometry
|
||||
//! of<anEdge1> and <anEdge2> and checks if they are infinite.
|
||||
Standard_EXPORT static Standard_Boolean ComputeGeometry(const TopoDS_Edge& theFirstEdge,
|
||||
const TopoDS_Edge& theSecondEdge,
|
||||
@@ -121,15 +121,15 @@ public:
|
||||
Standard_Boolean& theIsinfinite1,
|
||||
Standard_Boolean& theIsinfinite2);
|
||||
|
||||
//! Used by 2d Relation only Computes the 3d geometry
|
||||
//! Used by 2d Relation only Computes the 3d geometry
|
||||
//! of<anEdge1> and <anEdge2> in the current Plane and the
|
||||
//! extremities if any. Return in ExtCurve the 3d curve
|
||||
//! (not projected in the plane) of the first edge if
|
||||
//! extremities if any. Return in ExtCurve the 3d curve
|
||||
//! (not projected in the plane) of the first edge if
|
||||
//! <indexExt> =1 or of the 2nd edge if <indexExt> = 2. If
|
||||
//! <indexExt> = 0, ExtCurve is Null. if there is an edge
|
||||
//! external to the plane, <isinfinite> is true if this
|
||||
//! edge is infinite. So, the extremities of it are not
|
||||
//! significant. Return TRUE if ok
|
||||
//! <indexExt> = 0, ExtCurve is Null. if there is an edge
|
||||
//! external to the plane, <isinfinite> is true if this
|
||||
//! edge is infinite. So, the extremities of it are not
|
||||
//! significant. Return TRUE if ok
|
||||
Standard_EXPORT static Standard_Boolean ComputeGeometry(const TopoDS_Edge& theFirstEdge,
|
||||
const TopoDS_Edge& theSecondEdge,
|
||||
Standard_Integer& theExtIndex,
|
||||
@@ -160,11 +160,11 @@ public:
|
||||
const Handle(Geom_Plane)& aPlane,
|
||||
Standard_Boolean& isOnPlane);
|
||||
|
||||
//! Tries to get Plane from Face. Returns Surface of Face
|
||||
//! in aSurf. Returns Standard_True and Plane of Face in
|
||||
//! aPlane in following cases:
|
||||
//! Tries to get Plane from Face. Returns Surface of Face
|
||||
//! in aSurf. Returns Standard_True and Plane of Face in
|
||||
//! aPlane in following cases:
|
||||
//! Face is Plane, Offset of Plane,
|
||||
//! Extrusion of Line and Offset of Extrusion of Line
|
||||
//! Extrusion of Line and Offset of Extrusion of Line
|
||||
//! Returns pure type of Surface which can be:
|
||||
//! Plane, Cylinder, Cone, Sphere, Torus,
|
||||
//! SurfaceOfRevolution, SurfaceOfExtrusion
|
||||
@@ -222,13 +222,13 @@ public:
|
||||
const gp_Dir& aDir,
|
||||
const Bnd_Box& aBndBox);
|
||||
|
||||
//! returns True if point with anAttachPar is
|
||||
//! in domain of arc
|
||||
//! returns True if point with anAttachPar is
|
||||
//! in domain of arc
|
||||
Standard_EXPORT static Standard_Boolean InDomain(const Standard_Real aFirstPar,
|
||||
const Standard_Real aLastPar,
|
||||
const Standard_Real anAttachPar);
|
||||
|
||||
//! computes nearest to ellipse arc apex
|
||||
//! computes nearest to ellipse arc apex
|
||||
Standard_EXPORT static gp_Pnt NearestApex(const gp_Elips& elips,
|
||||
const gp_Pnt& pApex,
|
||||
const gp_Pnt& nApex,
|
||||
@@ -236,7 +236,7 @@ public:
|
||||
const Standard_Real lpara,
|
||||
Standard_Boolean& IsInDomain);
|
||||
|
||||
//! computes length of ellipse arc in parametric units
|
||||
//! computes length of ellipse arc in parametric units
|
||||
Standard_EXPORT static Standard_Real DistanceFromApex(const gp_Elips& elips,
|
||||
const gp_Pnt& Apex,
|
||||
const Standard_Real par);
|
||||
|
||||
@@ -22,21 +22,21 @@
|
||||
|
||||
DEFINE_STANDARD_HANDLE(PrsDim_MaxRadiusDimension, PrsDim_EllipseRadiusDimension)
|
||||
|
||||
//! Ellipse Max radius dimension of a Shape which can be Edge
|
||||
//! or Face (planar or cylindrical(surface of extrusion or
|
||||
//! surface of offset))
|
||||
//! Ellipse Max radius dimension of a Shape which can be Edge
|
||||
//! or Face (planar or cylindrical(surface of extrusion or
|
||||
//! surface of offset))
|
||||
class PrsDim_MaxRadiusDimension : public PrsDim_EllipseRadiusDimension
|
||||
{
|
||||
DEFINE_STANDARD_RTTIEXT(PrsDim_MaxRadiusDimension, PrsDim_EllipseRadiusDimension)
|
||||
public:
|
||||
//! Max Ellipse radius dimension
|
||||
//! Shape can be edge , planar face or cylindrical face
|
||||
//! Max Ellipse radius dimension
|
||||
//! Shape can be edge, planar face or cylindrical face
|
||||
Standard_EXPORT PrsDim_MaxRadiusDimension(const TopoDS_Shape& aShape,
|
||||
const Standard_Real aVal,
|
||||
const TCollection_ExtendedString& aText);
|
||||
|
||||
//! Max Ellipse radius dimension with position
|
||||
//! Shape can be edge , planar face or cylindrical face
|
||||
//! Max Ellipse radius dimension with position
|
||||
//! Shape can be edge, planar face or cylindrical face
|
||||
Standard_EXPORT PrsDim_MaxRadiusDimension(const TopoDS_Shape& aShape,
|
||||
const Standard_Real aVal,
|
||||
const TCollection_ExtendedString& aText,
|
||||
|
||||
@@ -22,21 +22,21 @@
|
||||
|
||||
DEFINE_STANDARD_HANDLE(PrsDim_MinRadiusDimension, PrsDim_EllipseRadiusDimension)
|
||||
|
||||
//! -- Ellipse Min radius dimension of a Shape which
|
||||
//! can be Edge or Face (planar or cylindrical(surface of
|
||||
//! extrusion or surface of offset))
|
||||
//! Ellipse Min radius dimension of a Shape which
|
||||
//! can be Edge or Face (planar or cylindrical(surface of
|
||||
//! extrusion or surface of offset))
|
||||
class PrsDim_MinRadiusDimension : public PrsDim_EllipseRadiusDimension
|
||||
{
|
||||
DEFINE_STANDARD_RTTIEXT(PrsDim_MinRadiusDimension, PrsDim_EllipseRadiusDimension)
|
||||
public:
|
||||
//! Max Ellipse radius dimension
|
||||
//! Shape can be edge , planar face or cylindrical face
|
||||
//! Max Ellipse radius dimension
|
||||
//! Shape can be edge, planar face or cylindrical face
|
||||
Standard_EXPORT PrsDim_MinRadiusDimension(const TopoDS_Shape& aShape,
|
||||
const Standard_Real aVal,
|
||||
const TCollection_ExtendedString& aText);
|
||||
|
||||
//! Max Ellipse radius dimension with position
|
||||
//! Shape can be edge , planar face or cylindrical face
|
||||
//! Max Ellipse radius dimension with position
|
||||
//! Shape can be edge, planar face or cylindrical face
|
||||
Standard_EXPORT PrsDim_MinRadiusDimension(const TopoDS_Shape& aShape,
|
||||
const Standard_Real aVal,
|
||||
const TCollection_ExtendedString& aText,
|
||||
|
||||
@@ -487,7 +487,7 @@ public: //! @name simplified presentation properties API
|
||||
}
|
||||
|
||||
//! Removes color settings. Only the Interactive Object
|
||||
//! knows which Drawer attribute is affected by the color
|
||||
//! knows which Drawer attribute is affected by the color
|
||||
//! setting. For a wire, for example, wire aspect is the
|
||||
//! attribute affected. For a vertex, however, only point
|
||||
//! aspect is affected by the color setting.
|
||||
|
||||
@@ -128,7 +128,7 @@ public:
|
||||
const Handle(PrsMgr_PresentationManager)& theMgr);
|
||||
|
||||
//! Method which hilight an owner belonging to
|
||||
//! this selectable object ( for fast presentation draw )
|
||||
//! this selectable object (for fast presentation draw)
|
||||
Standard_EXPORT virtual void HilightOwnerWithColor(
|
||||
const Handle(PrsMgr_PresentationManager)& thePM,
|
||||
const Handle(Prs3d_Drawer)& theStyle,
|
||||
|
||||
@@ -24,7 +24,7 @@
|
||||
|
||||
class Select3D_SensitiveEntity;
|
||||
|
||||
//! Represents the state of a given selection mode for a
|
||||
//! Represents the state of a given selection mode for a
|
||||
//! Selectable Object. Contains all the sensitive entities available for this mode.
|
||||
//! An interactive object can have an indefinite number of
|
||||
//! modes of selection, each representing a
|
||||
@@ -58,7 +58,7 @@ class Select3D_SensitiveEntity;
|
||||
//! - mode 3 : selection of the wires
|
||||
//! - mode 4 : selection of the faces
|
||||
//! - mode 5 : selection of the shells
|
||||
//! - mode 6 : selection of the constituent solids.
|
||||
//! - mode 6 : selection of the constituent solids.
|
||||
class SelectMgr_Selection : public Standard_Transient
|
||||
{
|
||||
DEFINE_STANDARD_RTTIEXT(SelectMgr_Selection, Standard_Transient)
|
||||
|
||||
@@ -73,7 +73,7 @@ public:
|
||||
Standard_EXPORT void ClearSelectionStructures(const Handle(SelectMgr_SelectableObject)& theObj,
|
||||
const Standard_Integer theMode = -1);
|
||||
|
||||
//! Re-adds newly calculated sensitive entities of recomputed selection
|
||||
//! Re-adds newly calculated sensitive entities of recomputed selection
|
||||
//! defined by mode theMode to all viewer selectors contained that selection.
|
||||
Standard_EXPORT void RestoreSelectionStructures(const Handle(SelectMgr_SelectableObject)& theObj,
|
||||
const Standard_Integer theMode = -1);
|
||||
|
||||
@@ -21,7 +21,7 @@
|
||||
enum SelectMgr_StateOfSelection
|
||||
{
|
||||
SelectMgr_SOS_Any = -2, //!< ANY selection state (for querying selections)
|
||||
SelectMgr_SOS_Unknown = -1, //!< selection, which has never been in SelectMgr_SOS_Activated state
|
||||
SelectMgr_SOS_Unknown = -1, //!< selection, which has never been in SelectMgr_SOS_Activated state
|
||||
//!< (almost the same thing as SelectMgr_SOS_Deactivated)
|
||||
SelectMgr_SOS_Deactivated =
|
||||
0, //!< deactivated selection, once been in SelectMgr_SOS_Activated state
|
||||
|
||||
@@ -58,7 +58,7 @@ typedef NCollection_DataMap<Standard_Integer, SelectMgr_SelectingVolumeManager>
|
||||
//! as priority of the primitive or its depth in the view
|
||||
//! relative to that of other primitives.
|
||||
//! Note that in 3D, the inheriting framework
|
||||
//! StdSelect_ViewerSelector3d is only to be used
|
||||
//! StdSelect_ViewerSelector3d is only to be used
|
||||
//! if you do not want to use the services provided by
|
||||
//! AIS.
|
||||
//! Two tools are available to find and select objects
|
||||
@@ -114,7 +114,7 @@ public:
|
||||
|
||||
//! Return the flag determining precedence of picked depth (distance from eye to entity) over
|
||||
//! entity priority in sorted results; TRUE by default. When flag is TRUE, priority will be
|
||||
//! considered only if entities have the same depth within the tolerance. When flag is FALSE,
|
||||
//! considered only if entities have the same depth within the tolerance. When flag is FALSE,
|
||||
//! entities with higher priority will be in front regardless of their depth (like x-ray).
|
||||
bool ToPickClosest() const { return myToPreferClosest; }
|
||||
|
||||
|
||||
@@ -50,7 +50,7 @@ public:
|
||||
const Adaptor3d_Curve& aCurve,
|
||||
const Handle(Prs3d_Drawer)& aDrawer);
|
||||
|
||||
//! returns the pole the most near of the point (X,Y,Z) and
|
||||
//! returns the pole the most near of the point (X,Y,Z) and
|
||||
//! returns its range. The distance between the pole and
|
||||
//! (X,Y,Z) must be less then aDistance. If no pole corresponds, 0 is returned.
|
||||
Standard_EXPORT static Standard_Integer Pick(const Standard_Real X,
|
||||
|
||||
@@ -27,8 +27,8 @@ public:
|
||||
//! @return true if all faces within shape are triangulated.
|
||||
Standard_EXPORT static Standard_Boolean IsTriangulated(const TopoDS_Shape& theShape);
|
||||
|
||||
//! Checks back faces visibility for specified shape (to activate back-face culling). <br>
|
||||
//! @return true if shape is closed manifold Solid or compound of such Solids. <br>
|
||||
//! Checks back faces visibility for specified shape (to activate back-face culling).
|
||||
//! @return true if shape is closed manifold Solid or compound of such Solids.
|
||||
Standard_EXPORT static Standard_Boolean IsClosed(const TopoDS_Shape& theShape);
|
||||
|
||||
//! Computes the absolute deflection value depending on the type of deflection in theDrawer:
|
||||
|
||||
@@ -43,7 +43,7 @@ public:
|
||||
//! particular, the number of U and V isoparameters - are
|
||||
//! set in the attribute manager aDrawer.
|
||||
//! aFace is BRepAdaptor_Surface surface created
|
||||
//! from a face in a topological shape. which is passed
|
||||
//! from a face in a topological shape. which is passed
|
||||
//! as an argument through the
|
||||
//! BRepAdaptor_Surface surface created from it.
|
||||
//! This is what allows the topological face to be treated
|
||||
@@ -60,7 +60,7 @@ public:
|
||||
//! particular, the number of U isoparameters -
|
||||
//! are set in the attribute manager aDrawer.
|
||||
//! aFace is BRepAdaptor_Surface surface
|
||||
//! created from a face in a topological shape. which
|
||||
//! created from a face in a topological shape. which
|
||||
//! is passed to the function as an argument through
|
||||
//! the BRepAdaptor_Surface surface created from
|
||||
//! it. This is what allows the topological face to be
|
||||
@@ -77,7 +77,7 @@ public:
|
||||
//! particular, the number of V isoparameters -
|
||||
//! are set in the attribute manager aDrawer.
|
||||
//! aFace is BRepAdaptor_Surface surface
|
||||
//! created from a face in a topological shape. which
|
||||
//! created from a face in a topological shape. which
|
||||
//! is passed to the function as an argument through
|
||||
//! the BRepAdaptor_Surface surface created from
|
||||
//! it. This is what allows the topological face to be
|
||||
@@ -97,7 +97,7 @@ public:
|
||||
//! isoparameters, NBUiso and NBViso, in the shape. To
|
||||
//! do this, the arguments DrawUIso and DrawVIso must be true.
|
||||
//! aFace is BRepAdaptor_Surface surface created
|
||||
//! from a face in a topological shape. which is passed
|
||||
//! from a face in a topological shape. which is passed
|
||||
//! as an argument through the
|
||||
//! BRepAdaptor_Surface surface created from it.
|
||||
//! This is what allows the topological face to be treated
|
||||
|
||||
@@ -34,7 +34,7 @@ class TopoDS_Face;
|
||||
|
||||
//! Tool to create specific selections (sets of primitives)
|
||||
//! for Shapes from Topology.
|
||||
//! These Selections may be used in dynamic selection
|
||||
//! These Selections may be used in dynamic selection
|
||||
//! Mechanism
|
||||
//! Given a Shape and a mode of selection
|
||||
//! (selection of vertices,
|
||||
@@ -87,8 +87,8 @@ public:
|
||||
const Standard_Integer NbPOnEdge = 9,
|
||||
const Standard_Real MaximalParameter = 500);
|
||||
|
||||
//! Same functionalities ; the only
|
||||
//! difference is that the selectable object from which the
|
||||
//! Same functionalities. The only
|
||||
//! difference is that the selectable object from which the
|
||||
//! selection comes is stored in each Sensitive EntityOwner;
|
||||
//! decomposition of <aShape> into sensitive entities following
|
||||
//! a mode of decomposition <aType>. These entities are stored in <aSelection>
|
||||
|
||||
@@ -564,9 +564,9 @@ public:
|
||||
//! Updates the view.
|
||||
Standard_EXPORT void SetScale(const Standard_Real Coef);
|
||||
|
||||
//! Sets anisotropic (axial) scale factors <Sx>, <Sy>, <Sz> for view <me>.
|
||||
//! Anisotropic scaling operation is performed through multiplying
|
||||
//! the current view orientation matrix by a scaling matrix:
|
||||
//! Sets anisotropic (axial) scale factors <Sx>, <Sy>, <Sz> for view <me>.
|
||||
//! Anisotropic scaling operation is performed through multiplying
|
||||
//! the current view orientation matrix by a scaling matrix:
|
||||
//! || Sx 0 0 0 ||
|
||||
//! || 0 Sy 0 0 ||
|
||||
//! || 0 0 Sz 0 ||
|
||||
@@ -882,10 +882,10 @@ public:
|
||||
const Standard_Integer theMouseEndX,
|
||||
const Standard_Integer theMouseEndY);
|
||||
|
||||
//! Performs anisotropic scaling of <me> view along the given <Axis>.
|
||||
//! The scale factor is calculated on a basis of
|
||||
//! Performs anisotropic scaling of <me> view along the given <Axis>.
|
||||
//! The scale factor is calculated on a basis of
|
||||
//! the mouse pointer displacement <Dx,Dy>.
|
||||
//! The calculated scale factor is then passed to SetAxialScale(Sx, Sy, Sz) method.
|
||||
//! The calculated scale factor is then passed to SetAxialScale(Sx, Sy, Sz) method.
|
||||
Standard_EXPORT void AxialScale(const Standard_Integer Dx,
|
||||
const Standard_Integer Dy,
|
||||
const V3d_TypeOfAxe Axis);
|
||||
|
||||
Reference in New Issue
Block a user