1
0
mirror of https://git.dev.opencascade.org/repos/occt.git synced 2025-04-04 18:06:22 +03:00

Documentation - Update parameter annotations for consistency

Reorganized style for param to the next templates:
 - "@param theParameter description ..."
 - "@param[in] theParameter description ..."
 - "@param[out] theParameter description ..."
 - "@param[in][out] theParameter description ..."
 The replacement was with keeping spacing, no removing of extra spaces.
In some files '/' was used instead of '@', that was not updated yet.
This commit is contained in:
dpasukhi 2024-11-17 20:22:51 +00:00
parent ac5a612645
commit 604c3b890c
213 changed files with 2258 additions and 2258 deletions
src
AIS
Adaptor3d
Aspect
BOPAlgo
BOPTools
BRep
BRepAlgoAPI
BRepBuilderAPI
BRepGProp
BRepLib
BRepMesh
BRepPrimAPI
BRepTools
BinTools
DBRep
DE
DEBRepCascade
DEXCAFCascade
Draw
DsgPrs
Font
GCPnts
GeomLib
Graphic3d
IGESCAFControl
IVtk
IVtkOCC
IVtkTools
IVtkVTK
Image
IntTools
Media
MeshVS
Message
NCollection
OSD

@ -172,7 +172,7 @@ public:
bool IsStopped() { return myState != AnimationState_Started; } bool IsStopped() { return myState != AnimationState_Started; }
//! Update single frame of animation, update timer state //! Update single frame of animation, update timer state
//! @param thePts [in] the time moment within [0; Duration()] //! @param[in] thePts the time moment within [0; Duration()]
//! @return True if timeline is in progress //! @return True if timeline is in progress
Standard_EXPORT virtual Standard_Boolean Update (const Standard_Real thePts); Standard_EXPORT virtual Standard_Boolean Update (const Standard_Real thePts);

@ -373,11 +373,11 @@ public:
public: public:
//! Returns the width of text. //! Returns the width of text.
//! @param theText [in] the text of which to calculate width. //! @param[in] theText the text of which to calculate width.
Standard_EXPORT Standard_Integer TextWidth (const TCollection_ExtendedString& theText) const; Standard_EXPORT Standard_Integer TextWidth (const TCollection_ExtendedString& theText) const;
//! Returns the height of text. //! Returns the height of text.
//! @param theText [in] the text of which to calculate height. //! @param[in] theText the text of which to calculate height.
Standard_EXPORT Standard_Integer TextHeight (const TCollection_ExtendedString& theText) const; Standard_EXPORT Standard_Integer TextHeight (const TCollection_ExtendedString& theText) const;
Standard_EXPORT void TextSize (const TCollection_ExtendedString& theText, Standard_EXPORT void TextSize (const TCollection_ExtendedString& theText,
@ -403,17 +403,17 @@ public:
private: private:
//! Returns the size of color scale. //! Returns the size of color scale.
//! @param theWidth [out] the width of color scale. //! @param[out] theWidth the width of color scale.
//! @param theHeight [out] the height of color scale. //! @param[out] theHeight the height of color scale.
void SizeHint (Standard_Integer& theWidth, Standard_Integer& theHeight) const; void SizeHint (Standard_Integer& theWidth, Standard_Integer& theHeight) const;
//! Returns the upper value of given interval, or minimum for theIndex = 0. //! Returns the upper value of given interval, or minimum for theIndex = 0.
Standard_Real GetIntervalValue (const Standard_Integer theIndex) const; Standard_Real GetIntervalValue (const Standard_Integer theIndex) const;
//! Returns the color for the given value in the given interval. //! Returns the color for the given value in the given interval.
//! @param theValue [in] the current value of interval //! @param[in] theValue the current value of interval
//! @param theMin [in] the min value of interval //! @param[in] theMin the min value of interval
//! @param theMax [in] the max value of interval //! @param[in] theMax the max value of interval
Quantity_Color colorFromValue (const Standard_Real theValue, Quantity_Color colorFromValue (const Standard_Real theValue,
const Standard_Real theMin, const Standard_Real theMin,
const Standard_Real theMax) const; const Standard_Real theMax) const;
@ -422,11 +422,11 @@ private:
void updateTextAspect(); void updateTextAspect();
//! Simple alias for Prs3d_Text::Draw(). //! Simple alias for Prs3d_Text::Draw().
//! @param theGroup [in] presentation group //! @param[in] theGroup presentation group
//! @param theText [in] text to draw //! @param[in] theText text to draw
//! @param theX [in] X coordinate of text position //! @param[in] theX X coordinate of text position
//! @param theY [in] Y coordinate of text position //! @param[in] theY Y coordinate of text position
//! @param theVertAlignment [in] text vertical alignment //! @param[in] theVertAlignment text vertical alignment
void drawText (const Handle(Graphic3d_Group)& theGroup, void drawText (const Handle(Graphic3d_Group)& theGroup,
const TCollection_ExtendedString& theText, const TCollection_ExtendedString& theText,
const Standard_Integer theX, const Standard_Integer theY, const Standard_Integer theX, const Standard_Integer theY,
@ -451,11 +451,11 @@ private:
const Standard_Integer theColorBreadth); const Standard_Integer theColorBreadth);
//! Draw a frame. //! Draw a frame.
//! @param theX [in] the X coordinate of frame position. //! @param[in] theX the X coordinate of frame position.
//! @param theY [in] the Y coordinate of frame position. //! @param[in] theY the Y coordinate of frame position.
//! @param theWidth [in] the width of frame. //! @param[in] theWidth the width of frame.
//! @param theHeight [in] the height of frame. //! @param[in] theHeight the height of frame.
//! @param theColor [in] the color of frame. //! @param[in] theColor the color of frame.
void drawFrame (const Handle(Prs3d_Presentation)& thePrs, void drawFrame (const Handle(Prs3d_Presentation)& thePrs,
const Standard_Integer theX, const Standard_Integer theY, const Standard_Integer theX, const Standard_Integer theY,
const Standard_Integer theWidth, const Standard_Integer theHeight, const Standard_Integer theWidth, const Standard_Integer theHeight,

@ -247,21 +247,21 @@ public: //! @name highlighting management
void SetSelectionStyle (const Handle(Prs3d_Drawer)& theStyle) { myStyles[Prs3d_TypeOfHighlight_Selected] = theStyle; } void SetSelectionStyle (const Handle(Prs3d_Drawer)& theStyle) { myStyles[Prs3d_TypeOfHighlight_Selected] = theStyle; }
//! Returns highlight style of the object if it is marked as highlighted via global status //! Returns highlight style of the object if it is marked as highlighted via global status
//! @param theObj [in] the object to check //! @param[in] theObj the object to check
Standard_EXPORT Standard_Boolean HighlightStyle (const Handle(AIS_InteractiveObject)& theObj, Standard_EXPORT Standard_Boolean HighlightStyle (const Handle(AIS_InteractiveObject)& theObj,
Handle(Prs3d_Drawer)& theStyle) const; Handle(Prs3d_Drawer)& theStyle) const;
//! Returns highlight style of the owner if it is selected //! Returns highlight style of the owner if it is selected
//! @param theOwner [in] the owner to check //! @param[in] theOwner the owner to check
Standard_EXPORT Standard_Boolean HighlightStyle (const Handle(SelectMgr_EntityOwner)& theOwner, Standard_EXPORT Standard_Boolean HighlightStyle (const Handle(SelectMgr_EntityOwner)& theOwner,
Handle(Prs3d_Drawer)& theStyle) const; Handle(Prs3d_Drawer)& theStyle) const;
//! Returns true if the object is marked as highlighted via its global status //! Returns true if the object is marked as highlighted via its global status
//! @param theObj [in] the object to check //! @param[in] theObj the object to check
Standard_EXPORT Standard_Boolean IsHilighted (const Handle(AIS_InteractiveObject)& theObj) const; Standard_EXPORT Standard_Boolean IsHilighted (const Handle(AIS_InteractiveObject)& theObj) const;
//! Returns true if the owner is marked as selected //! Returns true if the owner is marked as selected
//! @param theOwner [in] the owner to check //! @param[in] theOwner the owner to check
Standard_EXPORT Standard_Boolean IsHilighted (const Handle(SelectMgr_EntityOwner)& theOwner) const; Standard_EXPORT Standard_Boolean IsHilighted (const Handle(SelectMgr_EntityOwner)& theOwner) const;
//! Changes the color of all the lines of the object in view. //! Changes the color of all the lines of the object in view.
@ -461,10 +461,10 @@ public: //! @name Selection management
//! Selects objects within the bounding rectangle. //! Selects objects within the bounding rectangle.
//! Viewer should be explicitly redrawn after selection. //! Viewer should be explicitly redrawn after selection.
//! @param thePntMin [in] rectangle lower point (in pixels) //! @param[in] thePntMin rectangle lower point (in pixels)
//! @param thePntMax [in] rectangle upper point (in pixels) //! @param[in] thePntMax rectangle upper point (in pixels)
//! @param theView [in] active view where rectangle is defined //! @param[in] theView active view where rectangle is defined
//! @param theSelScheme [in] selection scheme //! @param[in] theSelScheme selection scheme
//! @return picking status //! @return picking status
//! @sa StdSelect_ViewerSelector3d::AllowOverlapDetection() //! @sa StdSelect_ViewerSelector3d::AllowOverlapDetection()
Standard_EXPORT AIS_StatusOfPick SelectRectangle (const Graphic3d_Vec2i& thePntMin, Standard_EXPORT AIS_StatusOfPick SelectRectangle (const Graphic3d_Vec2i& thePntMin,
@ -474,9 +474,9 @@ public: //! @name Selection management
//! Select everything found in the polygon defined by bounding polyline. //! Select everything found in the polygon defined by bounding polyline.
//! Viewer should be explicitly redrawn after selection. //! Viewer should be explicitly redrawn after selection.
//! @param thePolyline [in] polyline defining polygon bounds (in pixels) //! @param[in] thePolyline polyline defining polygon bounds (in pixels)
//! @param theView [in] active view where polyline is defined //! @param[in] theView active view where polyline is defined
//! @param theSelScheme [in] selection scheme //! @param[in] theSelScheme selection scheme
//! @return picking status //! @return picking status
Standard_EXPORT AIS_StatusOfPick SelectPolygon (const TColgp_Array1OfPnt2d& thePolyline, Standard_EXPORT AIS_StatusOfPick SelectPolygon (const TColgp_Array1OfPnt2d& thePolyline,
const Handle(V3d_View)& theView, const Handle(V3d_View)& theView,
@ -484,9 +484,9 @@ public: //! @name Selection management
//! Selects the topmost object picked by the point in the view, //! Selects the topmost object picked by the point in the view,
//! Viewer should be explicitly redrawn after selection. //! Viewer should be explicitly redrawn after selection.
//! @param thePnt [in] point pixel coordinates within the view //! @param[in] thePnt point pixel coordinates within the view
//! @param theView [in] active view where point is defined //! @param[in] theView active view where point is defined
//! @param theSelScheme [in] selection scheme //! @param[in] theSelScheme selection scheme
//! @return picking status //! @return picking status
Standard_EXPORT AIS_StatusOfPick SelectPoint (const Graphic3d_Vec2i& thePnt, Standard_EXPORT AIS_StatusOfPick SelectPoint (const Graphic3d_Vec2i& thePnt,
const Handle(V3d_View)& theView, const Handle(V3d_View)& theView,
@ -495,7 +495,7 @@ public: //! @name Selection management
//! Select and hilights the previous detected via AIS_InteractiveContext::MoveTo() method; //! Select and hilights the previous detected via AIS_InteractiveContext::MoveTo() method;
//! unhilights the previous picked. //! unhilights the previous picked.
//! Viewer should be explicitly redrawn after selection. //! Viewer should be explicitly redrawn after selection.
//! @param theSelScheme [in] selection scheme //! @param[in] theSelScheme selection scheme
//! @return picking status //! @return picking status
//! //!
//! @sa HighlightStyle() defining default highlight styles of selected owners (Prs3d_TypeOfHighlight_Selected and Prs3d_TypeOfHighlight_LocalSelected) //! @sa HighlightStyle() defining default highlight styles of selected owners (Prs3d_TypeOfHighlight_Selected and Prs3d_TypeOfHighlight_LocalSelected)
@ -1318,8 +1318,8 @@ protected: //! @name internal methods
Standard_EXPORT void highlightSelected (const Handle(SelectMgr_EntityOwner)& theOwner); Standard_EXPORT void highlightSelected (const Handle(SelectMgr_EntityOwner)& theOwner);
//! Helper function that highlights the owners with check for AutoHighlight, e.g. is used for selection. //! Helper function that highlights the owners with check for AutoHighlight, e.g. is used for selection.
//! @param theOwners [in] list of owners to highlight //! @param[in] theOwners list of owners to highlight
//! @param theStyle [in] highlight style to apply or NULL to apply selection style //! @param[in] theStyle highlight style to apply or NULL to apply selection style
Standard_EXPORT void highlightOwners (const AIS_NListOfEntityOwner& theOwners, Standard_EXPORT void highlightOwners (const AIS_NListOfEntityOwner& theOwners,
const Handle(Prs3d_Drawer)& theStyle); const Handle(Prs3d_Drawer)& theStyle);
@ -1347,32 +1347,32 @@ protected: //! @name internal methods
//! Helper function that turns on sub-intensity in global status and highlights //! Helper function that turns on sub-intensity in global status and highlights
//! given objects with sub-intensity color //! given objects with sub-intensity color
//! @param theObject [in] the object. If NULL is given, than sub-intensity will be turned on for //! @param[in] theObject the object. If NULL is given, than sub-intensity will be turned on for
//! all inveractive objects of the context //! all inveractive objects of the context
//! @param theDispMode [in] display mode. If -1 is given, sub-intensity will be turned on for //! @param[in] theDispMode display mode. If -1 is given, sub-intensity will be turned on for
//! all display modes in global status's list of modes //! all display modes in global status's list of modes
//! @param theIsDisplayedOnly [in] is true if sub-intensity should be applied only to objects with //! @param[in] theIsDisplayedOnly is true if sub-intensity should be applied only to objects with
//! status AIS_DS_Displayed //! status AIS_DS_Displayed
Standard_EXPORT void turnOnSubintensity (const Handle(AIS_InteractiveObject)& theObject = NULL, Standard_EXPORT void turnOnSubintensity (const Handle(AIS_InteractiveObject)& theObject = NULL,
const Standard_Integer theDispMode = -1, const Standard_Integer theDispMode = -1,
const Standard_Boolean theIsDisplayedOnly = Standard_True) const; const Standard_Boolean theIsDisplayedOnly = Standard_True) const;
//! Helper function that highlights the object with sub-intensity color without any checks //! Helper function that highlights the object with sub-intensity color without any checks
//! @param theObject [in] the object that will be highlighted //! @param[in] theObject the object that will be highlighted
//! @param theMode [in] display mode //! @param[in] theMode display mode
Standard_EXPORT void highlightWithSubintensity (const Handle(AIS_InteractiveObject)& theObject, Standard_EXPORT void highlightWithSubintensity (const Handle(AIS_InteractiveObject)& theObject,
const Standard_Integer theMode) const; const Standard_Integer theMode) const;
//! Helper function that highlights the owner with sub-intensity color without any checks //! Helper function that highlights the owner with sub-intensity color without any checks
//! @param theOwner [in] the owner that will be highlighted //! @param[in] theOwner the owner that will be highlighted
//! @param theMode [in] display mode //! @param[in] theMode display mode
Standard_EXPORT void highlightWithSubintensity (const Handle(SelectMgr_EntityOwner)& theOwner, Standard_EXPORT void highlightWithSubintensity (const Handle(SelectMgr_EntityOwner)& theOwner,
const Standard_Integer theMode) const; const Standard_Integer theMode) const;
//! Helper function that returns correct dynamic highlight style for the object: //! Helper function that returns correct dynamic highlight style for the object:
//! if custom style is defined via object's highlight drawer, it will be used. Otherwise, //! if custom style is defined via object's highlight drawer, it will be used. Otherwise,
//! dynamic highlight style of interactive context will be returned. //! dynamic highlight style of interactive context will be returned.
//! @param theObj [in] the object to check //! @param[in] theObj the object to check
const Handle(Prs3d_Drawer)& getHiStyle (const Handle(AIS_InteractiveObject)& theObj, const Handle(Prs3d_Drawer)& getHiStyle (const Handle(AIS_InteractiveObject)& theObj,
const Handle(SelectMgr_EntityOwner)& theOwner) const const Handle(SelectMgr_EntityOwner)& theOwner) const
{ {
@ -1392,7 +1392,7 @@ protected: //! @name internal methods
//! Helper function that returns correct selection style for the object: //! Helper function that returns correct selection style for the object:
//! if custom style is defined via object's highlight drawer, it will be used. Otherwise, //! if custom style is defined via object's highlight drawer, it will be used. Otherwise,
//! selection style of interactive context will be returned. //! selection style of interactive context will be returned.
//! @param theObj [in] the object to check //! @param[in] theObj the object to check
const Handle(Prs3d_Drawer)& getSelStyle (const Handle(AIS_InteractiveObject)& theObj, const Handle(Prs3d_Drawer)& getSelStyle (const Handle(AIS_InteractiveObject)& theObj,
const Handle(SelectMgr_EntityOwner)& theOwner) const const Handle(SelectMgr_EntityOwner)& theOwner) const
{ {

@ -104,12 +104,12 @@ public:
void ClearOwner() { myOwner.Nullify(); } void ClearOwner() { myOwner.Nullify(); }
//! Drag object in the viewer. //! Drag object in the viewer.
//! @param theCtx [in] interactive context //! @param[in] theCtx interactive context
//! @param theView [in] active View //! @param[in] theView active View
//! @param theOwner [in] the owner of detected entity //! @param[in] theOwner the owner of detected entity
//! @param theDragFrom [in] drag start point //! @param[in] theDragFrom drag start point
//! @param theDragTo [in] drag end point //! @param[in] theDragTo drag end point
//! @param theAction [in] drag action //! @param[in] theAction drag action
//! @return FALSE if object rejects dragging action (e.g. AIS_DragAction_Start) //! @return FALSE if object rejects dragging action (e.g. AIS_DragAction_Start)
Standard_EXPORT virtual Standard_Boolean ProcessDragging (const Handle(AIS_InteractiveContext)& theCtx, Standard_EXPORT virtual Standard_Boolean ProcessDragging (const Handle(AIS_InteractiveContext)& theCtx,
const Handle(V3d_View)& theView, const Handle(V3d_View)& theView,

@ -148,11 +148,11 @@ public: //! @name Light properties
} }
//! Returns light source icon. //! Returns light source icon.
//! @param theIsEnabled [in] marker index for enabled/disabled light source states //! @param[in] theIsEnabled marker index for enabled/disabled light source states
const Handle(Graphic3d_MarkerImage)& MarkerImage (bool theIsEnabled) const { return myMarkerImages[theIsEnabled ? 1 : 0]; } const Handle(Graphic3d_MarkerImage)& MarkerImage (bool theIsEnabled) const { return myMarkerImages[theIsEnabled ? 1 : 0]; }
//! Returns light source icon. //! Returns light source icon.
//! @param theIsEnabled [in] marker index for enabled/disabled light source states //! @param[in] theIsEnabled marker index for enabled/disabled light source states
Aspect_TypeOfMarker MarkerType (bool theIsEnabled) const { return myMarkerTypes[theIsEnabled ? 1 : 0]; } Aspect_TypeOfMarker MarkerType (bool theIsEnabled) const { return myMarkerTypes[theIsEnabled ? 1 : 0]; }
//! Sets custom icon to light source. //! Sets custom icon to light source.

@ -157,12 +157,12 @@ public:
public: public:
//! Drag object in the viewer. //! Drag object in the viewer.
//! @param theCtx [in] interactive context //! @param[in] theCtx interactive context
//! @param theView [in] active View //! @param[in] theView active View
//! @param theOwner [in] the owner of detected entity //! @param[in] theOwner the owner of detected entity
//! @param theDragFrom [in] drag start point //! @param[in] theDragFrom drag start point
//! @param theDragTo [in] drag end point //! @param[in] theDragTo drag end point
//! @param theAction [in] drag action //! @param[in] theAction drag action
//! @return FALSE if object rejects dragging action (e.g. AIS_DragAction_Start) //! @return FALSE if object rejects dragging action (e.g. AIS_DragAction_Start)
Standard_EXPORT virtual Standard_Boolean ProcessDragging (const Handle(AIS_InteractiveContext)& theCtx, Standard_EXPORT virtual Standard_Boolean ProcessDragging (const Handle(AIS_InteractiveContext)& theCtx,
const Handle(V3d_View)& theView, const Handle(V3d_View)& theView,
@ -187,7 +187,7 @@ public:
Standard_EXPORT void Transform (const gp_Trsf& aTrsf); Standard_EXPORT void Transform (const gp_Trsf& aTrsf);
//! Reset start (reference) transformation. //! Reset start (reference) transformation.
//! @param theToApply [in] option to apply or to cancel the started transformation. //! @param[in] theToApply option to apply or to cancel the started transformation.
//! @warning It is used in chain with StartTransform-Transform(gp_Trsf)-StopTransform //! @warning It is used in chain with StartTransform-Transform(gp_Trsf)-StopTransform
//! and is used only for custom transform set. //! and is used only for custom transform set.
Standard_EXPORT void StopTransform (const Standard_Boolean theToApply = Standard_True); Standard_EXPORT void StopTransform (const Standard_Boolean theToApply = Standard_True);
@ -319,7 +319,7 @@ public: //! @name Presentation computation
const Standard_Integer theMode = 0) Standard_OVERRIDE; const Standard_Integer theMode = 0) Standard_OVERRIDE;
//! Computes selection sensitive zones (triangulation) for manipulator. //! Computes selection sensitive zones (triangulation) for manipulator.
//! @param theNode [in] Selection mode that is treated as transformation mode. //! @param[in] theNode Selection mode that is treated as transformation mode.
Standard_EXPORT virtual void ComputeSelection (const Handle(SelectMgr_Selection)& theSelection, Standard_EXPORT virtual void ComputeSelection (const Handle(SelectMgr_Selection)& theSelection,
const Standard_Integer theMode) Standard_OVERRIDE; const Standard_Integer theMode) Standard_OVERRIDE;

@ -65,16 +65,16 @@ public:
//! Sets the points from array of points. //! Sets the points from array of points.
//! Method will not copy the input data - array will be stored as handle. //! Method will not copy the input data - array will be stored as handle.
//! @param thePoints [in] the array of points //! @param[in] thePoints the array of points
Standard_EXPORT virtual void SetPoints (const Handle(Graphic3d_ArrayOfPoints)& thePoints); Standard_EXPORT virtual void SetPoints (const Handle(Graphic3d_ArrayOfPoints)& thePoints);
//! Sets the points with optional colors. //! Sets the points with optional colors.
//! The input data will be copied into internal buffer. //! The input data will be copied into internal buffer.
//! The input arrays should have equal length, otherwise //! The input arrays should have equal length, otherwise
//! the presentation will not be computed and displayed. //! the presentation will not be computed and displayed.
//! @param theCoords [in] the array of coordinates //! @param[in] theCoords the array of coordinates
//! @param theColors [in] optional array of colors //! @param[in] theColors optional array of colors
//! @param theNormals [in] optional array of normals //! @param[in] theNormals optional array of normals
Standard_EXPORT virtual void SetPoints (const Handle(TColgp_HArray1OfPnt)& theCoords, Standard_EXPORT virtual void SetPoints (const Handle(TColgp_HArray1OfPnt)& theCoords,
const Handle(Quantity_HArray1OfColor)& theColors = NULL, const Handle(Quantity_HArray1OfColor)& theColors = NULL,
const Handle(TColgp_HArray1OfDir)& theNormals = NULL); const Handle(TColgp_HArray1OfDir)& theNormals = NULL);

@ -41,9 +41,9 @@ public:
Standard_EXPORT AIS_RubberBand(); Standard_EXPORT AIS_RubberBand();
//! Constructs the rubber band with empty filling and defined line style. //! Constructs the rubber band with empty filling and defined line style.
//! @param theLineColor [in] color of rubber band lines //! @param[in] theLineColor color of rubber band lines
//! @param theType [in] type of rubber band lines //! @param[in] theType type of rubber band lines
//! @param theLineWidth [in] width of rubber band line. By default it is 1. //! @param[in] theLineWidth width of rubber band line. By default it is 1.
//! @warning It binds this object with Graphic3d_ZLayerId_TopOSD layer. //! @warning It binds this object with Graphic3d_ZLayerId_TopOSD layer.
Standard_EXPORT AIS_RubberBand (const Quantity_Color& theLineColor, Standard_EXPORT AIS_RubberBand (const Quantity_Color& theLineColor,
const Aspect_TypeOfLine theType, const Aspect_TypeOfLine theType,
@ -51,11 +51,11 @@ public:
const Standard_Boolean theIsPolygonClosed = Standard_True); const Standard_Boolean theIsPolygonClosed = Standard_True);
//! Constructs the rubber band with defined filling and line parameters. //! Constructs the rubber band with defined filling and line parameters.
//! @param theLineColor [in] color of rubber band lines //! @param[in] theLineColor color of rubber band lines
//! @param theType [in] type of rubber band lines //! @param[in] theType type of rubber band lines
//! @param theFillColor [in] color of rubber band filling //! @param[in] theFillColor color of rubber band filling
//! @param theTransparency [in] transparency of the filling. 0 is for opaque filling. By default it is transparent. //! @param[in] theTransparency transparency of the filling. 0 is for opaque filling. By default it is transparent.
//! @param theLineWidth [in] width of rubber band line. By default it is 1. //! @param[in] theLineWidth width of rubber band line. By default it is 1.
//! @warning It binds this object with Graphic3d_ZLayerId_TopOSD layer. //! @warning It binds this object with Graphic3d_ZLayerId_TopOSD layer.
Standard_EXPORT AIS_RubberBand (const Quantity_Color& theLineColor, Standard_EXPORT AIS_RubberBand (const Quantity_Color& theLineColor,
const Aspect_TypeOfLine theType, const Aspect_TypeOfLine theType,
@ -109,7 +109,7 @@ public:
Standard_EXPORT Aspect_TypeOfLine LineType() const; Standard_EXPORT Aspect_TypeOfLine LineType() const;
//! Sets fill transparency. //! Sets fill transparency.
//! @param theValue [in] the transparency value. 1.0 is for transparent background //! @param[in] theValue the transparency value. 1.0 is for transparent background
Standard_EXPORT void SetFillTransparency (const Standard_Real theValue) const; Standard_EXPORT void SetFillTransparency (const Standard_Real theValue) const;
//! @return fill transparency. //! @return fill transparency.
@ -119,8 +119,8 @@ public:
Standard_EXPORT void SetFilling (const Standard_Boolean theIsFilling); Standard_EXPORT void SetFilling (const Standard_Boolean theIsFilling);
//! Enable filling of rubber band with defined parameters. //! Enable filling of rubber band with defined parameters.
//! @param theColor [in] color of filling //! @param[in] theColor color of filling
//! @param theTransparency [in] transparency of the filling. 0 is for opaque filling. //! @param[in] theTransparency transparency of the filling. 0 is for opaque filling.
Standard_EXPORT void SetFilling (const Quantity_Color theColor, const Standard_Real theTransparency); Standard_EXPORT void SetFilling (const Quantity_Color theColor, const Standard_Real theTransparency);
//! @return true if filling of rubber band is enabled. //! @return true if filling of rubber band is enabled.

@ -105,8 +105,8 @@ public:
protected: protected:
//! Append the owner into the current selection if filter is Ok. //! Append the owner into the current selection if filter is Ok.
//! @param theOwner [in] element to change selection state //! @param[in] theOwner element to change selection state
//! @param theFilter [in] context filter to skip not acceptable owners //! @param[in] theFilter context filter to skip not acceptable owners
//! @return result of selection //! @return result of selection
Standard_EXPORT virtual AIS_SelectStatus appendOwner (const Handle(SelectMgr_EntityOwner)& theOwner, Standard_EXPORT virtual AIS_SelectStatus appendOwner (const Handle(SelectMgr_EntityOwner)& theOwner,
const Handle(SelectMgr_Filter)& theFilter); const Handle(SelectMgr_Filter)& theFilter);

@ -500,11 +500,11 @@ public:
//! Pick closest point under mouse cursor. //! Pick closest point under mouse cursor.
//! This method is expected to be called from rendering thread. //! This method is expected to be called from rendering thread.
//! @param thePnt [out] result point //! @param[out] thePnt result point
//! @param theCtx [in] interactive context //! @param[in] theCtx interactive context
//! @param theView [in] active view //! @param[in] theView active view
//! @param theCursor [in] mouse cursor //! @param[in] theCursor mouse cursor
//! @param theToStickToPickRay [in] when TRUE, the result point will lie on picking ray //! @param[in] theToStickToPickRay when TRUE, the result point will lie on picking ray
//! @return TRUE if result has been found //! @return TRUE if result has been found
Standard_EXPORT virtual bool PickPoint (gp_Pnt& thePnt, Standard_EXPORT virtual bool PickPoint (gp_Pnt& thePnt,
const Handle(AIS_InteractiveContext)& theCtx, const Handle(AIS_InteractiveContext)& theCtx,
@ -514,10 +514,10 @@ public:
//! Pick closest point by axis. //! Pick closest point by axis.
//! This method is expected to be called from rendering thread. //! This method is expected to be called from rendering thread.
//! @param theTopPnt [out] result point //! @param[out] theTopPnt result point
//! @param theCtx [in] interactive context //! @param[in] theCtx interactive context
//! @param theView [in] active view //! @param[in] theView active view
//! @param theAxis [in] selection axis //! @param[in] theAxis selection axis
//! @return TRUE if result has been found //! @return TRUE if result has been found
Standard_EXPORT virtual bool PickAxis (gp_Pnt& theTopPnt, Standard_EXPORT virtual bool PickAxis (gp_Pnt& theTopPnt,
const Handle(AIS_InteractiveContext)& theCtx, const Handle(AIS_InteractiveContext)& theCtx,
@ -668,8 +668,8 @@ protected:
//! Return current and previously fetched event times. //! Return current and previously fetched event times.
//! This callback is intended to compute delta between sequentially processed events. //! This callback is intended to compute delta between sequentially processed events.
//! @param thePrevTime [out] events time fetched previous time by this method //! @param[out] thePrevTime events time fetched previous time by this method
//! @param theCurrTime [out] actual events time //! @param[out] theCurrTime actual events time
void updateEventsTime (double& thePrevTime, void updateEventsTime (double& thePrevTime,
double& theCurrTime) double& theCurrTime)
{ {

@ -290,7 +290,7 @@ public: //! @name Style management API
const Quantity_Color& BoxColor() const { return myDrawer->ShadingAspect()->Color(); } const Quantity_Color& BoxColor() const { return myDrawer->ShadingAspect()->Color(); }
//! Set new value of front color for the 3D part of object. //! Set new value of front color for the 3D part of object.
//! @param theColor [in] input color value. //! @param[in] theColor input color value.
void SetBoxColor (const Quantity_Color& theColor) void SetBoxColor (const Quantity_Color& theColor)
{ {
if (!myDrawer->ShadingAspect()->Color().IsEqual (theColor) if (!myDrawer->ShadingAspect()->Color().IsEqual (theColor)
@ -308,7 +308,7 @@ public: //! @name Style management API
Standard_Real BoxTransparency() const { return myDrawer->ShadingAspect()->Transparency(); } Standard_Real BoxTransparency() const { return myDrawer->ShadingAspect()->Transparency(); }
//! Set new value of transparency for 3D part of object. //! Set new value of transparency for 3D part of object.
//! @param theValue [in] input transparency value //! @param[in] theValue input transparency value
void SetBoxTransparency (Standard_Real theValue) void SetBoxTransparency (Standard_Real theValue)
{ {
if (Abs (myDrawer->ShadingAspect()->Transparency() - theValue) > Precision::Confusion() if (Abs (myDrawer->ShadingAspect()->Transparency() - theValue) > Precision::Confusion()
@ -412,7 +412,7 @@ public: //! @name Style management API
public: public:
//! Set new value of color for the whole object. //! Set new value of color for the whole object.
//! @param theColor [in] input color value. //! @param[in] theColor input color value.
virtual void SetColor (const Quantity_Color& theColor) Standard_OVERRIDE virtual void SetColor (const Quantity_Color& theColor) Standard_OVERRIDE
{ {
SetBoxColor (theColor); SetBoxColor (theColor);
@ -428,7 +428,7 @@ public:
} }
//! Set new value of transparency for the whole object. //! Set new value of transparency for the whole object.
//! @param theValue [in] input transparency value. //! @param[in] theValue input transparency value.
virtual void SetTransparency (const Standard_Real theValue) Standard_OVERRIDE virtual void SetTransparency (const Standard_Real theValue) Standard_OVERRIDE
{ {
SetBoxTransparency (theValue); SetBoxTransparency (theValue);
@ -469,7 +469,7 @@ public: //! @name animation methods
Standard_EXPORT Standard_Real Duration() const; Standard_EXPORT Standard_Real Duration() const;
//! Set duration of animation. //! Set duration of animation.
//! @param theValue [in] input value of duration in seconds //! @param[in] theValue input value of duration in seconds
Standard_EXPORT void SetDuration (Standard_Real theValue); Standard_EXPORT void SetDuration (Standard_Real theValue);
//! Return TRUE if new camera Up direction should be always set to default value for a new camera Direction; FALSE by default. //! Return TRUE if new camera Up direction should be always set to default value for a new camera Direction; FALSE by default.
@ -490,11 +490,11 @@ public: //! @name animation methods
Standard_EXPORT Standard_Boolean HasAnimation() const; Standard_EXPORT Standard_Boolean HasAnimation() const;
//! Start camera transformation corresponding to the input detected owner. //! Start camera transformation corresponding to the input detected owner.
//! @param theOwner [in] detected owner. //! @param[in] theOwner detected owner.
Standard_EXPORT virtual void StartAnimation (const Handle(AIS_ViewCubeOwner)& theOwner); Standard_EXPORT virtual void StartAnimation (const Handle(AIS_ViewCubeOwner)& theOwner);
//! Perform one step of current camera transformation. //! Perform one step of current camera transformation.
//! theToUpdate [in] enable/disable update of view. //! theToUpdate[in] enable/disable update of view.
//! @return TRUE if animation is not stopped. //! @return TRUE if animation is not stopped.
Standard_EXPORT virtual Standard_Boolean UpdateAnimation (const Standard_Boolean theToUpdate); Standard_EXPORT virtual Standard_Boolean UpdateAnimation (const Standard_Boolean theToUpdate);
@ -508,7 +508,7 @@ protected:
Standard_EXPORT Standard_Boolean updateAnimation(); Standard_EXPORT Standard_Boolean updateAnimation();
//! Fit selected/all into view. //! Fit selected/all into view.
//! @param theView [in] view definition to retrieve scene bounding box //! @param[in] theView view definition to retrieve scene bounding box
//! @param theCamera [in,out] camera definition //! @param theCamera [in,out] camera definition
Standard_EXPORT virtual void viewFitAll (const Handle(V3d_View)& theView, Standard_EXPORT virtual void viewFitAll (const Handle(V3d_View)& theView,
const Handle(Graphic3d_Camera)& theCamera); const Handle(Graphic3d_Camera)& theCamera);
@ -530,17 +530,17 @@ public: //! @name Presentation computation
virtual Handle(SelectMgr_EntityOwner) GlobalSelOwner() const Standard_OVERRIDE { return Handle(SelectMgr_EntityOwner)(); } virtual Handle(SelectMgr_EntityOwner) GlobalSelOwner() const Standard_OVERRIDE { return Handle(SelectMgr_EntityOwner)(); }
//! Compute 3D part of View Cube. //! Compute 3D part of View Cube.
//! @param thePrsMgr [in] presentation manager. //! @param[in] thePrsMgr presentation manager.
//! @param thePrs [in] input presentation that is to be filled with flat presentation primitives. //! @param[in] thePrs input presentation that is to be filled with flat presentation primitives.
//! @param theMode [in] display mode. //! @param[in] theMode display mode.
//! @warning this object accept only 0 display mode. //! @warning this object accept only 0 display mode.
Standard_EXPORT virtual void Compute (const Handle(PrsMgr_PresentationManager)& thePrsMgr, Standard_EXPORT virtual void Compute (const Handle(PrsMgr_PresentationManager)& thePrsMgr,
const Handle(Prs3d_Presentation)& thePrs, const Handle(Prs3d_Presentation)& thePrs,
const Standard_Integer theMode = 0) Standard_OVERRIDE; const Standard_Integer theMode = 0) Standard_OVERRIDE;
//! Redefine computing of sensitive entities for View Cube. //! Redefine computing of sensitive entities for View Cube.
//! @param theSelection [in] input selection object that is to be filled with sensitive entities. //! @param[in] theSelection input selection object that is to be filled with sensitive entities.
//! @param theMode [in] selection mode. //! @param[in] theMode selection mode.
//! @warning object accepts only 0 selection mode. //! @warning object accepts only 0 selection mode.
Standard_EXPORT virtual void ComputeSelection (const Handle(SelectMgr_Selection)& theSelection, Standard_EXPORT virtual void ComputeSelection (const Handle(SelectMgr_Selection)& theSelection,
const Standard_Integer theMode) Standard_OVERRIDE; const Standard_Integer theMode) Standard_OVERRIDE;
@ -553,9 +553,9 @@ public: //! @name Presentation computation
virtual void ClearSelected() Standard_OVERRIDE {} virtual void ClearSelected() Standard_OVERRIDE {}
//! Method which highlights input owner belonging to this selectable object. //! Method which highlights input owner belonging to this selectable object.
//! @param thePM [in] presentation manager //! @param[in] thePM presentation manager
//! @param theStyle [in] style for dynamic highlighting. //! @param[in] theStyle style for dynamic highlighting.
//! @param theOwner [in] input entity owner. //! @param[in] theOwner input entity owner.
Standard_EXPORT virtual void HilightOwnerWithColor (const Handle(PrsMgr_PresentationManager)& thePM, Standard_EXPORT virtual void HilightOwnerWithColor (const Handle(PrsMgr_PresentationManager)& thePM,
const Handle(Prs3d_Drawer)& theStyle, const Handle(Prs3d_Drawer)& theStyle,
const Handle(SelectMgr_EntityOwner)& theOwner) Standard_OVERRIDE; const Handle(SelectMgr_EntityOwner)& theOwner) Standard_OVERRIDE;
@ -586,7 +586,7 @@ protected: //! @name Auxiliary classes to fill presentation with proper primitiv
//! @param theTris [in,out] triangulation to fill, or NULL to return size //! @param theTris [in,out] triangulation to fill, or NULL to return size
//! @param theNbNodes [in,out] should be incremented by a number of nodes defining this triangulation //! @param theNbNodes [in,out] should be incremented by a number of nodes defining this triangulation
//! @param theNbTris [in,out] should be incremented by a number of triangles defining this triangulation //! @param theNbTris [in,out] should be incremented by a number of triangles defining this triangulation
//! @param theDir [in] part to define //! @param[in] theDir part to define
Standard_EXPORT virtual void createBoxPartTriangles (const Handle(Graphic3d_ArrayOfTriangles)& theTris, Standard_EXPORT virtual void createBoxPartTriangles (const Handle(Graphic3d_ArrayOfTriangles)& theTris,
Standard_Integer& theNbNodes, Standard_Integer& theNbNodes,
Standard_Integer& theNbTris, Standard_Integer& theNbTris,
@ -596,7 +596,7 @@ protected: //! @name Auxiliary classes to fill presentation with proper primitiv
//! @param theTris [in,out] triangulation to fill, or NULL to return size //! @param theTris [in,out] triangulation to fill, or NULL to return size
//! @param theNbNodes [in,out] should be incremented by a number of nodes defining this triangulation //! @param theNbNodes [in,out] should be incremented by a number of nodes defining this triangulation
//! @param theNbTris [in,out] should be incremented by a number of triangles defining this triangulation //! @param theNbTris [in,out] should be incremented by a number of triangles defining this triangulation
//! @param theDir [in] part to define //! @param[in] theDir part to define
Standard_EXPORT virtual void createBoxSideTriangles (const Handle(Graphic3d_ArrayOfTriangles)& theTris, Standard_EXPORT virtual void createBoxSideTriangles (const Handle(Graphic3d_ArrayOfTriangles)& theTris,
Standard_Integer& theNbNodes, Standard_Integer& theNbNodes,
Standard_Integer& theNbTris, Standard_Integer& theNbTris,
@ -606,7 +606,7 @@ protected: //! @name Auxiliary classes to fill presentation with proper primitiv
//! @param theTris [in,out] triangulation to fill, or NULL to return size //! @param theTris [in,out] triangulation to fill, or NULL to return size
//! @param theNbNodes [in,out] should be incremented by a number of nodes defining this triangulation //! @param theNbNodes [in,out] should be incremented by a number of nodes defining this triangulation
//! @param theNbTris [in,out] should be incremented by a number of triangles defining this triangulation //! @param theNbTris [in,out] should be incremented by a number of triangles defining this triangulation
//! @param theDir [in] part to define //! @param[in] theDir part to define
Standard_EXPORT virtual void createBoxEdgeTriangles (const Handle(Graphic3d_ArrayOfTriangles)& theTris, Standard_EXPORT virtual void createBoxEdgeTriangles (const Handle(Graphic3d_ArrayOfTriangles)& theTris,
Standard_Integer& theNbNodes, Standard_Integer& theNbNodes,
Standard_Integer& theNbTris, Standard_Integer& theNbTris,
@ -616,7 +616,7 @@ protected: //! @name Auxiliary classes to fill presentation with proper primitiv
//! @param theTris [in,out] triangulation to fill, or NULL to return size //! @param theTris [in,out] triangulation to fill, or NULL to return size
//! @param theNbNodes [in,out] should be incremented by a number of nodes defining this triangulation //! @param theNbNodes [in,out] should be incremented by a number of nodes defining this triangulation
//! @param theNbTris [in,out] should be incremented by a number of triangles defining this triangulation //! @param theNbTris [in,out] should be incremented by a number of triangles defining this triangulation
//! @param theDir [in] part to define //! @param[in] theDir part to define
Standard_EXPORT virtual void createBoxCornerTriangles (const Handle(Graphic3d_ArrayOfTriangles)& theTris, Standard_EXPORT virtual void createBoxCornerTriangles (const Handle(Graphic3d_ArrayOfTriangles)& theTris,
Standard_Integer& theNbNodes, Standard_Integer& theNbNodes,
Standard_Integer& theNbTris, Standard_Integer& theNbTris,
@ -628,9 +628,9 @@ protected:
//! @param theTris [in,out] triangulation to fill, or NULL to return size //! @param theTris [in,out] triangulation to fill, or NULL to return size
//! @param theNbNodes [in,out] should be incremented by a number of nodes defining this triangulation //! @param theNbNodes [in,out] should be incremented by a number of nodes defining this triangulation
//! @param theNbTris [in,out] should be incremented by a number of triangles defining this triangulation //! @param theNbTris [in,out] should be incremented by a number of triangles defining this triangulation
//! @param theSize [in] rectangle dimensions //! @param[in] theSize rectangle dimensions
//! @param theRadius [in] radius at corners //! @param[in] theRadius radius at corners
//! @param theTrsf [in] transformation //! @param[in] theTrsf transformation
Standard_EXPORT static void createRoundRectangleTriangles (const Handle(Graphic3d_ArrayOfTriangles)& theTris, Standard_EXPORT static void createRoundRectangleTriangles (const Handle(Graphic3d_ArrayOfTriangles)& theTris,
Standard_Integer& theNbNodes, Standard_Integer& theNbNodes,
Standard_Integer& theNbTris, Standard_Integer& theNbTris,

@ -127,18 +127,18 @@ public:
//! Compute the sample-points for the intersections algorithms by adaptive algorithm for BSpline surfaces. //! Compute the sample-points for the intersections algorithms by adaptive algorithm for BSpline surfaces.
//! For other surfaces algorithm is the same as in method ComputeSamplePoints(), //! For other surfaces algorithm is the same as in method ComputeSamplePoints(),
//! but only fill arrays of U and V sample parameters; //! but only fill arrays of U and V sample parameters;
//! @param theDefl [in] a required deflection //! @param[in] theDefl a required deflection
//! @param theNUmin [in] minimal nb points for U //! @param[in] theNUmin minimal nb points for U
//! @param theNVmin [in] minimal nb points for V //! @param[in] theNVmin minimal nb points for V
Standard_EXPORT virtual void SamplePnts (const Standard_Real theDefl, Standard_EXPORT virtual void SamplePnts (const Standard_Real theDefl,
const Standard_Integer theNUmin, const Standard_Integer theNUmin,
const Standard_Integer theNVmin); const Standard_Integer theNVmin);
//! Compute the sample-points for the intersections algorithms //! Compute the sample-points for the intersections algorithms
//! by adaptive algorithm for BSpline surfaces - is used in SamplePnts //! by adaptive algorithm for BSpline surfaces - is used in SamplePnts
//! @param theDefl [in] required deflection //! @param[in] theDefl required deflection
//! @param theNUmin [in] minimal nb points for U //! @param[in] theNUmin minimal nb points for U
//! @param theNVmin [in] minimal nb points for V //! @param[in] theNVmin minimal nb points for V
Standard_EXPORT virtual void BSplSamplePnts (const Standard_Real theDefl, Standard_EXPORT virtual void BSplSamplePnts (const Standard_Real theDefl,
const Standard_Integer theNUmin, const Standard_Integer theNUmin,
const Standard_Integer theNVmin); const Standard_Integer theNVmin);

@ -64,7 +64,7 @@ public:
Standard_EXPORT Standard_Integer Next(); Standard_EXPORT Standard_Integer Next();
//! Generates the next available identifier. //! Generates the next available identifier.
//! @param theId [out] generated identifier //! @param[out] theId generated identifier
//! @return FALSE if all identifiers are busy. //! @return FALSE if all identifiers are busy.
Standard_EXPORT Standard_Boolean Next (Standard_Integer& theId); Standard_EXPORT Standard_Boolean Next (Standard_Integer& theId);

@ -65,12 +65,12 @@ public:
Standard_EXPORT virtual void ProcessEvents() Standard_OVERRIDE; Standard_EXPORT virtual void ProcessEvents() Standard_OVERRIDE;
//! Submit texture eye to XR Composer. //! Submit texture eye to XR Composer.
//! @param theTexture [in] texture handle //! @param[in] theTexture texture handle
//! @param theGraphicsLib [in] graphics library in which texture handle is defined //! @param[in] theGraphicsLib graphics library in which texture handle is defined
//! @param theColorSpace [in] texture color space; //! @param[in] theColorSpace texture color space;
//! sRGB means no color conversion by composer; //! sRGB means no color conversion by composer;
//! Linear means to sRGB color conversion by composer //! Linear means to sRGB color conversion by composer
//! @param theEye [in] eye to display //! @param[in] theEye eye to display
//! @return FALSE on error //! @return FALSE on error
Standard_EXPORT virtual bool SubmitEye (void* theTexture, Standard_EXPORT virtual bool SubmitEye (void* theTexture,
Aspect_GraphicsLibrary theGraphicsLib, Aspect_GraphicsLibrary theGraphicsLib,

@ -84,12 +84,12 @@ public:
virtual void ProcessEvents() = 0; virtual void ProcessEvents() = 0;
//! Submit texture eye to XR Composer. //! Submit texture eye to XR Composer.
//! @param theTexture [in] texture handle //! @param[in] theTexture texture handle
//! @param theGraphicsLib [in] graphics library in which texture handle is defined //! @param[in] theGraphicsLib graphics library in which texture handle is defined
//! @param theColorSpace [in] texture color space; //! @param[in] theColorSpace texture color space;
//! sRGB means no color conversion by composer; //! sRGB means no color conversion by composer;
//! Linear means to sRGB color conversion by composer //! Linear means to sRGB color conversion by composer
//! @param theEye [in] eye to display //! @param[in] theEye eye to display
//! @return FALSE on error //! @return FALSE on error
virtual bool SubmitEye (void* theTexture, virtual bool SubmitEye (void* theTexture,
Aspect_GraphicsLibrary theGraphicsLib, Aspect_GraphicsLibrary theGraphicsLib,
@ -153,8 +153,8 @@ public:
virtual Standard_Integer NamedTrackedDevice (Aspect_XRTrackedDeviceRole theDevice) const = 0; virtual Standard_Integer NamedTrackedDevice (Aspect_XRTrackedDeviceRole theDevice) const = 0;
//! Load model for displaying device. //! Load model for displaying device.
//! @param theDevice [in] device index //! @param[in] theDevice device index
//! @param theTexture [out] texture source //! @param[out] theTexture texture source
//! @return model triangulation or NULL if not found //! @return model triangulation or NULL if not found
Handle(Graphic3d_ArrayOfTriangles) LoadRenderModel (Standard_Integer theDevice, Handle(Graphic3d_ArrayOfTriangles) LoadRenderModel (Standard_Integer theDevice,
Handle(Image_Texture)& theTexture) Handle(Image_Texture)& theTexture)
@ -163,9 +163,9 @@ public:
} }
//! Load model for displaying device. //! Load model for displaying device.
//! @param theDevice [in] device index //! @param[in] theDevice device index
//! @param theToApplyUnitFactor [in] flag to apply unit scale factor //! @param[in] theToApplyUnitFactor flag to apply unit scale factor
//! @param theTexture [out] texture source //! @param[out] theTexture texture source
//! @return model triangulation or NULL if not found //! @return model triangulation or NULL if not found
Handle(Graphic3d_ArrayOfTriangles) LoadRenderModel (Standard_Integer theDevice, Handle(Graphic3d_ArrayOfTriangles) LoadRenderModel (Standard_Integer theDevice,
Standard_Boolean theToApplyUnitFactor, Standard_Boolean theToApplyUnitFactor,
@ -175,16 +175,16 @@ public:
} }
//! Fetch data for digital input action (like button). //! Fetch data for digital input action (like button).
//! @param theAction [in] action of Aspect_XRActionType_InputDigital type //! @param[in] theAction action of Aspect_XRActionType_InputDigital type
virtual Aspect_XRDigitalActionData GetDigitalActionData (const Handle(Aspect_XRAction)& theAction) const = 0; virtual Aspect_XRDigitalActionData GetDigitalActionData (const Handle(Aspect_XRAction)& theAction) const = 0;
//! Fetch data for digital input action (like axis). //! Fetch data for digital input action (like axis).
//! @param theAction [in] action of Aspect_XRActionType_InputAnalog type //! @param[in] theAction action of Aspect_XRActionType_InputAnalog type
virtual Aspect_XRAnalogActionData GetAnalogActionData (const Handle(Aspect_XRAction)& theAction) const = 0; virtual Aspect_XRAnalogActionData GetAnalogActionData (const Handle(Aspect_XRAction)& theAction) const = 0;
//! Fetch data for pose input action (like fingertip position). //! Fetch data for pose input action (like fingertip position).
//! The returned values will match the values returned by the last call to WaitPoses(). //! The returned values will match the values returned by the last call to WaitPoses().
//! @param theAction [in] action of Aspect_XRActionType_InputPose type //! @param[in] theAction action of Aspect_XRActionType_InputPose type
virtual Aspect_XRPoseActionData GetPoseActionDataForNextFrame (const Handle(Aspect_XRAction)& theAction) const = 0; virtual Aspect_XRPoseActionData GetPoseActionDataForNextFrame (const Handle(Aspect_XRAction)& theAction) const = 0;
//! Trigger vibration. //! Trigger vibration.
@ -228,9 +228,9 @@ protected:
Standard_EXPORT Aspect_XRSession(); Standard_EXPORT Aspect_XRSession();
//! Load model for displaying device. //! Load model for displaying device.
//! @param theDevice [in] device index //! @param[in] theDevice device index
//! @param theToApplyUnitFactor [in] flag to apply unit scale factor //! @param[in] theToApplyUnitFactor flag to apply unit scale factor
//! @param theTexture [out] texture source //! @param[out] theTexture texture source
//! @return model triangulation or NULL if not found //! @return model triangulation or NULL if not found
virtual Handle(Graphic3d_ArrayOfTriangles) loadRenderModel (Standard_Integer theDevice, virtual Handle(Graphic3d_ArrayOfTriangles) loadRenderModel (Standard_Integer theDevice,
Standard_Boolean theToApplyUnitFactor, Standard_Boolean theToApplyUnitFactor,

@ -146,14 +146,14 @@ public: //! @name Constructor
public: //! @name Setters for the shapes to make connected public: //! @name Setters for the shapes to make connected
//! Sets the shape for making them connected. //! Sets the shape for making them connected.
//! @param theArgs [in] The arguments for the operation. //! @param[in] theArgs The arguments for the operation.
void SetArguments(const TopTools_ListOfShape& theArgs) void SetArguments(const TopTools_ListOfShape& theArgs)
{ {
myArguments = theArgs; myArguments = theArgs;
} }
//! Adds the shape to the arguments. //! Adds the shape to the arguments.
//! @param theS [in] One of the argument shapes. //! @param[in] theS One of the argument shapes.
void AddArgument(const TopoDS_Shape& theS) void AddArgument(const TopoDS_Shape& theS)
{ {
myArguments.Append(theS); myArguments.Append(theS);
@ -176,13 +176,13 @@ public: //! @name Shape periodicity & repetition
//! Makes the connected shape periodic. //! Makes the connected shape periodic.
//! Repeated calls of this method overwrite the previous calls //! Repeated calls of this method overwrite the previous calls
//! working with the basis connected shape. //! working with the basis connected shape.
//! @param theParams [in] Periodic options. //! @param[in] theParams Periodic options.
Standard_EXPORT void MakePeriodic(const BOPAlgo_MakePeriodic::PeriodicityParams& theParams); Standard_EXPORT void MakePeriodic(const BOPAlgo_MakePeriodic::PeriodicityParams& theParams);
//! Performs repetition of the periodic shape in specified direction //! Performs repetition of the periodic shape in specified direction
//! required number of times. //! required number of times.
//! @param theDirectionID [in] The direction's ID (0 for X, 1 for Y, 2 for Z); //! @param[in] theDirectionID The direction's ID (0 for X, 1 for Y, 2 for Z);
//! @param theTimes [in] Requested number of repetitions (sign of the value defines //! @param[in] theTimes Requested number of repetitions (sign of the value defines
//! the side of the repetition direction (positive or negative)). //! the side of the repetition direction (positive or negative)).
Standard_EXPORT void RepeatShape(const Standard_Integer theDirectionID, Standard_EXPORT void RepeatShape(const Standard_Integer theDirectionID,
const Standard_Integer theTimes); const Standard_Integer theTimes);
@ -202,7 +202,7 @@ public: //! @name Material transitions
//! Returns the original shapes which images contain the //! Returns the original shapes which images contain the
//! the given shape with FORWARD orientation. //! the given shape with FORWARD orientation.
//! @param theS [in] The shape for which the materials are necessary. //! @param[in] theS The shape for which the materials are necessary.
const TopTools_ListOfShape& MaterialsOnPositiveSide(const TopoDS_Shape& theS) const TopTools_ListOfShape& MaterialsOnPositiveSide(const TopoDS_Shape& theS)
{ {
const TopTools_ListOfShape* pLM = myMaterials.Seek(theS.Oriented(TopAbs_FORWARD)); const TopTools_ListOfShape* pLM = myMaterials.Seek(theS.Oriented(TopAbs_FORWARD));
@ -211,7 +211,7 @@ public: //! @name Material transitions
//! Returns the original shapes which images contain the //! Returns the original shapes which images contain the
//! the given shape with REVERSED orientation. //! the given shape with REVERSED orientation.
//! @param theS [in] The shape for which the materials are necessary. //! @param[in] theS The shape for which the materials are necessary.
const TopTools_ListOfShape& MaterialsOnNegativeSide(const TopoDS_Shape& theS) const TopTools_ListOfShape& MaterialsOnNegativeSide(const TopoDS_Shape& theS)
{ {
const TopTools_ListOfShape* pLM = myMaterials.Seek(theS.Oriented(TopAbs_REVERSED)); const TopTools_ListOfShape* pLM = myMaterials.Seek(theS.Oriented(TopAbs_REVERSED));
@ -228,14 +228,14 @@ public: //! @name History methods
} }
//! Returns the list of shapes modified from the given shape. //! Returns the list of shapes modified from the given shape.
//! @param theS [in] The shape for which the modified shapes are necessary. //! @param[in] theS The shape for which the modified shapes are necessary.
const TopTools_ListOfShape& GetModified(const TopoDS_Shape& theS) const TopTools_ListOfShape& GetModified(const TopoDS_Shape& theS)
{ {
return (myHistory.IsNull() ? EmptyList() : myHistory->Modified(theS)); return (myHistory.IsNull() ? EmptyList() : myHistory->Modified(theS));
} }
//! Returns the list of original shapes from which the current shape has been created. //! Returns the list of original shapes from which the current shape has been created.
//! @param theS [in] The shape for which the origins are necessary. //! @param[in] theS The shape for which the origins are necessary.
const TopTools_ListOfShape& GetOrigins(const TopoDS_Shape& theS) const TopTools_ListOfShape& GetOrigins(const TopoDS_Shape& theS)
{ {
const TopTools_ListOfShape* pLOr = myOrigins.Seek(theS); const TopTools_ListOfShape* pLOr = myOrigins.Seek(theS);

@ -138,7 +138,7 @@ public: //! @name Constructor
public: //! @name Setting the shape to make it periodic public: //! @name Setting the shape to make it periodic
//! Sets the shape to make it periodic. //! Sets the shape to make it periodic.
//! @param theShape [in] The shape to make periodic. //! @param[in] theShape The shape to make periodic.
void SetShape(const TopoDS_Shape& theShape) void SetShape(const TopoDS_Shape& theShape)
{ {
myInputShape = theShape; myInputShape = theShape;
@ -178,7 +178,7 @@ public: //! @name Definition of the structure to keep all periodicity parameters
public: //! @name Setters/Getters for periodicity parameters structure public: //! @name Setters/Getters for periodicity parameters structure
//! Sets the periodicity parameters. //! Sets the periodicity parameters.
//! @param theParams [in] Periodicity parameters //! @param[in] theParams Periodicity parameters
void SetPeriodicityParameters(const PeriodicityParams& theParams) void SetPeriodicityParameters(const PeriodicityParams& theParams)
{ {
myPeriodicityParams = theParams; myPeriodicityParams = theParams;
@ -197,9 +197,9 @@ public: //! @name Methods for setting/getting periodicity info using ID as a dir
//! - 1 - Y direction; //! - 1 - Y direction;
//! - 2 - Z direction. //! - 2 - Z direction.
//! //!
//! @param theDirectionID [in] The direction's ID; //! @param[in] theDirectionID The direction's ID;
//! @param theIsPeriodic [in] Flag defining periodicity in given direction; //! @param[in] theIsPeriodic Flag defining periodicity in given direction;
//! @param thePeriod [in] Required period in given direction. //! @param[in] thePeriod Required period in given direction.
void MakePeriodic(const Standard_Integer theDirectionID, void MakePeriodic(const Standard_Integer theDirectionID,
const Standard_Boolean theIsPeriodic, const Standard_Boolean theIsPeriodic,
const Standard_Real thePeriod = 0.0) const Standard_Real thePeriod = 0.0)
@ -210,14 +210,14 @@ public: //! @name Methods for setting/getting periodicity info using ID as a dir
} }
//! Returns the info about Periodicity of the shape in specified direction. //! Returns the info about Periodicity of the shape in specified direction.
//! @param theDirectionID [in] The direction's ID. //! @param[in] theDirectionID The direction's ID.
Standard_Boolean IsPeriodic(const Standard_Integer theDirectionID) const Standard_Boolean IsPeriodic(const Standard_Integer theDirectionID) const
{ {
return myPeriodicityParams.myPeriodic[ToDirectionID(theDirectionID)]; return myPeriodicityParams.myPeriodic[ToDirectionID(theDirectionID)];
} }
//! Returns the Period of the shape in specified direction. //! Returns the Period of the shape in specified direction.
//! @param theDirectionID [in] The direction's ID. //! @param[in] theDirectionID The direction's ID.
Standard_Real Period(const Standard_Integer theDirectionID) const Standard_Real Period(const Standard_Integer theDirectionID) const
{ {
Standard_Integer id = ToDirectionID(theDirectionID); Standard_Integer id = ToDirectionID(theDirectionID);
@ -228,8 +228,8 @@ public: //! @name Methods for setting/getting periodicity info using ID as a dir
public: //! @name Named methods for setting/getting info about shape's periodicity public: //! @name Named methods for setting/getting info about shape's periodicity
//! Sets the flag to make the shape periodic in X direction. //! Sets the flag to make the shape periodic in X direction.
//! @param theIsPeriodic [in] Flag defining periodicity in X direction; //! @param[in] theIsPeriodic Flag defining periodicity in X direction;
//! @param thePeriod [in] Required period in X direction. //! @param[in] thePeriod Required period in X direction.
void MakeXPeriodic(const Standard_Boolean theIsPeriodic, void MakeXPeriodic(const Standard_Boolean theIsPeriodic,
const Standard_Real thePeriod = 0.0) const Standard_Real thePeriod = 0.0)
{ {
@ -243,8 +243,8 @@ public: //! @name Named methods for setting/getting info about shape's periodici
Standard_Real XPeriod() const { return Period(0); } Standard_Real XPeriod() const { return Period(0); }
//! Sets the flag to make the shape periodic in Y direction. //! Sets the flag to make the shape periodic in Y direction.
//! @param theIsPeriodic [in] Flag defining periodicity in Y direction; //! @param[in] theIsPeriodic Flag defining periodicity in Y direction;
//! @param thePeriod [in] Required period in Y direction. //! @param[in] thePeriod Required period in Y direction.
void MakeYPeriodic(const Standard_Boolean theIsPeriodic, void MakeYPeriodic(const Standard_Boolean theIsPeriodic,
const Standard_Real thePeriod = 0.0) const Standard_Real thePeriod = 0.0)
{ {
@ -258,8 +258,8 @@ public: //! @name Named methods for setting/getting info about shape's periodici
Standard_Real YPeriod() const { return Period(1); } Standard_Real YPeriod() const { return Period(1); }
//! Sets the flag to make the shape periodic in Z direction. //! Sets the flag to make the shape periodic in Z direction.
//! @param theIsPeriodic [in] Flag defining periodicity in Z direction; //! @param[in] theIsPeriodic Flag defining periodicity in Z direction;
//! @param thePeriod [in] Required period in Z direction. //! @param[in] thePeriod Required period in Z direction.
void MakeZPeriodic(const Standard_Boolean theIsPeriodic, void MakeZPeriodic(const Standard_Boolean theIsPeriodic,
const Standard_Real thePeriod = 0.0) const Standard_Real thePeriod = 0.0)
{ {
@ -288,9 +288,9 @@ public: //! @name Methods for setting/getting trimming info taking Direction ID
//! //!
//! Before calling this method, the shape has to be set to be periodic in this direction. //! Before calling this method, the shape has to be set to be periodic in this direction.
//! //!
//! @param theDirectionID [in] The direction's ID; //! @param[in] theDirectionID The direction's ID;
//! @param theIsTrimmed [in] The flag defining trimming of the shape in given direction; //! @param[in] theIsTrimmed The flag defining trimming of the shape in given direction;
//! @param theFirst [in] The first periodic parameter in the given direction. //! @param[in] theFirst The first periodic parameter in the given direction.
void SetTrimmed(const Standard_Integer theDirectionID, void SetTrimmed(const Standard_Integer theDirectionID,
const Standard_Boolean theIsTrimmed, const Standard_Boolean theIsTrimmed,
const Standard_Real theFirst = 0.0) const Standard_Real theFirst = 0.0)
@ -304,14 +304,14 @@ public: //! @name Methods for setting/getting trimming info taking Direction ID
} }
//! Returns whether the input shape was trimmed in the specified direction. //! Returns whether the input shape was trimmed in the specified direction.
//! @param theDirectionID [in] The direction's ID. //! @param[in] theDirectionID The direction's ID.
Standard_Boolean IsInputTrimmed(const Standard_Integer theDirectionID) const Standard_Boolean IsInputTrimmed(const Standard_Integer theDirectionID) const
{ {
return myPeriodicityParams.myIsTrimmed[ToDirectionID(theDirectionID)]; return myPeriodicityParams.myIsTrimmed[ToDirectionID(theDirectionID)];
} }
//! Returns the first periodic parameter in the specified direction. //! Returns the first periodic parameter in the specified direction.
//! @param theDirectionID [in] The direction's ID. //! @param[in] theDirectionID The direction's ID.
Standard_Real PeriodFirst(const Standard_Integer theDirectionID) const Standard_Real PeriodFirst(const Standard_Integer theDirectionID) const
{ {
Standard_Integer id = ToDirectionID(theDirectionID); Standard_Integer id = ToDirectionID(theDirectionID);
@ -328,9 +328,9 @@ public: //! @name Named methods for setting/getting trimming info
//! //!
//! Before calling this method, the shape has to be set to be periodic in this direction. //! Before calling this method, the shape has to be set to be periodic in this direction.
//! //!
//! @param theIsTrimmed [in] Flag defining whether the shape is already trimmed //! @param[in] theIsTrimmed Flag defining whether the shape is already trimmed
//! in X direction to fit the X period; //! in X direction to fit the X period;
//! @param theFirst [in] The first X periodic parameter. //! @param[in] theFirst The first X periodic parameter.
void SetXTrimmed(const Standard_Boolean theIsTrimmed, void SetXTrimmed(const Standard_Boolean theIsTrimmed,
const Standard_Boolean theFirst = 0.0) const Standard_Boolean theFirst = 0.0)
{ {
@ -356,9 +356,9 @@ public: //! @name Named methods for setting/getting trimming info
//! //!
//! Before calling this method, the shape has to be set to be periodic in this direction. //! Before calling this method, the shape has to be set to be periodic in this direction.
//! //!
//! @param theIsTrimmed [in] Flag defining whether the shape is already trimmed //! @param[in] theIsTrimmed Flag defining whether the shape is already trimmed
//! in Y direction to fit the Y period; //! in Y direction to fit the Y period;
//! @param theFirst [in] The first Y periodic parameter. //! @param[in] theFirst The first Y periodic parameter.
void SetYTrimmed(const Standard_Boolean theIsTrimmed, void SetYTrimmed(const Standard_Boolean theIsTrimmed,
const Standard_Boolean theFirst = 0.0) const Standard_Boolean theFirst = 0.0)
{ {
@ -384,9 +384,9 @@ public: //! @name Named methods for setting/getting trimming info
//! //!
//! Before calling this method, the shape has to be set to be periodic in this direction. //! Before calling this method, the shape has to be set to be periodic in this direction.
//! //!
//! @param theIsTrimmed [in] Flag defining whether the shape is already trimmed //! @param[in] theIsTrimmed Flag defining whether the shape is already trimmed
//! in Z direction to fit the Z period; //! in Z direction to fit the Z period;
//! @param theFirst [in] The first Z periodic parameter. //! @param[in] theFirst The first Z periodic parameter.
void SetZTrimmed(const Standard_Boolean theIsTrimmed, void SetZTrimmed(const Standard_Boolean theIsTrimmed,
const Standard_Boolean theFirst = 0.0) const Standard_Boolean theFirst = 0.0)
{ {
@ -419,8 +419,8 @@ public: //! @name Using the algorithm to repeat the shape
//! be perform in negative direction. //! be perform in negative direction.
//! Makes the repeated shape a base for following repetitions. //! Makes the repeated shape a base for following repetitions.
//! //!
//! @param theDirectionID [in] The direction's ID; //! @param[in] theDirectionID The direction's ID;
//! @param theTimes [in] Requested number of repetitions. //! @param[in] theTimes Requested number of repetitions.
Standard_EXPORT const TopoDS_Shape& RepeatShape(const Standard_Integer theDirectionID, Standard_EXPORT const TopoDS_Shape& RepeatShape(const Standard_Integer theDirectionID,
const Standard_Integer theTimes); const Standard_Integer theTimes);
@ -429,7 +429,7 @@ public: //! @name Using the algorithm to repeat the shape
//! perform in negative X direction. //! perform in negative X direction.
//! Makes the repeated shape a base for following repetitions. //! Makes the repeated shape a base for following repetitions.
//! //!
//! @param theTimes [in] Requested number of repetitions. //! @param[in] theTimes Requested number of repetitions.
const TopoDS_Shape& XRepeat(const Standard_Integer theTimes) const TopoDS_Shape& XRepeat(const Standard_Integer theTimes)
{ {
return RepeatShape(0, theTimes); return RepeatShape(0, theTimes);
@ -440,7 +440,7 @@ public: //! @name Using the algorithm to repeat the shape
//! perform in negative Y direction. //! perform in negative Y direction.
//! Makes the repeated shape a base for following repetitions. //! Makes the repeated shape a base for following repetitions.
//! //!
//! @param theTimes [in] Requested number of repetitions. //! @param[in] theTimes Requested number of repetitions.
const TopoDS_Shape& YRepeat(const Standard_Integer theTimes) const TopoDS_Shape& YRepeat(const Standard_Integer theTimes)
{ {
return RepeatShape(1, theTimes); return RepeatShape(1, theTimes);
@ -451,7 +451,7 @@ public: //! @name Using the algorithm to repeat the shape
//! perform in negative Z direction. //! perform in negative Z direction.
//! Makes the repeated shape a base for following repetitions. //! Makes the repeated shape a base for following repetitions.
//! //!
//! @param theTimes [in] Requested number of repetitions. //! @param[in] theTimes Requested number of repetitions.
const TopoDS_Shape& ZRepeat(const Standard_Integer theTimes) const TopoDS_Shape& ZRepeat(const Standard_Integer theTimes)
{ {
return RepeatShape(2, theTimes); return RepeatShape(2, theTimes);
@ -490,7 +490,7 @@ public: //! @name Getting the identical shapes
//! on the opposite periodic side. //! on the opposite periodic side.
//! Returns empty list in case the shape has no twin. //! Returns empty list in case the shape has no twin.
//! //!
//! @param theS [in] Shape to get the twins for. //! @param[in] theS Shape to get the twins for.
const TopTools_ListOfShape& GetTwins(const TopoDS_Shape& theS) const const TopTools_ListOfShape& GetTwins(const TopoDS_Shape& theS) const
{ {
static TopTools_ListOfShape empty; static TopTools_ListOfShape empty;
@ -559,17 +559,17 @@ protected: //! @name Protected methods performing the operation
//! Splits the shape by the given tools, copying the geometry of coinciding //! Splits the shape by the given tools, copying the geometry of coinciding
//! parts from the given tools to the split shape. //! parts from the given tools to the split shape.
//! @param theTools [in] The tools to split the shape and take the geometry //! @param[in] theTools The tools to split the shape and take the geometry
//! for coinciding parts. //! for coinciding parts.
//! @param theSplitShapeHistory [out] The history of shape split //! @param[out] theSplitShapeHistory The history of shape split
//! @param theSplitToolsHistory [out] The history of tools modifications during the split //! @param[out] theSplitToolsHistory The history of tools modifications during the split
Standard_EXPORT void SplitShape(const TopTools_ListOfShape& theTools, Standard_EXPORT void SplitShape(const TopTools_ListOfShape& theTools,
Handle(BRepTools_History) theSplitShapeHistory = NULL, Handle(BRepTools_History) theSplitShapeHistory = NULL,
Handle(BRepTools_History) theSplitToolsHistory = NULL); Handle(BRepTools_History) theSplitToolsHistory = NULL);
//! Updates the map of twins after periodic shape repetition. //! Updates the map of twins after periodic shape repetition.
//! @param theTranslationHistory [in] The history of translation of the periodic shape. //! @param[in] theTranslationHistory The history of translation of the periodic shape.
//! @param theGluingHistory [in] The history of gluing of the repeated shapes. //! @param[in] theGluingHistory The history of gluing of the repeated shapes.
Standard_EXPORT void UpdateTwins(const BRepTools_History& theTranslationHistory, Standard_EXPORT void UpdateTwins(const BRepTools_History& theTranslationHistory,
const BRepTools_History& theGluingHistory); const BRepTools_History& theGluingHistory);

@ -161,7 +161,7 @@ public: //! @name Constructors
public: //! @name Setting input data for the algorithm public: //! @name Setting input data for the algorithm
//! Sets the shape for processing. //! Sets the shape for processing.
//! @param theShape [in] The shape to remove the faces from. //! @param[in] theShape The shape to remove the faces from.
//! It should either be the SOLID, COMPSOLID or COMPOUND of Solids. //! It should either be the SOLID, COMPSOLID or COMPOUND of Solids.
void SetShape(const TopoDS_Shape& theShape) void SetShape(const TopoDS_Shape& theShape)
{ {
@ -175,14 +175,14 @@ public: //! @name Setting input data for the algorithm
} }
//! Adds the face to remove from the input shape. //! Adds the face to remove from the input shape.
//! @param theFace [in] The shape to extract the faces for removal. //! @param[in] theFace The shape to extract the faces for removal.
void AddFaceToRemove(const TopoDS_Shape& theFace) void AddFaceToRemove(const TopoDS_Shape& theFace)
{ {
myFacesToRemove.Append(theFace); myFacesToRemove.Append(theFace);
} }
//! Adds the faces to remove from the input shape. //! Adds the faces to remove from the input shape.
//! @param theFaces [in] The list of shapes to extract the faces for removal. //! @param[in] theFaces The list of shapes to extract the faces for removal.
void AddFacesToRemove(const TopTools_ListOfShape& theFaces) void AddFacesToRemove(const TopTools_ListOfShape& theFaces)
{ {
TopTools_ListIteratorOfListOfShape it(theFaces); TopTools_ListIteratorOfListOfShape it(theFaces);
@ -238,14 +238,14 @@ protected: //! @name Protected methods performing the removal
Standard_EXPORT void RemoveFeatures(const Message_ProgressRange& theRange); Standard_EXPORT void RemoveFeatures(const Message_ProgressRange& theRange);
//! Remove the single feature from the shape. //! Remove the single feature from the shape.
//! @param theFeature [in] The feature to remove; //! @param[in] theFeature The feature to remove;
//! @param theSolids [in] The solids to be reconstructed after feature removal; //! @param[in] theSolids The solids to be reconstructed after feature removal;
//! @param theFeatureFacesMap [in] The map of feature faces; //! @param[in] theFeatureFacesMap The map of feature faces;
//! @param theHasAdjacentFaces [in] Shows whether the adjacent faces have been //! @param[in] theHasAdjacentFaces Shows whether the adjacent faces have been
//! found for the feature or not; //! found for the feature or not;
//! @param theAdjFaces [in] The reconstructed adjacent faces covering the feature; //! @param[in] theAdjFaces The reconstructed adjacent faces covering the feature;
//! @param theAdjFacesHistory [in] The history of the adjacent faces reconstruction; //! @param[in] theAdjFacesHistory The history of the adjacent faces reconstruction;
//! @param theSolidsHistoryNeeded [in] Defines whether the history of solids //! @param[in] theSolidsHistoryNeeded Defines whether the history of solids
//! modifications should be tracked or not. //! modifications should be tracked or not.
Standard_EXPORT void RemoveFeature(const TopoDS_Shape& theFeature, Standard_EXPORT void RemoveFeature(const TopoDS_Shape& theFeature,
const TopTools_IndexedMapOfShape& theSolids, const TopTools_IndexedMapOfShape& theSolids,

@ -321,10 +321,10 @@ public: //! @name Choosing correct orientation for the split shape
//! - 100 - bad types. //! - 100 - bad types.
//! In case of any error the method always returns FALSE. //! In case of any error the method always returns FALSE.
//! //!
//! @param theSplit [in] Split shape //! @param[in] theSplit Split shape
//! @param theShape [in] Original shape //! @param[in] theShape Original shape
//! @param theContext [in] cached geometrical tools //! @param[in] theContext cached geometrical tools
//! @param theError [out] Error Status of the operation //! @param[out] theError Error Status of the operation
Standard_EXPORT static Standard_Boolean IsSplitToReverse(const TopoDS_Shape& theSplit, Standard_EXPORT static Standard_Boolean IsSplitToReverse(const TopoDS_Shape& theSplit,
const TopoDS_Shape& theShape, const TopoDS_Shape& theShape,
const Handle(IntTools_Context)& theContext, const Handle(IntTools_Context)& theContext,
@ -354,10 +354,10 @@ public: //! @name Choosing correct orientation for the split shape
//! - 4 - unable to compute the normal for the original face. //! - 4 - unable to compute the normal for the original face.
//! In case of any error the method always returns FALSE. //! In case of any error the method always returns FALSE.
//! //!
//! @param theSplit [in] Split face //! @param[in] theSplit Split face
//! @param theShape [in] Original face //! @param[in] theShape Original face
//! @param theContext [in] cached geometrical tools //! @param[in] theContext cached geometrical tools
//! @param theError [out] Error Status of the operation //! @param[out] theError Error Status of the operation
Standard_EXPORT static Standard_Boolean IsSplitToReverse(const TopoDS_Face& theSplit, Standard_EXPORT static Standard_Boolean IsSplitToReverse(const TopoDS_Face& theSplit,
const TopoDS_Face& theShape, const TopoDS_Face& theShape,
const Handle(IntTools_Context)& theContext, const Handle(IntTools_Context)& theContext,
@ -379,10 +379,10 @@ public: //! @name Choosing correct orientation for the split shape
//! - 4 - unable to compute the tangent vector for the original edge; //! - 4 - unable to compute the tangent vector for the original edge;
//! In case of any error the method always returns FALSE. //! In case of any error the method always returns FALSE.
//! //!
//! @param theSplit [in] Split edge //! @param[in] theSplit Split edge
//! @param theShape [in] Original edge //! @param[in] theShape Original edge
//! @param theContext [in] cached geometrical tools //! @param[in] theContext cached geometrical tools
//! @param theError [out] Error Status of the operation //! @param[out] theError Error Status of the operation
Standard_EXPORT static Standard_Boolean IsSplitToReverse(const TopoDS_Edge& theSplit, Standard_EXPORT static Standard_Boolean IsSplitToReverse(const TopoDS_Edge& theSplit,
const TopoDS_Edge& theShape, const TopoDS_Edge& theShape,
const Handle(IntTools_Context)& theContext, const Handle(IntTools_Context)& theContext,

@ -92,8 +92,8 @@ public:
Standard_EXPORT const Handle(Poly_Triangulation)& Triangulation (const Poly_MeshPurpose thePurpose = Poly_MeshPurpose_NONE) const; Standard_EXPORT const Handle(Poly_Triangulation)& Triangulation (const Poly_MeshPurpose thePurpose = Poly_MeshPurpose_NONE) const;
//! Sets input triangulation for this face. //! Sets input triangulation for this face.
//! @param theTriangulation [in] triangulation to be set //! @param[in] theTriangulation triangulation to be set
//! @param theToReset [in] flag to reset triangulations list to new list with only one input triangulation. //! @param[in] theToReset flag to reset triangulations list to new list with only one input triangulation.
//! If theTriangulation is NULL internal list of triangulations will be cleared and active triangulation will be nullified. //! If theTriangulation is NULL internal list of triangulations will be cleared and active triangulation will be nullified.
//! If theToReset is TRUE internal list of triangulations will be reset //! If theToReset is TRUE internal list of triangulations will be reset
//! to new list with only one input triangulation that will be active. //! to new list with only one input triangulation that will be active.

@ -65,9 +65,9 @@ public:
Standard_EXPORT static Handle(Geom_Surface) Surface (const TopoDS_Face& F); Standard_EXPORT static Handle(Geom_Surface) Surface (const TopoDS_Face& F);
//! Returns the triangulation of the face according to the mesh purpose. //! Returns the triangulation of the face according to the mesh purpose.
//! @param theFace [in] the input face to find triangulation. //! @param[in] theFace the input face to find triangulation.
//! @param theLocation [out] the face location. //! @param[out] theLocation the face location.
//! @param theMeshPurpose [in] a mesh purpose to find appropriate triangulation (NONE by default). //! @param[in] theMeshPurpose a mesh purpose to find appropriate triangulation (NONE by default).
//! @return an active triangulation in case of NONE purpose, //! @return an active triangulation in case of NONE purpose,
//! the first triangulation appropriate for the input purpose, //! the first triangulation appropriate for the input purpose,
//! just the first triangulation if none matching other criteria and input purpose is AnyFallback //! just the first triangulation if none matching other criteria and input purpose is AnyFallback
@ -76,8 +76,8 @@ public:
const Poly_MeshPurpose theMeshPurpose = Poly_MeshPurpose_NONE); const Poly_MeshPurpose theMeshPurpose = Poly_MeshPurpose_NONE);
//! Returns all triangulations of the face. //! Returns all triangulations of the face.
//! @param theFace [in] the input face. //! @param[in] theFace the input face.
//! @param theLocation [out] the face location. //! @param[out] theLocation the face location.
//! @return list of all available face triangulations. //! @return list of all available face triangulations.
Standard_EXPORT static const Poly_ListOfTriangulation& Triangulations (const TopoDS_Face& theFace, TopLoc_Location& theLocation); Standard_EXPORT static const Poly_ListOfTriangulation& Triangulations (const TopoDS_Face& theFace, TopLoc_Location& theLocation);
@ -269,9 +269,9 @@ public:
Standard_EXPORT static Standard_Real Tolerance (const TopoDS_Vertex& V); Standard_EXPORT static Standard_Real Tolerance (const TopoDS_Vertex& V);
//! Finds the parameter of <theV> on <theE>. //! Finds the parameter of <theV> on <theE>.
//! @param theV [in] input vertex //! @param[in] theV input vertex
//! @param theE [in] input edge //! @param[in] theE input edge
//! @param theParam [out] calculated parameter on the curve //! @param[out] theParam calculated parameter on the curve
//! @return TRUE if done //! @return TRUE if done
Standard_EXPORT static Standard_Boolean Parameter (const TopoDS_Vertex& theV, Standard_EXPORT static Standard_Boolean Parameter (const TopoDS_Vertex& theV,
const TopoDS_Edge& theE, const TopoDS_Edge& theE,

@ -60,12 +60,12 @@ public: //! @name Constructors
//! Constructor for checking single shape. //! Constructor for checking single shape.
//! //!
//! @param theS [in] - the shape to check; //! @param[in] theS - the shape to check;
//! @param bTestSE [in] - flag which specifies whether to check the shape //! @param[in] bTestSE - flag which specifies whether to check the shape
//! on small edges or not; by default it is set to TRUE; //! on small edges or not; by default it is set to TRUE;
//! @param bTestSI [in] - flag which specifies whether to check the shape //! @param[in] bTestSI - flag which specifies whether to check the shape
//! on self-interference or not; by default it is set to TRUE; //! on self-interference or not; by default it is set to TRUE;
//! @param theRange [in] - parameter to use progress indicator //! @param[in] theRange - parameter to use progress indicator
Standard_EXPORT BRepAlgoAPI_Check(const TopoDS_Shape& theS, Standard_EXPORT BRepAlgoAPI_Check(const TopoDS_Shape& theS,
const Standard_Boolean bTestSE = Standard_True, const Standard_Boolean bTestSE = Standard_True,
const Standard_Boolean bTestSI = Standard_True, const Standard_Boolean bTestSI = Standard_True,
@ -76,15 +76,15 @@ public: //! @name Constructors
//! the types of the given shapes will be checked on validity //! the types of the given shapes will be checked on validity
//! for Boolean operation of given type. //! for Boolean operation of given type.
//! //!
//! @param theS1 [in] - the first shape to check; //! @param[in] theS1 - the first shape to check;
//! @param theS2 [in] - the second shape to check; //! @param[in] theS2 - the second shape to check;
//! @param theOp [in] - the type of Boolean Operation for which the validity //! @param[in] theOp - the type of Boolean Operation for which the validity
//! of given shapes should be checked. //! of given shapes should be checked.
//! @param bTestSE [in] - flag which specifies whether to check the shape //! @param[in] bTestSE - flag which specifies whether to check the shape
//! on small edges or not; by default it is set to TRUE; //! on small edges or not; by default it is set to TRUE;
//! @param bTestSI [in] - flag which specifies whether to check the shape //! @param[in] bTestSI - flag which specifies whether to check the shape
//! on self-interference or not; by default it is set to TRUE; //! on self-interference or not; by default it is set to TRUE;
//! @param theRange [in] - parameter to use progress indicator //! @param[in] theRange - parameter to use progress indicator
Standard_EXPORT BRepAlgoAPI_Check(const TopoDS_Shape& theS1, Standard_EXPORT BRepAlgoAPI_Check(const TopoDS_Shape& theS1,
const TopoDS_Shape& theS2, const TopoDS_Shape& theS2,
const BOPAlgo_Operation theOp = BOPAlgo_UNKNOWN, const BOPAlgo_Operation theOp = BOPAlgo_UNKNOWN,
@ -97,10 +97,10 @@ public: //! @name Initializing the algorithm
//! Initializes the algorithm with single shape. //! Initializes the algorithm with single shape.
//! //!
//! @param theS [in] - the shape to check; //! @param[in] theS - the shape to check;
//! @param bTestSE [in] - flag which specifies whether to check the shape //! @param[in] bTestSE - flag which specifies whether to check the shape
//! on small edges or not; by default it is set to TRUE; //! on small edges or not; by default it is set to TRUE;
//! @param bTestSI [in] - flag which specifies whether to check the shape //! @param[in] bTestSI - flag which specifies whether to check the shape
//! on self-interference or not; by default it is set to TRUE; //! on self-interference or not; by default it is set to TRUE;
void SetData(const TopoDS_Shape& theS, void SetData(const TopoDS_Shape& theS,
const Standard_Boolean bTestSE = Standard_True, const Standard_Boolean bTestSE = Standard_True,
@ -118,13 +118,13 @@ public: //! @name Initializing the algorithm
//! the types of the given shapes will be checked on validity //! the types of the given shapes will be checked on validity
//! for Boolean operation of given type. //! for Boolean operation of given type.
//! //!
//! @param theS1 [in] - the first shape to check; //! @param[in] theS1 - the first shape to check;
//! @param theS2 [in] - the second shape to check; //! @param[in] theS2 - the second shape to check;
//! @param theOp [in] - the type of Boolean Operation for which the validity //! @param[in] theOp - the type of Boolean Operation for which the validity
//! of given shapes should be checked. //! of given shapes should be checked.
//! @param bTestSE [in] - flag which specifies whether to check the shape //! @param[in] bTestSE - flag which specifies whether to check the shape
//! on small edges or not; by default it is set to TRUE; //! on small edges or not; by default it is set to TRUE;
//! @param bTestSI [in] - flag which specifies whether to check the shape //! @param[in] bTestSI - flag which specifies whether to check the shape
//! on self-interference or not; by default it is set to TRUE; //! on self-interference or not; by default it is set to TRUE;
void SetData(const TopoDS_Shape& theS1, void SetData(const TopoDS_Shape& theS1,
const TopoDS_Shape& theS2, const TopoDS_Shape& theS2,

@ -117,7 +117,7 @@ public: //! @name Constructors
public: //! @name Setting input data for the algorithm public: //! @name Setting input data for the algorithm
//! Sets the shape for processing. //! Sets the shape for processing.
//! @param theShape [in] The shape to remove the features from. //! @param[in] theShape The shape to remove the features from.
//! It should either be the SOLID, COMPSOLID or COMPOUND of Solids. //! It should either be the SOLID, COMPSOLID or COMPOUND of Solids.
void SetShape(const TopoDS_Shape& theShape) void SetShape(const TopoDS_Shape& theShape)
{ {
@ -131,14 +131,14 @@ public: //! @name Setting input data for the algorithm
} }
//! Adds the features to remove from the input shape. //! Adds the features to remove from the input shape.
//! @param theFace [in] The shape to extract the faces for removal. //! @param[in] theFace The shape to extract the faces for removal.
void AddFaceToRemove(const TopoDS_Shape& theFace) void AddFaceToRemove(const TopoDS_Shape& theFace)
{ {
myFacesToRemove.Append(theFace); myFacesToRemove.Append(theFace);
} }
//! Adds the faces to remove from the input shape. //! Adds the faces to remove from the input shape.
//! @param theFaces [in] The list of shapes to extract the faces for removal. //! @param[in] theFaces The list of shapes to extract the faces for removal.
void AddFacesToRemove(const TopTools_ListOfShape& theFaces) void AddFacesToRemove(const TopTools_ListOfShape& theFaces)
{ {
TopTools_ListIteratorOfListOfShape it(theFaces); TopTools_ListIteratorOfListOfShape it(theFaces);

@ -29,7 +29,7 @@ public:
DEFINE_STANDARD_ALLOC DEFINE_STANDARD_ALLOC
//! Ctor. Sets mesh to process. //! Ctor. Sets mesh to process.
//! @param theMesh [in] - Mesh to construct shape for. //! @param[in] theMesh - Mesh to construct shape for.
BRepBuilderAPI_MakeShapeOnMesh(const Handle(Poly_Triangulation)& theMesh) BRepBuilderAPI_MakeShapeOnMesh(const Handle(Poly_Triangulation)& theMesh)
: myMesh(theMesh) : myMesh(theMesh)
{} {}

@ -78,9 +78,9 @@ public: //! @name public API
//! @param theLocation - location of the point or the plane; //! @param theLocation - location of the point or the plane;
//! @param theCoeff - plane coefficients; //! @param theCoeff - plane coefficients;
//! @param theIsByPoint - flag of restricition (point/plane); //! @param theIsByPoint - flag of restricition (point/plane);
//! @param theOutMass[out] - mass (volume) of region; //! @param[out] theOutMass - mass (volume) of region;
//! @param theOutGravityCenter[out] - garvity center of region; //! @param[out] theOutGravityCenter - garvity center of region;
//! @param theOutInertia[out] - matrix of inertia; //! @param[out] theOutInertia - matrix of inertia;
Standard_EXPORT void Compute( Standard_EXPORT void Compute(
const BRepGProp_Face& theSurface, const BRepGProp_Face& theSurface,
const gp_Pnt& theLocation, const gp_Pnt& theLocation,
@ -97,9 +97,9 @@ public: //! @name public API
//! Error of the computation is not calculated. //! Error of the computation is not calculated.
//! @param theSurface - bounding surface of the region; //! @param theSurface - bounding surface of the region;
//! @param theLocation - surface location; //! @param theLocation - surface location;
//! @param theOutMass[out] - mass (volume) of region; //! @param[out] theOutMass - mass (volume) of region;
//! @param theOutGravityCenter[out] - garvity center of region; //! @param[out] theOutGravityCenter - garvity center of region;
//! @param theOutInertia[out] - matrix of inertia; //! @param[out] theOutInertia - matrix of inertia;
Standard_EXPORT void Compute( Standard_EXPORT void Compute(
const BRepGProp_Face& theSurface, const BRepGProp_Face& theSurface,
const gp_Pnt& theLocation, const gp_Pnt& theLocation,
@ -118,9 +118,9 @@ public: //! @name public API
//! @param theLocation - location of the point or the plane; //! @param theLocation - location of the point or the plane;
//! @param theCoeff - plane coefficients; //! @param theCoeff - plane coefficients;
//! @param theIsByPoint - flag of restricition (point/plane); //! @param theIsByPoint - flag of restricition (point/plane);
//! @param theOutMass[out] - mass (volume) of region; //! @param[out] theOutMass - mass (volume) of region;
//! @param theOutGravityCenter[out] - garvity center of region; //! @param[out] theOutGravityCenter - garvity center of region;
//! @param theOutInertia[out] - matrix of inertia; //! @param[out] theOutInertia - matrix of inertia;
Standard_EXPORT void Compute( Standard_EXPORT void Compute(
BRepGProp_Face& theSurface, BRepGProp_Face& theSurface,
BRepGProp_Domain& theDomain, BRepGProp_Domain& theDomain,
@ -139,9 +139,9 @@ public: //! @name public API
//! @param theSurface - bounding surface of the region; //! @param theSurface - bounding surface of the region;
//! @param theDomain - surface boundings; //! @param theDomain - surface boundings;
//! @param theLocation - surface location; //! @param theLocation - surface location;
//! @param theOutMass[out] - mass (volume) of region; //! @param[out] theOutMass - mass (volume) of region;
//! @param theOutGravityCenter[out] - garvity center of region; //! @param[out] theOutGravityCenter - garvity center of region;
//! @param theOutInertia[out] - matrix of inertia; //! @param[out] theOutInertia - matrix of inertia;
Standard_EXPORT void Compute( Standard_EXPORT void Compute(
BRepGProp_Face& theSurface, BRepGProp_Face& theSurface,
BRepGProp_Domain& theDomain, BRepGProp_Domain& theDomain,
@ -160,9 +160,9 @@ public: //! @name public API
//! @param theEps - maximal relative error of computed mass (volume) for face; //! @param theEps - maximal relative error of computed mass (volume) for face;
//! @param theCoeff - plane coefficients; //! @param theCoeff - plane coefficients;
//! @param theIsByPoint - flag of restricition (point/plane); //! @param theIsByPoint - flag of restricition (point/plane);
//! @param theOutMass[out] - mass (volume) of region; //! @param[out] theOutMass - mass (volume) of region;
//! @param theOutGravityCenter[out] - garvity center of region; //! @param[out] theOutGravityCenter - garvity center of region;
//! @param theOutInertia[out] - matrix of inertia; //! @param[out] theOutInertia - matrix of inertia;
//! @return value of error which is calculated as //! @return value of error which is calculated as
//! Abs((M(i+1)-M(i))/M(i+1)), M(i+1) and M(i) are values //! Abs((M(i+1)-M(i))/M(i+1)), M(i+1) and M(i) are values
//! for two successive steps of adaptive integration. //! for two successive steps of adaptive integration.
@ -183,9 +183,9 @@ public: //! @name public API
//! @param theDomain - surface boundings; //! @param theDomain - surface boundings;
//! @param theLocation - surface location; //! @param theLocation - surface location;
//! @param theEps - maximal relative error of computed mass (square) for face; //! @param theEps - maximal relative error of computed mass (square) for face;
//! @param theOutMass[out] - mass (volume) of region; //! @param[out] theOutMass - mass (volume) of region;
//! @param theOutGravityCenter[out] - garvity center of region; //! @param[out] theOutGravityCenter - garvity center of region;
//! @param theOutInertia[out] - matrix of inertia; //! @param[out] theOutInertia - matrix of inertia;
//! @return value of error which is calculated as //! @return value of error which is calculated as
//! Abs((M(i+1)-M(i))/M(i+1)), M(i+1) and M(i) are values //! Abs((M(i+1)-M(i))/M(i+1)), M(i+1) and M(i) are values
//! for two successive steps of adaptive integration. //! for two successive steps of adaptive integration.

@ -274,13 +274,13 @@ public:
//! Enlarges the face on the given value. //! Enlarges the face on the given value.
//! @param theF [in] The face to extend //! @param[in] theF The face to extend
//! @param theExtVal [in] The extension value //! @param[in] theExtVal The extension value
//! @param theExtUMin [in] Defines whether to extend the face in UMin direction //! @param[in] theExtUMin Defines whether to extend the face in UMin direction
//! @param theExtUMax [in] Defines whether to extend the face in UMax direction //! @param[in] theExtUMax Defines whether to extend the face in UMax direction
//! @param theExtVMin [in] Defines whether to extend the face in VMin direction //! @param[in] theExtVMin Defines whether to extend the face in VMin direction
//! @param theExtVMax [in] Defines whether to extend the face in VMax direction //! @param[in] theExtVMax Defines whether to extend the face in VMax direction
//! @param theFExtended [in] The extended face //! @param[in] theFExtended The extended face
Standard_EXPORT static void ExtendFace(const TopoDS_Face& theF, Standard_EXPORT static void ExtendFace(const TopoDS_Face& theF,
const Standard_Real theExtVal, const Standard_Real theExtVal,
const Standard_Boolean theExtUMin, const Standard_Boolean theExtUMin,

@ -56,12 +56,12 @@ public:
//! Checks if the deflection of current polygonal representation //! Checks if the deflection of current polygonal representation
//! is consistent with the required deflection. //! is consistent with the required deflection.
//! @param theCurrent [in] Current deflection. //! @param[in] theCurrent Current deflection.
//! @param theRequired [in] Required deflection. //! @param[in] theRequired Required deflection.
//! @param theAllowDecrease [in] Flag controlling the check. If decrease is allowed, //! @param[in] theAllowDecrease Flag controlling the check. If decrease is allowed,
//! to be consistent the current and required deflections should be approximately the same. //! to be consistent the current and required deflections should be approximately the same.
//! If not allowed, the current deflection should be less than required. //! If not allowed, the current deflection should be less than required.
//! @param theRatio [in] The ratio for comparison of the deflections (value from 0 to 1). //! @param[in] theRatio The ratio for comparison of the deflections (value from 0 to 1).
Standard_EXPORT static Standard_Boolean IsConsistent ( Standard_EXPORT static Standard_Boolean IsConsistent (
const Standard_Real theCurrent, const Standard_Real theCurrent,
const Standard_Real theRequired, const Standard_Real theRequired,

@ -110,9 +110,9 @@ public:
//! @param theIndex index of discretization point. //! @param theIndex index of discretization point.
//! @param theIsoParam parameter on surface to be used as second coordinate //! @param theIsoParam parameter on surface to be used as second coordinate
//! of resulting 2d point. //! of resulting 2d point.
//! @param theParam[out] parameter of the point on the iso curve. //! @param[out] theParam parameter of the point on the iso curve.
//! @param thePoint[out] discretization point. //! @param[out] thePoint discretization point.
//! @param theUV[out] discretization point in parametric space of the surface. //! @param[out] theUV discretization point in parametric space of the surface.
//! @return TRUE on success, FALSE elsewhere. //! @return TRUE on success, FALSE elsewhere.
Standard_EXPORT Standard_Boolean Value(const Standard_Integer theIndex, Standard_EXPORT Standard_Boolean Value(const Standard_Integer theIndex,
const Standard_Real theIsoParam, const Standard_Real theIsoParam,
@ -123,9 +123,9 @@ public:
//! Gets parameters of discretization point with the given index. //! Gets parameters of discretization point with the given index.
//! @param theIndex index of discretization point. //! @param theIndex index of discretization point.
//! @param theSurface surface the curve is lying onto. //! @param theSurface surface the curve is lying onto.
//! @param theParam[out] parameter of the point on the curve. //! @param[out] theParam parameter of the point on the curve.
//! @param thePoint[out] discretization point. //! @param[out] thePoint discretization point.
//! @param theUV[out] discretization point in parametric space of the surface. //! @param[out] theUV discretization point in parametric space of the surface.
//! @return TRUE on success, FALSE elsewhere. //! @return TRUE on success, FALSE elsewhere.
Standard_EXPORT Standard_Boolean Value(const Standard_Integer theIndex, Standard_EXPORT Standard_Boolean Value(const Standard_Integer theIndex,
const Handle(BRepAdaptor_Surface)& theSurface, const Handle(BRepAdaptor_Surface)& theSurface,

@ -39,23 +39,23 @@ public:
//! Make a cone. //! Make a cone.
//! @param R1 [in] cone bottom radius, may be null (z = 0) //! @param[in] R1 cone bottom radius, may be null (z = 0)
//! @param R2 [in] cone top radius, may be null (z = H) //! @param[in] R2 cone top radius, may be null (z = H)
//! @param H [in] cone height //! @param[in] H cone height
Standard_EXPORT BRepPrimAPI_MakeCone(const Standard_Real R1, const Standard_Real R2, const Standard_Real H); Standard_EXPORT BRepPrimAPI_MakeCone(const Standard_Real R1, const Standard_Real R2, const Standard_Real H);
//! Make a cone. //! Make a cone.
//! @param R1 [in] cone bottom radius, may be null (z = 0) //! @param[in] R1 cone bottom radius, may be null (z = 0)
//! @param R2 [in] cone top radius, may be null (z = H) //! @param[in] R2 cone top radius, may be null (z = H)
//! @param H [in] cone height //! @param[in] H cone height
//! @param angle [in] angle to create a part cone //! @param[in] angle angle to create a part cone
Standard_EXPORT BRepPrimAPI_MakeCone(const Standard_Real R1, const Standard_Real R2, const Standard_Real H, const Standard_Real angle); Standard_EXPORT BRepPrimAPI_MakeCone(const Standard_Real R1, const Standard_Real R2, const Standard_Real H, const Standard_Real angle);
//! Make a cone. //! Make a cone.
//! @param axes [in] coordinate system for the construction of the cone //! @param[in] axes coordinate system for the construction of the cone
//! @param R1 [in] cone bottom radius, may be null (z = 0) //! @param[in] R1 cone bottom radius, may be null (z = 0)
//! @param R2 [in] cone top radius, may be null (z = H) //! @param[in] R2 cone top radius, may be null (z = H)
//! @param H [in] cone height //! @param[in] H cone height
Standard_EXPORT BRepPrimAPI_MakeCone(const gp_Ax2& Axes, const Standard_Real R1, const Standard_Real R2, const Standard_Real H); Standard_EXPORT BRepPrimAPI_MakeCone(const gp_Ax2& Axes, const Standard_Real R1, const Standard_Real R2, const Standard_Real H);
//! Make a cone of height H radius R1 in the plane z = //! Make a cone of height H radius R1 in the plane z =

@ -38,20 +38,20 @@ public:
DEFINE_STANDARD_ALLOC DEFINE_STANDARD_ALLOC
//! Make a cylinder. //! Make a cylinder.
//! @param R [in] cylinder radius //! @param[in] R cylinder radius
//! @param H [in] cylinder height //! @param[in] H cylinder height
Standard_EXPORT BRepPrimAPI_MakeCylinder(const Standard_Real R, const Standard_Real H); Standard_EXPORT BRepPrimAPI_MakeCylinder(const Standard_Real R, const Standard_Real H);
//! Make a cylinder (part cylinder). //! Make a cylinder (part cylinder).
//! @param R [in] cylinder radius //! @param[in] R cylinder radius
//! @param H [in] cylinder height //! @param[in] H cylinder height
//! @param Angle [in] defines the missing portion of the cylinder //! @param[in] Angle defines the missing portion of the cylinder
Standard_EXPORT BRepPrimAPI_MakeCylinder(const Standard_Real R, const Standard_Real H, const Standard_Real Angle); Standard_EXPORT BRepPrimAPI_MakeCylinder(const Standard_Real R, const Standard_Real H, const Standard_Real Angle);
//! Make a cylinder of radius R and length H. //! Make a cylinder of radius R and length H.
//! @param Axes [in] coordinate system for the construction of the cylinder //! @param[in] Axes coordinate system for the construction of the cylinder
//! @param R [in] cylinder radius //! @param[in] R cylinder radius
//! @param H [in] cylinder height //! @param[in] H cylinder height
Standard_EXPORT BRepPrimAPI_MakeCylinder(const gp_Ax2& Axes, const Standard_Real R, const Standard_Real H); Standard_EXPORT BRepPrimAPI_MakeCylinder(const gp_Ax2& Axes, const Standard_Real R, const Standard_Real H);
//! Make a cylinder of radius R and length H with //! Make a cylinder of radius R and length H with

@ -39,69 +39,69 @@ public:
//! Make a sphere. //! Make a sphere.
//! @param R [in] sphere radius //! @param[in] R sphere radius
Standard_EXPORT BRepPrimAPI_MakeSphere(const Standard_Real R); Standard_EXPORT BRepPrimAPI_MakeSphere(const Standard_Real R);
//! Make a sphere (spherical wedge). //! Make a sphere (spherical wedge).
//! @param R [in] sphere radius //! @param[in] R sphere radius
//! @param angle [in] angle between the radii lying within the bounding semidisks //! @param[in] angle angle between the radii lying within the bounding semidisks
Standard_EXPORT BRepPrimAPI_MakeSphere(const Standard_Real R, const Standard_Real angle); Standard_EXPORT BRepPrimAPI_MakeSphere(const Standard_Real R, const Standard_Real angle);
//! Make a sphere (spherical segment). //! Make a sphere (spherical segment).
//! @param R [in] sphere radius //! @param[in] R sphere radius
//! @param angle1 [in] first angle defining a spherical segment //! @param[in] angle1 first angle defining a spherical segment
//! @param angle2 [in] second angle defining a spherical segment //! @param[in] angle2 second angle defining a spherical segment
Standard_EXPORT BRepPrimAPI_MakeSphere(const Standard_Real R, const Standard_Real angle1, const Standard_Real angle2); Standard_EXPORT BRepPrimAPI_MakeSphere(const Standard_Real R, const Standard_Real angle1, const Standard_Real angle2);
//! Make a sphere (spherical segment). //! Make a sphere (spherical segment).
//! @param R [in] sphere radius //! @param[in] R sphere radius
//! @param angle1 [in] first angle defining a spherical segment //! @param[in] angle1 first angle defining a spherical segment
//! @param angle2 [in] second angle defining a spherical segment //! @param[in] angle2 second angle defining a spherical segment
//! @param angle3 [in] angle between the radii lying within the bounding semidisks //! @param[in] angle3 angle between the radii lying within the bounding semidisks
Standard_EXPORT BRepPrimAPI_MakeSphere(const Standard_Real R, const Standard_Real angle1, const Standard_Real angle2, const Standard_Real angle3); Standard_EXPORT BRepPrimAPI_MakeSphere(const Standard_Real R, const Standard_Real angle1, const Standard_Real angle2, const Standard_Real angle3);
//! Make a sphere. //! Make a sphere.
//! @param Center [in] sphere center coordinates //! @param[in] Center sphere center coordinates
//! @param R [in] sphere radius //! @param[in] R sphere radius
Standard_EXPORT BRepPrimAPI_MakeSphere(const gp_Pnt& Center, const Standard_Real R); Standard_EXPORT BRepPrimAPI_MakeSphere(const gp_Pnt& Center, const Standard_Real R);
//! Make a sphere (spherical wedge). //! Make a sphere (spherical wedge).
//! @param Center [in] sphere center coordinates //! @param[in] Center sphere center coordinates
//! @param R [in] sphere radius //! @param[in] R sphere radius
//! @param angle [in] angle between the radii lying within the bounding semidisks //! @param[in] angle angle between the radii lying within the bounding semidisks
Standard_EXPORT BRepPrimAPI_MakeSphere(const gp_Pnt& Center, const Standard_Real R, const Standard_Real angle); Standard_EXPORT BRepPrimAPI_MakeSphere(const gp_Pnt& Center, const Standard_Real R, const Standard_Real angle);
//! Make a sphere (spherical segment). //! Make a sphere (spherical segment).
//! @param Center [in] sphere center coordinates //! @param[in] Center sphere center coordinates
//! @param R [in] sphere radius //! @param[in] R sphere radius
//! @param angle1 [in] first angle defining a spherical segment //! @param[in] angle1 first angle defining a spherical segment
//! @param angle2 [in] second angle defining a spherical segment //! @param[in] angle2 second angle defining a spherical segment
Standard_EXPORT BRepPrimAPI_MakeSphere(const gp_Pnt& Center, const Standard_Real R, const Standard_Real angle1, const Standard_Real angle2); Standard_EXPORT BRepPrimAPI_MakeSphere(const gp_Pnt& Center, const Standard_Real R, const Standard_Real angle1, const Standard_Real angle2);
//! Make a sphere (spherical segment). //! Make a sphere (spherical segment).
//! @param Center [in] sphere center coordinates //! @param[in] Center sphere center coordinates
//! @param R [in] sphere radius //! @param[in] R sphere radius
//! @param angle1 [in] first angle defining a spherical segment //! @param[in] angle1 first angle defining a spherical segment
//! @param angle2 [in] second angle defining a spherical segment //! @param[in] angle2 second angle defining a spherical segment
//! @param angle3 [in] angle between the radii lying within the bounding semidisks //! @param[in] angle3 angle between the radii lying within the bounding semidisks
Standard_EXPORT BRepPrimAPI_MakeSphere(const gp_Pnt& Center, const Standard_Real R, const Standard_Real angle1, const Standard_Real angle2, const Standard_Real angle3); Standard_EXPORT BRepPrimAPI_MakeSphere(const gp_Pnt& Center, const Standard_Real R, const Standard_Real angle1, const Standard_Real angle2, const Standard_Real angle3);
//! Make a sphere. //! Make a sphere.
//! @param Axis [in] coordinate system for the construction of the sphere //! @param[in] Axis coordinate system for the construction of the sphere
//! @param R [in] sphere radius //! @param[in] R sphere radius
Standard_EXPORT BRepPrimAPI_MakeSphere(const gp_Ax2& Axis, const Standard_Real R); Standard_EXPORT BRepPrimAPI_MakeSphere(const gp_Ax2& Axis, const Standard_Real R);
//! Make a sphere (spherical wedge). //! Make a sphere (spherical wedge).
//! @param Axis [in] coordinate system for the construction of the sphere //! @param[in] Axis coordinate system for the construction of the sphere
//! @param R [in] sphere radius //! @param[in] R sphere radius
//! @param angle [in] angle between the radii lying within the bounding semidisks //! @param[in] angle angle between the radii lying within the bounding semidisks
Standard_EXPORT BRepPrimAPI_MakeSphere(const gp_Ax2& Axis, const Standard_Real R, const Standard_Real angle); Standard_EXPORT BRepPrimAPI_MakeSphere(const gp_Ax2& Axis, const Standard_Real R, const Standard_Real angle);
//! Make a sphere (spherical segment). //! Make a sphere (spherical segment).
//! @param Axis [in] coordinate system for the construction of the sphere //! @param[in] Axis coordinate system for the construction of the sphere
//! @param R [in] sphere radius //! @param[in] R sphere radius
//! @param angle1 [in] first angle defining a spherical segment //! @param[in] angle1 first angle defining a spherical segment
//! @param angle2 [in] second angle defining a spherical segment //! @param[in] angle2 second angle defining a spherical segment
Standard_EXPORT BRepPrimAPI_MakeSphere(const gp_Ax2& Axis, const Standard_Real R, const Standard_Real angle1, const Standard_Real angle2); Standard_EXPORT BRepPrimAPI_MakeSphere(const gp_Ax2& Axis, const Standard_Real R, const Standard_Real angle1, const Standard_Real angle2);
//! Make a sphere of radius R. //! Make a sphere of radius R.

@ -39,50 +39,50 @@ public:
//! Make a torus. //! Make a torus.
//! @param R1 [in] distance from the center of the pipe to the center of the torus //! @param[in] R1 distance from the center of the pipe to the center of the torus
//! @param R2 [in] radius of the pipe //! @param[in] R2 radius of the pipe
Standard_EXPORT BRepPrimAPI_MakeTorus(const Standard_Real R1, const Standard_Real R2); Standard_EXPORT BRepPrimAPI_MakeTorus(const Standard_Real R1, const Standard_Real R2);
//! Make a section of a torus. //! Make a section of a torus.
//! @param R1 [in] distance from the center of the pipe to the center of the torus //! @param[in] R1 distance from the center of the pipe to the center of the torus
//! @param R2 [in] radius of the pipe //! @param[in] R2 radius of the pipe
//! @param angle [in] angle to create a torus pipe segment //! @param[in] angle angle to create a torus pipe segment
Standard_EXPORT BRepPrimAPI_MakeTorus(const Standard_Real R1, const Standard_Real R2, const Standard_Real angle); Standard_EXPORT BRepPrimAPI_MakeTorus(const Standard_Real R1, const Standard_Real R2, const Standard_Real angle);
//! Make a torus with angles on the small circle. //! Make a torus with angles on the small circle.
//! @param R1 [in] distance from the center of the pipe to the center of the torus //! @param[in] R1 distance from the center of the pipe to the center of the torus
//! @param R2 [in] radius of the pipe //! @param[in] R2 radius of the pipe
//! @param angle1 [in] first angle to create a torus ring segment //! @param[in] angle1 first angle to create a torus ring segment
//! @param angle2 [in] second angle to create a torus ring segment //! @param[in] angle2 second angle to create a torus ring segment
Standard_EXPORT BRepPrimAPI_MakeTorus(const Standard_Real R1, const Standard_Real R2, const Standard_Real angle1, const Standard_Real angle2); Standard_EXPORT BRepPrimAPI_MakeTorus(const Standard_Real R1, const Standard_Real R2, const Standard_Real angle1, const Standard_Real angle2);
//! Make a torus with angles on the small circle. //! Make a torus with angles on the small circle.
//! @param R1 [in] distance from the center of the pipe to the center of the torus //! @param[in] R1 distance from the center of the pipe to the center of the torus
//! @param R2 [in] radius of the pipe //! @param[in] R2 radius of the pipe
//! @param angle1 [in] first angle to create a torus ring segment //! @param[in] angle1 first angle to create a torus ring segment
//! @param angle2 [in] second angle to create a torus ring segment //! @param[in] angle2 second angle to create a torus ring segment
//! @param angle [in] angle to create a torus pipe segment //! @param[in] angle angle to create a torus pipe segment
Standard_EXPORT BRepPrimAPI_MakeTorus(const Standard_Real R1, const Standard_Real R2, const Standard_Real angle1, const Standard_Real angle2, const Standard_Real angle); Standard_EXPORT BRepPrimAPI_MakeTorus(const Standard_Real R1, const Standard_Real R2, const Standard_Real angle1, const Standard_Real angle2, const Standard_Real angle);
//! Make a torus. //! Make a torus.
//! @param Axes [in] coordinate system for the construction of the sphere //! @param[in] Axes coordinate system for the construction of the sphere
//! @param R1 [in] distance from the center of the pipe to the center of the torus //! @param[in] R1 distance from the center of the pipe to the center of the torus
//! @param R2 [in] radius of the pipe //! @param[in] R2 radius of the pipe
Standard_EXPORT BRepPrimAPI_MakeTorus(const gp_Ax2& Axes, const Standard_Real R1, const Standard_Real R2); Standard_EXPORT BRepPrimAPI_MakeTorus(const gp_Ax2& Axes, const Standard_Real R1, const Standard_Real R2);
//! Make a section of a torus. //! Make a section of a torus.
//! @param Axes [in] coordinate system for the construction of the sphere //! @param[in] Axes coordinate system for the construction of the sphere
//! @param R1 [in] distance from the center of the pipe to the center of the torus //! @param[in] R1 distance from the center of the pipe to the center of the torus
//! @param R2 [in] radius of the pipe //! @param[in] R2 radius of the pipe
//! @param angle [in] angle to create a torus pipe segment //! @param[in] angle angle to create a torus pipe segment
Standard_EXPORT BRepPrimAPI_MakeTorus(const gp_Ax2& Axes, const Standard_Real R1, const Standard_Real R2, const Standard_Real angle); Standard_EXPORT BRepPrimAPI_MakeTorus(const gp_Ax2& Axes, const Standard_Real R1, const Standard_Real R2, const Standard_Real angle);
//! Make a torus. //! Make a torus.
//! @param Axes [in] coordinate system for the construction of the sphere //! @param[in] Axes coordinate system for the construction of the sphere
//! @param R1 [in] distance from the center of the pipe to the center of the torus //! @param[in] R1 distance from the center of the pipe to the center of the torus
//! @param R2 [in] radius of the pipe //! @param[in] R2 radius of the pipe
//! @param angle1 [in] first angle to create a torus ring segment //! @param[in] angle1 first angle to create a torus ring segment
//! @param angle2 [in] second angle to create a torus ring segment //! @param[in] angle2 second angle to create a torus ring segment
Standard_EXPORT BRepPrimAPI_MakeTorus(const gp_Ax2& Axes, const Standard_Real R1, const Standard_Real R2, const Standard_Real angle1, const Standard_Real angle2); Standard_EXPORT BRepPrimAPI_MakeTorus(const gp_Ax2& Axes, const Standard_Real R1, const Standard_Real R2, const Standard_Real angle1, const Standard_Real angle2);
//! Make a section of a torus of radii R1 R2. //! Make a section of a torus of radii R1 R2.

@ -144,8 +144,8 @@ public:
//! triangulations and polygons 3d of the edges. //! triangulations and polygons 3d of the edges.
//! In case polygonal representation is the only available representation //! In case polygonal representation is the only available representation
//! for the shape (shape does not have geometry) it is not removed. //! for the shape (shape does not have geometry) it is not removed.
//! @param theShape [in] the shape to clean //! @param[in] theShape the shape to clean
//! @param theForce [in] allows removing all polygonal representations from the shape, //! @param[in] theForce allows removing all polygonal representations from the shape,
//! including polygons on triangulations irrelevant for the faces of the given shape. //! including polygons on triangulations irrelevant for the faces of the given shape.
Standard_EXPORT static void Clean (const TopoDS_Shape& theShape, const Standard_Boolean theForce = Standard_False); Standard_EXPORT static void Clean (const TopoDS_Shape& theShape, const Standard_Boolean theForce = Standard_False);
@ -160,9 +160,9 @@ public:
//! Verifies that each Face from the shape has got a triangulation with a deflection smaller or equal to specified one //! Verifies that each Face from the shape has got a triangulation with a deflection smaller or equal to specified one
//! and the Edges a discretization on this triangulation. //! and the Edges a discretization on this triangulation.
//! @param theShape [in] shape to verify //! @param[in] theShape shape to verify
//! @param theLinDefl [in] maximum allowed linear deflection //! @param[in] theLinDefl maximum allowed linear deflection
//! @param theToCheckFreeEdges [in] if TRUE, then free Edges are required to have 3D polygon //! @param[in] theToCheckFreeEdges if TRUE, then free Edges are required to have 3D polygon
//! @return FALSE if input Shape contains Faces without triangulation, //! @return FALSE if input Shape contains Faces without triangulation,
//! or that triangulation has worse (greater) deflection than specified one, //! or that triangulation has worse (greater) deflection than specified one,
//! or Edges in Shape lack polygons on triangulation //! or Edges in Shape lack polygons on triangulation
@ -173,13 +173,13 @@ public:
//! Loads triangulation data for each face of the shape //! Loads triangulation data for each face of the shape
//! from some deferred storage using specified shared input file system //! from some deferred storage using specified shared input file system
//! @param theShape [in] shape to load triangulations //! @param[in] theShape shape to load triangulations
//! @param theTriangulationIdx [in] index defining what triangulation should be loaded. Starts from 0. //! @param[in] theTriangulationIdx index defining what triangulation should be loaded. Starts from 0.
//! -1 is used in specific case to load currently already active triangulation. //! -1 is used in specific case to load currently already active triangulation.
//! If some face doesn't contain triangulation with this index, nothing will be loaded for it. //! If some face doesn't contain triangulation with this index, nothing will be loaded for it.
//! Exception will be thrown in case of invalid negative index //! Exception will be thrown in case of invalid negative index
//! @param theToSetAsActive [in] flag to activate triangulation after its loading //! @param[in] theToSetAsActive flag to activate triangulation after its loading
//! @param theFileSystem [in] shared file system //! @param[in] theFileSystem shared file system
//! @return TRUE if at least one triangulation is loaded. //! @return TRUE if at least one triangulation is loaded.
Standard_EXPORT static Standard_Boolean LoadTriangulation (const TopoDS_Shape& theShape, Standard_EXPORT static Standard_Boolean LoadTriangulation (const TopoDS_Shape& theShape,
const Standard_Integer theTriangulationIdx = -1, const Standard_Integer theTriangulationIdx = -1,
@ -187,8 +187,8 @@ public:
const Handle(OSD_FileSystem)& theFileSystem = Handle(OSD_FileSystem)()); const Handle(OSD_FileSystem)& theFileSystem = Handle(OSD_FileSystem)());
//! Releases triangulation data for each face of the shape if there is deferred storage to load it later //! Releases triangulation data for each face of the shape if there is deferred storage to load it later
//! @param theShape [in] shape to unload triangulations //! @param[in] theShape shape to unload triangulations
//! @param theTriangulationIdx [in] index defining what triangulation should be unloaded. Starts from 0. //! @param[in] theTriangulationIdx index defining what triangulation should be unloaded. Starts from 0.
//! -1 is used in specific case to unload currently already active triangulation. //! -1 is used in specific case to unload currently already active triangulation.
//! If some face doesn't contain triangulation with this index, nothing will be unloaded for it. //! If some face doesn't contain triangulation with this index, nothing will be unloaded for it.
//! Exception will be thrown in case of invalid negative index //! Exception will be thrown in case of invalid negative index
@ -198,10 +198,10 @@ public:
//! Activates triangulation data for each face of the shape //! Activates triangulation data for each face of the shape
//! from some deferred storage using specified shared input file system //! from some deferred storage using specified shared input file system
//! @param theShape [in] shape to activate triangulations //! @param[in] theShape shape to activate triangulations
//! @param theTriangulationIdx [in] index defining what triangulation should be activated. Starts from 0. //! @param[in] theTriangulationIdx index defining what triangulation should be activated. Starts from 0.
//! Exception will be thrown in case of invalid negative index //! Exception will be thrown in case of invalid negative index
//! @param theToActivateStrictly [in] flag to activate exactly triangulation with defined theTriangulationIdx index. //! @param[in] theToActivateStrictly flag to activate exactly triangulation with defined theTriangulationIdx index.
//! In TRUE case if some face doesn't contain triangulation with this index, active triangulation //! In TRUE case if some face doesn't contain triangulation with this index, active triangulation
//! will not be changed for it. Else the last available triangulation will be activated. //! will not be changed for it. Else the last available triangulation will be activated.
//! @return TRUE if at least one active triangulation was changed. //! @return TRUE if at least one active triangulation was changed.
@ -211,14 +211,14 @@ public:
//! Loads all available triangulations for each face of the shape //! Loads all available triangulations for each face of the shape
//! from some deferred storage using specified shared input file system //! from some deferred storage using specified shared input file system
//! @param theShape [in] shape to load triangulations //! @param[in] theShape shape to load triangulations
//! @param theFileSystem [in] shared file system //! @param[in] theFileSystem shared file system
//! @return TRUE if at least one triangulation is loaded. //! @return TRUE if at least one triangulation is loaded.
Standard_EXPORT static Standard_Boolean LoadAllTriangulations (const TopoDS_Shape& theShape, Standard_EXPORT static Standard_Boolean LoadAllTriangulations (const TopoDS_Shape& theShape,
const Handle(OSD_FileSystem)& theFileSystem = Handle(OSD_FileSystem)()); const Handle(OSD_FileSystem)& theFileSystem = Handle(OSD_FileSystem)());
//! Releases all available triangulations for each face of the shape if there is deferred storage to load them later //! Releases all available triangulations for each face of the shape if there is deferred storage to load them later
//! @param theShape [in] shape to unload triangulations //! @param[in] theShape shape to unload triangulations
//! @return TRUE if at least one triangulation is unloaded. //! @return TRUE if at least one triangulation is unloaded.
Standard_EXPORT static Standard_Boolean UnloadAllTriangulations (const TopoDS_Shape& theShape); Standard_EXPORT static Standard_Boolean UnloadAllTriangulations (const TopoDS_Shape& theShape);
@ -255,8 +255,8 @@ public:
//! Writes the shape to the stream in an ASCII format TopTools_FormatVersion_VERSION_1. //! Writes the shape to the stream in an ASCII format TopTools_FormatVersion_VERSION_1.
//! This alias writes shape with triangulation data. //! This alias writes shape with triangulation data.
//! @param theShape [in] the shape to write //! @param[in] theShape the shape to write
//! @param theStream [in][out] the stream to output shape into //! @param[in][out] theStream the stream to output shape into
//! @param theRange the range of progress indicator to fill in //! @param theRange the range of progress indicator to fill in
static void Write (const TopoDS_Shape& theShape, static void Write (const TopoDS_Shape& theShape,
Standard_OStream& theStream, Standard_OStream& theStream,
@ -267,13 +267,13 @@ public:
} }
//! Writes the shape to the stream in an ASCII format of specified version. //! Writes the shape to the stream in an ASCII format of specified version.
//! @param theShape [in] the shape to write //! @param[in] theShape the shape to write
//! @param theStream [in][out] the stream to output shape into //! @param[in][out] theStream the stream to output shape into
//! @param theWithTriangles [in] flag which specifies whether to save shape with (TRUE) or without (FALSE) triangles; //! @param[in] theWithTriangles flag which specifies whether to save shape with (TRUE) or without (FALSE) triangles;
//! has no effect on triangulation-only geometry //! has no effect on triangulation-only geometry
//! @param theWithNormals [in] flag which specifies whether to save triangulation with (TRUE) or without (FALSE) normals; //! @param[in] theWithNormals flag which specifies whether to save triangulation with (TRUE) or without (FALSE) normals;
//! has no effect on triangulation-only geometry //! has no effect on triangulation-only geometry
//! @param theVersion [in] the TopTools format version //! @param[in] theVersion the TopTools format version
//! @param theProgress the range of progress indicator to fill in //! @param theProgress the range of progress indicator to fill in
Standard_EXPORT static void Write (const TopoDS_Shape& theShape, Standard_EXPORT static void Write (const TopoDS_Shape& theShape,
Standard_OStream& theStream, Standard_OStream& theStream,
@ -289,8 +289,8 @@ public:
//! Writes the shape to the file in an ASCII format TopTools_FormatVersion_VERSION_1. //! Writes the shape to the file in an ASCII format TopTools_FormatVersion_VERSION_1.
//! This alias writes shape with triangulation data. //! This alias writes shape with triangulation data.
//! @param theShape [in] the shape to write //! @param[in] theShape the shape to write
//! @param theFile [in] the path to file to output shape into //! @param[in] theFile the path to file to output shape into
//! @param theProgress the range of progress indicator to fill in //! @param theProgress the range of progress indicator to fill in
static Standard_Boolean Write (const TopoDS_Shape& theShape, static Standard_Boolean Write (const TopoDS_Shape& theShape,
const Standard_CString theFile, const Standard_CString theFile,
@ -301,13 +301,13 @@ public:
} }
//! Writes the shape to the file in an ASCII format of specified version. //! Writes the shape to the file in an ASCII format of specified version.
//! @param theShape [in] the shape to write //! @param[in] theShape the shape to write
//! @param theFile [in] the path to file to output shape into //! @param[in] theFile the path to file to output shape into
//! @param theWithTriangles [in] flag which specifies whether to save shape with (TRUE) or without (FALSE) triangles; //! @param[in] theWithTriangles flag which specifies whether to save shape with (TRUE) or without (FALSE) triangles;
//! has no effect on triangulation-only geometry //! has no effect on triangulation-only geometry
//! @param theWithNormals [in] flag which specifies whether to save triangulation with (TRUE) or without (FALSE) normals; //! @param[in] theWithNormals flag which specifies whether to save triangulation with (TRUE) or without (FALSE) normals;
//! has no effect on triangulation-only geometry //! has no effect on triangulation-only geometry
//! @param theVersion [in] the TopTools format version //! @param[in] theVersion the TopTools format version
//! @param theProgress the range of progress indicator to fill in //! @param theProgress the range of progress indicator to fill in
Standard_EXPORT static Standard_Boolean Write (const TopoDS_Shape& theShape, Standard_EXPORT static Standard_Boolean Write (const TopoDS_Shape& theShape,
const Standard_CString theFile, const Standard_CString theFile,

@ -95,8 +95,8 @@ public: //! @name Constructors for History creation
//! Template constructor for History creation from the algorithm having //! Template constructor for History creation from the algorithm having
//! standard history methods such as IsDeleted(), Modified() and Generated(). //! standard history methods such as IsDeleted(), Modified() and Generated().
//! @param theArguments [in] Arguments of the algorithm; //! @param[in] theArguments Arguments of the algorithm;
//! @param theAlgo [in] The algorithm. //! @param[in] theAlgo The algorithm.
template <class TheAlgo> template <class TheAlgo>
BRepTools_History(const TopTools_ListOfShape& theArguments, BRepTools_History(const TopTools_ListOfShape& theArguments,
TheAlgo& theAlgo) TheAlgo& theAlgo)
@ -216,8 +216,8 @@ public: //! A method to merge a next history to this history.
//! Template method for merging history of the algorithm having standard //! Template method for merging history of the algorithm having standard
//! history methods such as IsDeleted(), Modified() and Generated() //! history methods such as IsDeleted(), Modified() and Generated()
//! into current history object. //! into current history object.
//! @param theArguments [in] Arguments of the algorithm; //! @param[in] theArguments Arguments of the algorithm;
//! @param theAlgo [in] The algorithm. //! @param[in] theAlgo The algorithm.
template<class TheAlgo> template<class TheAlgo>
void Merge(const TopTools_ListOfShape& theArguments, void Merge(const TopTools_ListOfShape& theArguments,
TheAlgo& theAlgo) TheAlgo& theAlgo)

@ -56,8 +56,8 @@ public:
//! Writes the shape to the stream in binary format BinTools_FormatVersion_CURRENT. //! Writes the shape to the stream in binary format BinTools_FormatVersion_CURRENT.
//! This alias writes shape with triangulation data. //! This alias writes shape with triangulation data.
//! @param theShape [in] the shape to write //! @param[in] theShape the shape to write
//! @param theStream [in][out] the stream to output shape into //! @param[in][out] theStream the stream to output shape into
//! @param theRange the range of progress indicator to fill in //! @param theRange the range of progress indicator to fill in
static void Write (const TopoDS_Shape& theShape, static void Write (const TopoDS_Shape& theShape,
Standard_OStream& theStream, Standard_OStream& theStream,
@ -68,13 +68,13 @@ public:
} }
//! Writes the shape to the stream in binary format of specified version. //! Writes the shape to the stream in binary format of specified version.
//! @param theShape [in] the shape to write //! @param[in] theShape the shape to write
//! @param theStream [in][out] the stream to output shape into //! @param[in][out] theStream the stream to output shape into
//! @param theWithTriangles [in] flag which specifies whether to save shape with (TRUE) or without (FALSE) triangles; //! @param[in] theWithTriangles flag which specifies whether to save shape with (TRUE) or without (FALSE) triangles;
//! has no effect on triangulation-only geometry //! has no effect on triangulation-only geometry
//! @param theWithNormals [in] flag which specifies whether to save triangulation with (TRUE) or without (FALSE) normals; //! @param[in] theWithNormals flag which specifies whether to save triangulation with (TRUE) or without (FALSE) normals;
//! has no effect on triangulation-only geometry //! has no effect on triangulation-only geometry
//! @param theVersion [in] the BinTools format version //! @param[in] theVersion the BinTools format version
//! @param theRange the range of progress indicator to fill in //! @param theRange the range of progress indicator to fill in
Standard_EXPORT static void Write(const TopoDS_Shape& theShape, Standard_OStream& theStream, Standard_EXPORT static void Write(const TopoDS_Shape& theShape, Standard_OStream& theStream,
const Standard_Boolean theWithTriangles, const Standard_Boolean theWithTriangles,
@ -87,8 +87,8 @@ public:
const Message_ProgressRange& theRange = Message_ProgressRange()); const Message_ProgressRange& theRange = Message_ProgressRange());
//! Writes the shape to the file in binary format BinTools_FormatVersion_CURRENT. //! Writes the shape to the file in binary format BinTools_FormatVersion_CURRENT.
//! @param theShape [in] the shape to write //! @param[in] theShape the shape to write
//! @param theFile [in] the path to file to output shape into //! @param[in] theFile the path to file to output shape into
//! @param theRange the range of progress indicator to fill in //! @param theRange the range of progress indicator to fill in
static Standard_Boolean Write (const TopoDS_Shape& theShape, static Standard_Boolean Write (const TopoDS_Shape& theShape,
const Standard_CString theFile, const Standard_CString theFile,
@ -99,13 +99,13 @@ public:
} }
//! Writes the shape to the file in binary format of specified version. //! Writes the shape to the file in binary format of specified version.
//! @param theShape [in] the shape to write //! @param[in] theShape the shape to write
//! @param theFile [in] the path to file to output shape into //! @param[in] theFile the path to file to output shape into
//! @param theWithTriangles [in] flag which specifies whether to save shape with (TRUE) or without (FALSE) triangles; //! @param[in] theWithTriangles flag which specifies whether to save shape with (TRUE) or without (FALSE) triangles;
//! has no effect on triangulation-only geometry //! has no effect on triangulation-only geometry
//! @param theWithNormals [in] flag which specifies whether to save triangulation with (TRUE) or without (FALSE) normals; //! @param[in] theWithNormals flag which specifies whether to save triangulation with (TRUE) or without (FALSE) normals;
//! has no effect on triangulation-only geometry //! has no effect on triangulation-only geometry
//! @param theVersion [in] the BinTools format version //! @param[in] theVersion the BinTools format version
//! @param theRange the range of progress indicator to fill in //! @param theRange the range of progress indicator to fill in
Standard_EXPORT static Standard_Boolean Write (const TopoDS_Shape& theShape, Standard_EXPORT static Standard_Boolean Write (const TopoDS_Shape& theShape,
const Standard_CString theFile, const Standard_CString theFile,

@ -37,7 +37,7 @@ public:
DEFINE_STANDARD_ALLOC DEFINE_STANDARD_ALLOC
//! Builds an empty ShapeSet. //! Builds an empty ShapeSet.
//! @param theWithTriangles [in] flag to write triangulation data //! @param[in] theWithTriangles flag to write triangulation data
Standard_EXPORT BinTools_ShapeSet (); Standard_EXPORT BinTools_ShapeSet ();
Standard_EXPORT virtual ~BinTools_ShapeSet(); Standard_EXPORT virtual ~BinTools_ShapeSet();

@ -41,18 +41,18 @@ public:
Standard_EXPORT static void Set (const Standard_CString Name, const TopoDS_Shape& S); Standard_EXPORT static void Set (const Standard_CString Name, const TopoDS_Shape& S);
//! Returns the shape in the variable. //! Returns the shape in the variable.
//! @param theName [in] [out] variable name, or "." to pick up shape interactively (the picked name will be returned then) //! @param[in][out] theName variable name, or "." to pick up shape interactively (the picked name will be returned then)
//! @param theType [in] shape type filter; function will return NULL if shape has different type //! @param[in] theType shape type filter; function will return NULL if shape has different type
//! @param theToComplain [in] when TRUE, prints a message on cout if the variable is not set //! @param[in] theToComplain when TRUE, prints a message on cout if the variable is not set
static TopoDS_Shape Get (Standard_CString& theName, TopAbs_ShapeEnum theType = TopAbs_SHAPE, Standard_Boolean theToComplain = Standard_False) static TopoDS_Shape Get (Standard_CString& theName, TopAbs_ShapeEnum theType = TopAbs_SHAPE, Standard_Boolean theToComplain = Standard_False)
{ {
return getShape (theName, theType, theToComplain); return getShape (theName, theType, theToComplain);
} }
//! Returns the shape in the variable. //! Returns the shape in the variable.
//! @param theName [in] [out] variable name, or "." to pick up shape interactively (the picked name will be returned then) //! @param[in][out] theName variable name, or "." to pick up shape interactively (the picked name will be returned then)
//! @param theType [in] shape type filter; function will return NULL if shape has different type //! @param[in] theType shape type filter; function will return NULL if shape has different type
//! @param theToComplain [in] when TRUE, prints a message on cout if the variable is not set //! @param[in] theToComplain when TRUE, prints a message on cout if the variable is not set
static TopoDS_Shape Get (TCollection_AsciiString& theName, TopAbs_ShapeEnum theType = TopAbs_SHAPE, Standard_Boolean theToComplain = Standard_False) static TopoDS_Shape Get (TCollection_AsciiString& theName, TopAbs_ShapeEnum theType = TopAbs_SHAPE, Standard_Boolean theToComplain = Standard_False)
{ {
Standard_CString aNamePtr = theName.ToCString(); Standard_CString aNamePtr = theName.ToCString();
@ -65,9 +65,9 @@ public:
} }
//! Returns the shape in the variable. //! Returns the shape in the variable.
//! @param theName [in] variable name //! @param[in] theName variable name
//! @param theType [in] shape type filter; function will return NULL if shape has different type //! @param[in] theType shape type filter; function will return NULL if shape has different type
//! @param theToComplain [in] when TRUE, prints a message on cout if the variable is not set //! @param[in] theToComplain when TRUE, prints a message on cout if the variable is not set
static TopoDS_Shape GetExisting (const TCollection_AsciiString& theName, TopAbs_ShapeEnum theType = TopAbs_SHAPE, Standard_Boolean theToComplain = Standard_False) static TopoDS_Shape GetExisting (const TCollection_AsciiString& theName, TopAbs_ShapeEnum theType = TopAbs_SHAPE, Standard_Boolean theToComplain = Standard_False)
{ {
if (theName.Length() == 1 if (theName.Length() == 1
@ -110,9 +110,9 @@ public:
protected: protected:
//! Returns the shape in the variable. //! Returns the shape in the variable.
//! @param theName [in] [out] variable name, or "." to pick up shape interactively (the picked name will be returned then) //! @param[in][out] theName variable name, or "." to pick up shape interactively (the picked name will be returned then)
//! @param theType [in] shape type filter; function will return NULL if shape has different type //! @param[in] theType shape type filter; function will return NULL if shape has different type
//! @param theToComplain [in] when TRUE, prints a message on cout if the variable is not set //! @param[in] theToComplain when TRUE, prints a message on cout if the variable is not set
Standard_EXPORT static TopoDS_Shape getShape (Standard_CString& theName, Standard_EXPORT static TopoDS_Shape getShape (Standard_CString& theName,
TopAbs_ShapeEnum theType, TopAbs_ShapeEnum theType,
Standard_Boolean theToComplain); Standard_Boolean theToComplain);

@ -101,28 +101,28 @@ public:
public: public:
//! Auxiliary method computing nodal normals for presentation purposes. //! Auxiliary method computing nodal normals for presentation purposes.
//! @param theNormals [out] vector of computed normals (pair of points [from, to]) //! @param[out] theNormals vector of computed normals (pair of points [from, to])
//! @param theFace [in] input face //! @param[in] theFace input face
//! @param theLength [in] normal length //! @param[in] theLength normal length
//! @return FALSE if normals can not be computed //! @return FALSE if normals can not be computed
Standard_EXPORT static Standard_Boolean addMeshNormals (NCollection_Vector<std::pair<gp_Pnt, gp_Pnt> >& theNormals, Standard_EXPORT static Standard_Boolean addMeshNormals (NCollection_Vector<std::pair<gp_Pnt, gp_Pnt> >& theNormals,
const TopoDS_Face& theFace, const TopoDS_Face& theFace,
const Standard_Real theLength); const Standard_Real theLength);
//! Auxiliary method computing nodal normals for presentation purposes. //! Auxiliary method computing nodal normals for presentation purposes.
//! @param theNormals [out] map of computed normals (grouped per Face) //! @param[out] theNormals map of computed normals (grouped per Face)
//! @param theShape [in] input shape which will be exploded into Faces //! @param[in] theShape input shape which will be exploded into Faces
//! @param theLength [in] normal length //! @param[in] theLength normal length
Standard_EXPORT static void addMeshNormals (NCollection_DataMap<TopoDS_Face, NCollection_Vector<std::pair<gp_Pnt, gp_Pnt> > > & theNormals, Standard_EXPORT static void addMeshNormals (NCollection_DataMap<TopoDS_Face, NCollection_Vector<std::pair<gp_Pnt, gp_Pnt> > > & theNormals,
const TopoDS_Shape& theShape, const TopoDS_Shape& theShape,
const Standard_Real theLength); const Standard_Real theLength);
//! Auxiliary method computing surface normals distributed within the Face for presentation purposes. //! Auxiliary method computing surface normals distributed within the Face for presentation purposes.
//! @param theNormals [out] vector of computed normals (pair of points [from, to]) //! @param[out] theNormals vector of computed normals (pair of points [from, to])
//! @param theFace [in] input face //! @param[in] theFace input face
//! @param theLength [in] normal length //! @param[in] theLength normal length
//! @param theNbAlongU [in] number along U //! @param[in] theNbAlongU number along U
//! @param theNbAlongV [in] number along V //! @param[in] theNbAlongV number along V
//! @return FALSE if normals can not be computed //! @return FALSE if normals can not be computed
Standard_EXPORT static Standard_Boolean addSurfaceNormals (NCollection_Vector<std::pair<gp_Pnt, gp_Pnt> >& theNormals, Standard_EXPORT static Standard_Boolean addSurfaceNormals (NCollection_Vector<std::pair<gp_Pnt, gp_Pnt> >& theNormals,
const TopoDS_Face& theFace, const TopoDS_Face& theFace,
@ -131,11 +131,11 @@ public:
const Standard_Integer theNbAlongV); const Standard_Integer theNbAlongV);
//! Auxiliary method computing surface normals distributed within the Face for presentation purposes. //! Auxiliary method computing surface normals distributed within the Face for presentation purposes.
//! @param theNormals [out] map of computed normals (grouped per Face) //! @param[out] theNormals map of computed normals (grouped per Face)
//! @param theShape [in] input shape which will be exploded into Faces //! @param[in] theShape input shape which will be exploded into Faces
//! @param theLength [in] normal length //! @param[in] theLength normal length
//! @param theNbAlongU [in] number along U //! @param[in] theNbAlongU number along U
//! @param theNbAlongV [in] number along V //! @param[in] theNbAlongV number along V
//! @return FALSE if normals can not be computed //! @return FALSE if normals can not be computed
Standard_EXPORT static void addSurfaceNormals (NCollection_DataMap<TopoDS_Face, NCollection_Vector<std::pair<gp_Pnt, gp_Pnt> > >& theNormals, Standard_EXPORT static void addSurfaceNormals (NCollection_DataMap<TopoDS_Face, NCollection_Vector<std::pair<gp_Pnt, gp_Pnt> > >& theNormals,
const TopoDS_Shape& theShape, const TopoDS_Shape& theShape,

@ -59,7 +59,7 @@ public:
//! @param[in] thePath path to the import CAD file //! @param[in] thePath path to the import CAD file
//! @param[out] theDocument document to save result //! @param[out] theDocument document to save result
//! @param[in] theWS current work session //! @param[in] theWS current work session
//! @param theProgress[in] progress indicator //! @param[in] theProgress progress indicator
//! @return True if Read was successful //! @return True if Read was successful
Standard_EXPORT virtual Standard_Boolean Read(const TCollection_AsciiString& thePath, Standard_EXPORT virtual Standard_Boolean Read(const TCollection_AsciiString& thePath,
const Handle(TDocStd_Document)& theDocument, const Handle(TDocStd_Document)& theDocument,
@ -70,7 +70,7 @@ public:
//! @param[in] thePath path to the export CAD file //! @param[in] thePath path to the export CAD file
//! @param[out] theDocument document to export //! @param[out] theDocument document to export
//! @param[in] theWS current work session //! @param[in] theWS current work session
//! @param theProgress[in] progress indicator //! @param[in] theProgress progress indicator
//! @return True if Write was successful //! @return True if Write was successful
Standard_EXPORT virtual Standard_Boolean Write(const TCollection_AsciiString& thePath, Standard_EXPORT virtual Standard_Boolean Write(const TCollection_AsciiString& thePath,
const Handle(TDocStd_Document)& theDocument, const Handle(TDocStd_Document)& theDocument,
@ -80,7 +80,7 @@ public:
//! Reads a CAD file, according internal configuration //! Reads a CAD file, according internal configuration
//! @param[in] thePath path to the import CAD file //! @param[in] thePath path to the import CAD file
//! @param[out] theDocument document to save result //! @param[out] theDocument document to save result
//! @param theProgress[in] progress indicator //! @param[in] theProgress progress indicator
//! @return True if Read was successful //! @return True if Read was successful
Standard_EXPORT virtual Standard_Boolean Read(const TCollection_AsciiString& thePath, Standard_EXPORT virtual Standard_Boolean Read(const TCollection_AsciiString& thePath,
const Handle(TDocStd_Document)& theDocument, const Handle(TDocStd_Document)& theDocument,
@ -89,7 +89,7 @@ public:
//! Writes a CAD file, according internal configuration //! Writes a CAD file, according internal configuration
//! @param[in] thePath path to the export CAD file //! @param[in] thePath path to the export CAD file
//! @param[out] theDocument document to export //! @param[out] theDocument document to export
//! @param theProgress[in] progress indicator //! @param[in] theProgress progress indicator
//! @return True if Write was successful //! @return True if Write was successful
Standard_EXPORT virtual Standard_Boolean Write(const TCollection_AsciiString& thePath, Standard_EXPORT virtual Standard_Boolean Write(const TCollection_AsciiString& thePath,
const Handle(TDocStd_Document)& theDocument, const Handle(TDocStd_Document)& theDocument,
@ -99,7 +99,7 @@ public:
//! @param[in] thePath path to the import CAD file //! @param[in] thePath path to the import CAD file
//! @param[out] theShape shape to save result //! @param[out] theShape shape to save result
//! @param[in] theWS current work session //! @param[in] theWS current work session
//! @param theProgress[in] progress indicator //! @param[in] theProgress progress indicator
//! @return True if Read was successful //! @return True if Read was successful
Standard_EXPORT virtual Standard_Boolean Read(const TCollection_AsciiString& thePath, Standard_EXPORT virtual Standard_Boolean Read(const TCollection_AsciiString& thePath,
TopoDS_Shape& theShape, TopoDS_Shape& theShape,
@ -110,7 +110,7 @@ public:
//! @param[in] thePath path to the export CAD file //! @param[in] thePath path to the export CAD file
//! @param[out] theShape shape to export //! @param[out] theShape shape to export
//! @param[in] theWS current work session //! @param[in] theWS current work session
//! @param theProgress[in] progress indicator //! @param[in] theProgress progress indicator
//! @return True if Write was successful //! @return True if Write was successful
Standard_EXPORT virtual Standard_Boolean Write(const TCollection_AsciiString& thePath, Standard_EXPORT virtual Standard_Boolean Write(const TCollection_AsciiString& thePath,
const TopoDS_Shape& theShape, const TopoDS_Shape& theShape,
@ -120,7 +120,7 @@ public:
//! Reads a CAD file, according internal configuration //! Reads a CAD file, according internal configuration
//! @param[in] thePath path to the import CAD file //! @param[in] thePath path to the import CAD file
//! @param[out] theShape shape to save result //! @param[out] theShape shape to save result
//! @param theProgress[in] progress indicator //! @param[in] theProgress progress indicator
//! @return True if Read was successful //! @return True if Read was successful
Standard_EXPORT virtual Standard_Boolean Read(const TCollection_AsciiString& thePath, Standard_EXPORT virtual Standard_Boolean Read(const TCollection_AsciiString& thePath,
TopoDS_Shape& theShape, TopoDS_Shape& theShape,
@ -129,7 +129,7 @@ public:
//! Writes a CAD file, according internal configuration //! Writes a CAD file, according internal configuration
//! @param[in] thePath path to the export CAD file //! @param[in] thePath path to the export CAD file
//! @param[out] theShape shape to export //! @param[out] theShape shape to export
//! @param theProgress[in] progress indicator //! @param[in] theProgress progress indicator
//! @return True if Write was successful //! @return True if Write was successful
Standard_EXPORT virtual Standard_Boolean Write(const TCollection_AsciiString& thePath, Standard_EXPORT virtual Standard_Boolean Write(const TCollection_AsciiString& thePath,
const TopoDS_Shape& theShape, const TopoDS_Shape& theShape,

@ -79,7 +79,7 @@ public:
//! @param[in] thePath path to the import CAD file //! @param[in] thePath path to the import CAD file
//! @param[out] theDocument document to save result //! @param[out] theDocument document to save result
//! @param[in] theWS current work session //! @param[in] theWS current work session
//! @param theProgress[in] progress indicator //! @param[in] theProgress progress indicator
//! @return true if Read operation has ended correctly //! @return true if Read operation has ended correctly
Standard_EXPORT Standard_Boolean Read(const TCollection_AsciiString& thePath, Standard_EXPORT Standard_Boolean Read(const TCollection_AsciiString& thePath,
const Handle(TDocStd_Document)& theDocument, const Handle(TDocStd_Document)& theDocument,
@ -90,7 +90,7 @@ public:
//! @param[in] thePath path to the export CAD file //! @param[in] thePath path to the export CAD file
//! @param[out] theDocument document to export //! @param[out] theDocument document to export
//! @param[in] theWS current work session //! @param[in] theWS current work session
//! @param theProgress[in] progress indicator //! @param[in] theProgress progress indicator
//! @return true if Write operation has ended correctly //! @return true if Write operation has ended correctly
Standard_EXPORT Standard_Boolean Write(const TCollection_AsciiString& thePath, Standard_EXPORT Standard_Boolean Write(const TCollection_AsciiString& thePath,
const Handle(TDocStd_Document)& theDocument, const Handle(TDocStd_Document)& theDocument,
@ -100,7 +100,7 @@ public:
//! Reads a CAD file, according internal configuration //! Reads a CAD file, according internal configuration
//! @param[in] thePath path to the import CAD file //! @param[in] thePath path to the import CAD file
//! @param[out] theDocument document to save result //! @param[out] theDocument document to save result
//! @param theProgress[in] progress indicator //! @param[in] theProgress progress indicator
//! @return true if Read operation has ended correctly //! @return true if Read operation has ended correctly
Standard_EXPORT Standard_Boolean Read(const TCollection_AsciiString& thePath, Standard_EXPORT Standard_Boolean Read(const TCollection_AsciiString& thePath,
const Handle(TDocStd_Document)& theDocument, const Handle(TDocStd_Document)& theDocument,
@ -109,7 +109,7 @@ public:
//! Writes a CAD file, according internal configuration //! Writes a CAD file, according internal configuration
//! @param[in] thePath path to the export CAD file //! @param[in] thePath path to the export CAD file
//! @param[out] theDocument document to export //! @param[out] theDocument document to export
//! @param theProgress[in] progress indicator //! @param[in] theProgress progress indicator
//! @return true if Write operation has ended correctly //! @return true if Write operation has ended correctly
Standard_EXPORT Standard_Boolean Write(const TCollection_AsciiString& thePath, Standard_EXPORT Standard_Boolean Write(const TCollection_AsciiString& thePath,
const Handle(TDocStd_Document)& theDocument, const Handle(TDocStd_Document)& theDocument,
@ -119,7 +119,7 @@ public:
//! @param[in] thePath path to the import CAD file //! @param[in] thePath path to the import CAD file
//! @param[out] theShape shape to save result //! @param[out] theShape shape to save result
//! @param[in] theWS current work session //! @param[in] theWS current work session
//! @param theProgress[in] progress indicator //! @param[in] theProgress progress indicator
//! @return true if Read operation has ended correctly //! @return true if Read operation has ended correctly
Standard_EXPORT Standard_Boolean Read(const TCollection_AsciiString& thePath, Standard_EXPORT Standard_Boolean Read(const TCollection_AsciiString& thePath,
TopoDS_Shape& theShape, TopoDS_Shape& theShape,
@ -130,7 +130,7 @@ public:
//! @param[in] thePath path to the export CAD file //! @param[in] thePath path to the export CAD file
//! @param[out] theShape shape to export //! @param[out] theShape shape to export
//! @param[in] theWS current work session //! @param[in] theWS current work session
//! @param theProgress[in] progress indicator //! @param[in] theProgress progress indicator
//! @return true if Write operation has ended correctly //! @return true if Write operation has ended correctly
Standard_EXPORT Standard_Boolean Write(const TCollection_AsciiString& thePath, Standard_EXPORT Standard_Boolean Write(const TCollection_AsciiString& thePath,
const TopoDS_Shape& theShape, const TopoDS_Shape& theShape,
@ -140,7 +140,7 @@ public:
//! Reads a CAD file, according internal configuration //! Reads a CAD file, according internal configuration
//! @param[in] thePath path to the import CAD file //! @param[in] thePath path to the import CAD file
//! @param[out] theShape shape to save result //! @param[out] theShape shape to save result
//! @param theProgress[in] progress indicator //! @param[in] theProgress progress indicator
//! @return true if Read operation has ended correctly //! @return true if Read operation has ended correctly
Standard_EXPORT Standard_Boolean Read(const TCollection_AsciiString& thePath, Standard_EXPORT Standard_Boolean Read(const TCollection_AsciiString& thePath,
TopoDS_Shape& theShape, TopoDS_Shape& theShape,
@ -149,7 +149,7 @@ public:
//! Writes a CAD file, according internal configuration //! Writes a CAD file, according internal configuration
//! @param[in] thePath path to the export CAD file //! @param[in] thePath path to the export CAD file
//! @param[out] theShape shape to export //! @param[out] theShape shape to export
//! @param theProgress[in] progress indicator //! @param[in] theProgress progress indicator
//! @return true if Write operation has ended correctly //! @return true if Write operation has ended correctly
Standard_EXPORT Standard_Boolean Write(const TCollection_AsciiString& thePath, Standard_EXPORT Standard_Boolean Write(const TCollection_AsciiString& thePath,
const TopoDS_Shape& theShape, const TopoDS_Shape& theShape,

@ -46,7 +46,7 @@ public:
//! @param[in] thePath path to the import CAD file //! @param[in] thePath path to the import CAD file
//! @param[out] theDocument document to save result //! @param[out] theDocument document to save result
//! @param[in] theWS current work session //! @param[in] theWS current work session
//! @param theProgress[in] progress indicator //! @param[in] theProgress progress indicator
//! @return true if Read operation has ended correctly //! @return true if Read operation has ended correctly
Standard_EXPORT virtual bool Read(const TCollection_AsciiString& thePath, Standard_EXPORT virtual bool Read(const TCollection_AsciiString& thePath,
const Handle(TDocStd_Document)& theDocument, const Handle(TDocStd_Document)& theDocument,
@ -57,7 +57,7 @@ public:
//! @param[in] thePath path to the export CAD file //! @param[in] thePath path to the export CAD file
//! @param[out] theDocument document to export //! @param[out] theDocument document to export
//! @param[in] theWS current work session //! @param[in] theWS current work session
//! @param theProgress[in] progress indicator //! @param[in] theProgress progress indicator
//! @return true if Write operation has ended correctly //! @return true if Write operation has ended correctly
Standard_EXPORT virtual bool Write(const TCollection_AsciiString& thePath, Standard_EXPORT virtual bool Write(const TCollection_AsciiString& thePath,
const Handle(TDocStd_Document)& theDocument, const Handle(TDocStd_Document)& theDocument,
@ -67,7 +67,7 @@ public:
//! Reads a CAD file, according internal configuration //! Reads a CAD file, according internal configuration
//! @param[in] thePath path to the import CAD file //! @param[in] thePath path to the import CAD file
//! @param[out] theDocument document to save result //! @param[out] theDocument document to save result
//! @param theProgress[in] progress indicator //! @param[in] theProgress progress indicator
//! @return true if Read operation has ended correctly //! @return true if Read operation has ended correctly
Standard_EXPORT virtual bool Read(const TCollection_AsciiString& thePath, Standard_EXPORT virtual bool Read(const TCollection_AsciiString& thePath,
const Handle(TDocStd_Document)& theDocument, const Handle(TDocStd_Document)& theDocument,
@ -76,7 +76,7 @@ public:
//! Writes a CAD file, according internal configuration //! Writes a CAD file, according internal configuration
//! @param[in] thePath path to the export CAD file //! @param[in] thePath path to the export CAD file
//! @param[out] theDocument document to export //! @param[out] theDocument document to export
//! @param theProgress[in] progress indicator //! @param[in] theProgress progress indicator
//! @return true if Write operation has ended correctly //! @return true if Write operation has ended correctly
Standard_EXPORT virtual bool Write(const TCollection_AsciiString& thePath, Standard_EXPORT virtual bool Write(const TCollection_AsciiString& thePath,
const Handle(TDocStd_Document)& theDocument, const Handle(TDocStd_Document)& theDocument,
@ -86,7 +86,7 @@ public:
//! @param[in] thePath path to the import CAD file //! @param[in] thePath path to the import CAD file
//! @param[out] theShape shape to save result //! @param[out] theShape shape to save result
//! @param[in] theWS current work session //! @param[in] theWS current work session
//! @param theProgress[in] progress indicator //! @param[in] theProgress progress indicator
//! @return true if Read operation has ended correctly //! @return true if Read operation has ended correctly
Standard_EXPORT virtual bool Read(const TCollection_AsciiString& thePath, Standard_EXPORT virtual bool Read(const TCollection_AsciiString& thePath,
TopoDS_Shape& theShape, TopoDS_Shape& theShape,
@ -97,7 +97,7 @@ public:
//! @param[in] thePath path to the export CAD file //! @param[in] thePath path to the export CAD file
//! @param[out] theShape shape to export //! @param[out] theShape shape to export
//! @param[in] theWS current work session //! @param[in] theWS current work session
//! @param theProgress[in] progress indicator //! @param[in] theProgress progress indicator
//! @return true if Write operation has ended correctly //! @return true if Write operation has ended correctly
Standard_EXPORT virtual bool Write(const TCollection_AsciiString& thePath, Standard_EXPORT virtual bool Write(const TCollection_AsciiString& thePath,
const TopoDS_Shape& theShape, const TopoDS_Shape& theShape,
@ -107,7 +107,7 @@ public:
//! Reads a CAD file, according internal configuration //! Reads a CAD file, according internal configuration
//! @param[in] thePath path to the import CAD file //! @param[in] thePath path to the import CAD file
//! @param[out] theShape shape to save result //! @param[out] theShape shape to save result
//! @param theProgress[in] progress indicator //! @param[in] theProgress progress indicator
//! @return true if Read operation has ended correctly //! @return true if Read operation has ended correctly
Standard_EXPORT virtual bool Read(const TCollection_AsciiString& thePath, Standard_EXPORT virtual bool Read(const TCollection_AsciiString& thePath,
TopoDS_Shape& theShape, TopoDS_Shape& theShape,
@ -116,7 +116,7 @@ public:
//! Writes a CAD file, according internal configuration //! Writes a CAD file, according internal configuration
//! @param[in] thePath path to the export CAD file //! @param[in] thePath path to the export CAD file
//! @param[out] theShape shape to export //! @param[out] theShape shape to export
//! @param theProgress[in] progress indicator //! @param[in] theProgress progress indicator
//! @return true if Write operation has ended correctly //! @return true if Write operation has ended correctly
Standard_EXPORT virtual bool Write(const TCollection_AsciiString& thePath, Standard_EXPORT virtual bool Write(const TCollection_AsciiString& thePath,
const TopoDS_Shape& theShape, const TopoDS_Shape& theShape,

@ -46,7 +46,7 @@ public:
//! @param[in] thePath path to the import CAD file //! @param[in] thePath path to the import CAD file
//! @param[out] theDocument document to save result //! @param[out] theDocument document to save result
//! @param[in] theWS current work session //! @param[in] theWS current work session
//! @param theProgress[in] progress indicator //! @param[in] theProgress progress indicator
//! @return true if Read operation has ended correctly //! @return true if Read operation has ended correctly
Standard_EXPORT virtual bool Read(const TCollection_AsciiString& thePath, Standard_EXPORT virtual bool Read(const TCollection_AsciiString& thePath,
const Handle(TDocStd_Document)& theDocument, const Handle(TDocStd_Document)& theDocument,
@ -57,7 +57,7 @@ public:
//! @param[in] thePath path to the export CAD file //! @param[in] thePath path to the export CAD file
//! @param[out] theDocument document to export //! @param[out] theDocument document to export
//! @param[in] theWS current work session //! @param[in] theWS current work session
//! @param theProgress[in] progress indicator //! @param[in] theProgress progress indicator
//! @return true if Write operation has ended correctly //! @return true if Write operation has ended correctly
Standard_EXPORT virtual bool Write(const TCollection_AsciiString& thePath, Standard_EXPORT virtual bool Write(const TCollection_AsciiString& thePath,
const Handle(TDocStd_Document)& theDocument, const Handle(TDocStd_Document)& theDocument,
@ -67,7 +67,7 @@ public:
//! Reads a CAD file, according internal configuration //! Reads a CAD file, according internal configuration
//! @param[in] thePath path to the import CAD file //! @param[in] thePath path to the import CAD file
//! @param[out] theDocument document to save result //! @param[out] theDocument document to save result
//! @param theProgress[in] progress indicator //! @param[in] theProgress progress indicator
//! @return true if Read operation has ended correctly //! @return true if Read operation has ended correctly
Standard_EXPORT virtual bool Read(const TCollection_AsciiString& thePath, Standard_EXPORT virtual bool Read(const TCollection_AsciiString& thePath,
const Handle(TDocStd_Document)& theDocument, const Handle(TDocStd_Document)& theDocument,
@ -76,7 +76,7 @@ public:
//! Writes a CAD file, according internal configuration //! Writes a CAD file, according internal configuration
//! @param[in] thePath path to the export CAD file //! @param[in] thePath path to the export CAD file
//! @param[out] theDocument document to export //! @param[out] theDocument document to export
//! @param theProgress[in] progress indicator //! @param[in] theProgress progress indicator
//! @return true if Write operation has ended correctly //! @return true if Write operation has ended correctly
Standard_EXPORT virtual bool Write(const TCollection_AsciiString& thePath, Standard_EXPORT virtual bool Write(const TCollection_AsciiString& thePath,
const Handle(TDocStd_Document)& theDocument, const Handle(TDocStd_Document)& theDocument,
@ -86,7 +86,7 @@ public:
//! @param[in] thePath path to the import CAD file //! @param[in] thePath path to the import CAD file
//! @param[out] theShape shape to save result //! @param[out] theShape shape to save result
//! @param[in] theWS current work session //! @param[in] theWS current work session
//! @param theProgress[in] progress indicator //! @param[in] theProgress progress indicator
//! @return true if Read operation has ended correctly //! @return true if Read operation has ended correctly
Standard_EXPORT virtual bool Read(const TCollection_AsciiString& thePath, Standard_EXPORT virtual bool Read(const TCollection_AsciiString& thePath,
TopoDS_Shape& theShape, TopoDS_Shape& theShape,
@ -97,7 +97,7 @@ public:
//! @param[in] thePath path to the export CAD file //! @param[in] thePath path to the export CAD file
//! @param[out] theShape shape to export //! @param[out] theShape shape to export
//! @param[in] theWS current work session //! @param[in] theWS current work session
//! @param theProgress[in] progress indicator //! @param[in] theProgress progress indicator
//! @return true if Write operation has ended correctly //! @return true if Write operation has ended correctly
Standard_EXPORT virtual bool Write(const TCollection_AsciiString& thePath, Standard_EXPORT virtual bool Write(const TCollection_AsciiString& thePath,
const TopoDS_Shape& theShape, const TopoDS_Shape& theShape,
@ -107,7 +107,7 @@ public:
//! Reads a CAD file, according internal configuration //! Reads a CAD file, according internal configuration
//! @param[in] thePath path to the import CAD file //! @param[in] thePath path to the import CAD file
//! @param[out] theShape shape to save result //! @param[out] theShape shape to save result
//! @param theProgress[in] progress indicator //! @param[in] theProgress progress indicator
//! @return true if Read operation has ended correctly //! @return true if Read operation has ended correctly
Standard_EXPORT virtual bool Read(const TCollection_AsciiString& thePath, Standard_EXPORT virtual bool Read(const TCollection_AsciiString& thePath,
TopoDS_Shape& theShape, TopoDS_Shape& theShape,
@ -116,7 +116,7 @@ public:
//! Writes a CAD file, according internal configuration //! Writes a CAD file, according internal configuration
//! @param[in] thePath path to the export CAD file //! @param[in] thePath path to the export CAD file
//! @param[out] theShape shape to export //! @param[out] theShape shape to export
//! @param theProgress[in] progress indicator //! @param[in] theProgress progress indicator
//! @return true if Write operation has ended correctly //! @return true if Write operation has ended correctly
Standard_EXPORT virtual bool Write(const TCollection_AsciiString& thePath, Standard_EXPORT virtual bool Write(const TCollection_AsciiString& thePath,
const TopoDS_Shape& theShape, const TopoDS_Shape& theShape,

@ -33,12 +33,12 @@ public:
DEFINE_STANDARD_ALLOC DEFINE_STANDARD_ALLOC
//! (Re)Load a Draw Harness plugin. //! (Re)Load a Draw Harness plugin.
//! @param theDI [in] [out] Tcl interpretor to append loaded commands //! @param[in][out] theDI Tcl interpretor to append loaded commands
//! @param theKey [in] plugin code name to be resolved in resource file //! @param[in] theKey plugin code name to be resolved in resource file
//! @param theResourceFileName [in] description file name //! @param[in] theResourceFileName description file name
//! @param theDefaultsDirectory [in] default folder for looking description file //! @param[in] theDefaultsDirectory default folder for looking description file
//! @param theUserDefaultsDirectory [in] user folder for looking description file //! @param[in] theUserDefaultsDirectory user folder for looking description file
//! @param theIsVerbose [in] print verbose messages //! @param[in] theIsVerbose print verbose messages
Standard_EXPORT static void Load (Draw_Interpretor& theDI, Standard_EXPORT static void Load (Draw_Interpretor& theDI,
const TCollection_AsciiString& theKey, const TCollection_AsciiString& theKey,
const TCollection_AsciiString& theResourceFileName, const TCollection_AsciiString& theResourceFileName,
@ -128,9 +128,9 @@ public: //! @name argument parsing tools
//! } //! }
//! @endcode //! @endcode
//! //!
//! @param theArgNb [in] number of available arguments in theArgVec (array limits) //! @param[in] theArgNb number of available arguments in theArgVec (array limits)
//! @param theArgVec [in] argument list //! @param[in] theArgVec argument list
//! @param theColor [out] retrieved color //! @param[out] theColor retrieved color
//! @return number of handled arguments (1, 2, 3 or 4) or 0 on syntax error //! @return number of handled arguments (1, 2, 3 or 4) or 0 on syntax error
static Standard_Integer ParseColor (const Standard_Integer theArgNb, static Standard_Integer ParseColor (const Standard_Integer theArgNb,
const char* const* const theArgVec, const char* const* const theArgVec,
@ -140,9 +140,9 @@ public: //! @name argument parsing tools
} }
//! Parses RGB color argument(s). //! Parses RGB color argument(s).
//! @param theArgNb [in] number of available arguments in theArgVec (array limits) //! @param[in] theArgNb number of available arguments in theArgVec (array limits)
//! @param theArgVec [in] argument list //! @param[in] theArgVec argument list
//! @param theColor [out] retrieved color //! @param[out] theColor retrieved color
//! @return number of handled arguments (1 or 3) or 0 on syntax error. //! @return number of handled arguments (1 or 3) or 0 on syntax error.
static Standard_Integer ParseColor (const Standard_Integer theArgNb, static Standard_Integer ParseColor (const Standard_Integer theArgNb,
const char* const* const theArgVec, const char* const* const theArgVec,
@ -177,8 +177,8 @@ public: //! @name argument parsing tools
//! } //! }
//! @endcode //! @endcode
//! //!
//! @param theArg [in] argument value //! @param[in] theArg argument value
//! @param theIsOn [out] decoded Boolean flag //! @param[out] theIsOn decoded Boolean flag
//! @return FALSE on syntax error //! @return FALSE on syntax error
Standard_EXPORT static Standard_Boolean ParseOnOff (Standard_CString theArg, Standard_EXPORT static Standard_Boolean ParseOnOff (Standard_CString theArg,
Standard_Boolean& theIsOn); Standard_Boolean& theIsOn);
@ -197,9 +197,9 @@ public: //! @name argument parsing tools
//! } //! }
//! @endcode //! @endcode
//! //!
//! @param theArgsNb [in] overall number of arguments //! @param[in] theArgsNb overall number of arguments
//! @param theArgVec [in] vector of arguments //! @param[in] theArgVec vector of arguments
//! @param theArgIter [in] [out] argument position to parse //! @param[in][out] theArgIter argument position to parse
//! @return flag value //! @return flag value
Standard_EXPORT static Standard_Boolean ParseOnOffIterator (Standard_Integer theArgsNb, Standard_EXPORT static Standard_Boolean ParseOnOffIterator (Standard_Integer theArgsNb,
const char** theArgVec, const char** theArgVec,
@ -208,9 +208,9 @@ public: //! @name argument parsing tools
//! Parses boolean argument at specified iterator position with optional on/off coming next. //! Parses boolean argument at specified iterator position with optional on/off coming next.
//! Similar to ParseOnOffIterator() but also reverses returned value if argument name starts with "no" prefix. //! Similar to ParseOnOffIterator() but also reverses returned value if argument name starts with "no" prefix.
//! E.g. if nominal argument is "cmd -usefeature [on|off|1|0]=on", then "-nousefeature" argument will return FALSE. //! E.g. if nominal argument is "cmd -usefeature [on|off|1|0]=on", then "-nousefeature" argument will return FALSE.
//! @param theArgsNb [in] overall number of arguments //! @param[in] theArgsNb overall number of arguments
//! @param theArgVec [in] vector of arguments //! @param[in] theArgVec vector of arguments
//! @param theArgIter [in] [out] argument position to parse //! @param[in][out] theArgIter argument position to parse
//! @return flag value //! @return flag value
Standard_EXPORT static Standard_Boolean ParseOnOffNoIterator (Standard_Integer theArgsNb, Standard_EXPORT static Standard_Boolean ParseOnOffNoIterator (Standard_Integer theArgsNb,
const char** theArgVec, const char** theArgVec,
@ -256,8 +256,8 @@ public: //! @name methods loading standard command sets
protected: protected:
//! Returns a variable value. //! Returns a variable value.
//! @param theName [in] [out] variable name, or "." to activate picking //! @param[in][out] theName variable name, or "." to activate picking
//! @param theToAllowPick [in] when TRUE, "." name will activate picking //! @param[in] theToAllowPick when TRUE, "." name will activate picking
Standard_EXPORT static Handle(Draw_Drawable3D) getDrawable (Standard_CString& theName, Standard_EXPORT static Handle(Draw_Drawable3D) getDrawable (Standard_CString& theName,
Standard_Boolean theToAllowPick); Standard_Boolean theToAllowPick);

@ -37,14 +37,14 @@ public:
typedef Handle(Draw_Drawable3D)(*FactoryFunction_t)(Standard_IStream& theStream); typedef Handle(Draw_Drawable3D)(*FactoryFunction_t)(Standard_IStream& theStream);
//! Register factory for restoring drawable from stream (opposite to Draw_Drawable3D::Save()). //! Register factory for restoring drawable from stream (opposite to Draw_Drawable3D::Save()).
//! @param theType [in] class name //! @param[in] theType class name
//! @param theFactory [in] factory function //! @param[in] theFactory factory function
Standard_EXPORT static void RegisterFactory (const Standard_CString theType, Standard_EXPORT static void RegisterFactory (const Standard_CString theType,
const FactoryFunction_t& theFactory); const FactoryFunction_t& theFactory);
//! Restore drawable from stream (opposite to Draw_Drawable3D::Save()). //! Restore drawable from stream (opposite to Draw_Drawable3D::Save()).
//! @param theType [in] class name //! @param[in] theType class name
//! @param theStream [in] input stream //! @param[in] theStream input stream
//! @return restored drawable or NULL if factory is undefined for specified class //! @return restored drawable or NULL if factory is undefined for specified class
Standard_EXPORT static Handle(Draw_Drawable3D) Restore (const Standard_CString theType, Standard_EXPORT static Handle(Draw_Drawable3D) Restore (const Standard_CString theType,
Standard_IStream& theStream); Standard_IStream& theStream);

@ -204,11 +204,11 @@ public:
protected: protected:
//! Main constructor. //! Main constructor.
//! @param theTitle [in] window title //! @param[in] theTitle window title
//! @param theXY [in] top-left position //! @param[in] theXY top-left position
//! @param theSize [in] window dimensions //! @param[in] theSize window dimensions
//! @param theParent [in] optional native parent window //! @param[in] theParent optional native parent window
//! @param theWin [in] optional native window //! @param[in] theWin optional native window
Standard_EXPORT Draw_Window (const char* theTitle, Standard_EXPORT Draw_Window (const char* theTitle,
const NCollection_Vec2<int>& theXY, const NCollection_Vec2<int>& theXY,
const NCollection_Vec2<int>& theSize, const NCollection_Vec2<int>& theSize,

@ -31,9 +31,9 @@ public:
//! The thihedron origin and axis directions are defined by theDatum coordinate system. //! The thihedron origin and axis directions are defined by theDatum coordinate system.
//! DsgPrs_XYZAxisPresentation framework is used to create graphical primitives for each axis. //! DsgPrs_XYZAxisPresentation framework is used to create graphical primitives for each axis.
//! Axes are marked with "X", "Y", "Z" text. //! Axes are marked with "X", "Y", "Z" text.
//! @param thePresentation [out] the modified presentation //! @param[out] thePresentation the modified presentation
//! @param theDatum [in] the source of trihedron position //! @param[in] theDatum the source of trihedron position
//! @param theDrawer [in] the provider of display attributes //! @param[in] theDrawer the provider of display attributes
Standard_EXPORT static void Add (const Handle(Prs3d_Presentation)& thePresentation, const gp_Ax2& theDatum, Standard_EXPORT static void Add (const Handle(Prs3d_Presentation)& thePresentation, const gp_Ax2& theDatum,
const Handle(Prs3d_Drawer)& theDrawer); const Handle(Prs3d_Drawer)& theDrawer);

@ -300,8 +300,8 @@ public:
public: public:
//! Computes outline contour for the symbol. //! Computes outline contour for the symbol.
//! @param theUChar [in] the character to be loaded as current one //! @param[in] theUChar the character to be loaded as current one
//! @param theOutline [out] outline contour //! @param[out] theOutline outline contour
//! @return true on success //! @return true on success
Standard_EXPORT const FT_Outline* renderGlyphOutline(const Standard_Utf32Char theChar); Standard_EXPORT const FT_Outline* renderGlyphOutline(const Standard_Utf32Char theChar);

@ -94,11 +94,11 @@ public:
//! If the requested family name not found -> search for any font family with given aspect and height. //! If the requested family name not found -> search for any font family with given aspect and height.
//! If the font is still not found, returns any font available in the system. //! If the font is still not found, returns any font available in the system.
//! Returns NULL in case when the fonts are not found in the system. //! Returns NULL in case when the fonts are not found in the system.
//! @param theFontName [in] font family to find or alias name //! @param[in] theFontName font family to find or alias name
//! @param theStrictLevel [in] search strict level for using aliases and fallback //! @param[in] theStrictLevel search strict level for using aliases and fallback
//! @param theFontAspect [in] [out] font aspect to find (considered only if family name is not found); //! @param[in][out] theFontAspect font aspect to find (considered only if family name is not found);
//! can be modified if specified font alias refers to another style (compatibility with obsolete aliases) //! can be modified if specified font alias refers to another style (compatibility with obsolete aliases)
//! @param theDoFailMsg [in] put error message on failure into default messenger //! @param[in] theDoFailMsg put error message on failure into default messenger
Standard_EXPORT Handle(Font_SystemFont) FindFont (const TCollection_AsciiString& theFontName, Standard_EXPORT Handle(Font_SystemFont) FindFont (const TCollection_AsciiString& theFontName,
Font_StrictLevel theStrictLevel, Font_StrictLevel theStrictLevel,
Font_FontAspect& theFontAspect, Font_FontAspect& theFontAspect,
@ -113,8 +113,8 @@ public:
//! Tries to find fallback font for specified Unicode subset. //! Tries to find fallback font for specified Unicode subset.
//! Returns NULL in case when fallback font is not found in the system. //! Returns NULL in case when fallback font is not found in the system.
//! @param theSubset [in] Unicode subset //! @param[in] theSubset Unicode subset
//! @param theFontAspect [in] font aspect to find //! @param[in] theFontAspect font aspect to find
Standard_EXPORT Handle(Font_SystemFont) FindFallbackFont (Font_UnicodeSubset theSubset, Standard_EXPORT Handle(Font_SystemFont) FindFallbackFont (Font_UnicodeSubset theSubset,
Font_FontAspect theFontAspect) const; Font_FontAspect theFontAspect) const;
@ -153,12 +153,12 @@ public:
void SetTraceAliases (Standard_Boolean theToTrace) { myToTraceAliases = theToTrace; } void SetTraceAliases (Standard_Boolean theToTrace) { myToTraceAliases = theToTrace; }
//! Return font names with defined aliases. //! Return font names with defined aliases.
//! @param theAliases [out] alias names //! @param[out] theAliases alias names
Standard_EXPORT void GetAllAliases (TColStd_SequenceOfHAsciiString& theAliases) const; Standard_EXPORT void GetAllAliases (TColStd_SequenceOfHAsciiString& theAliases) const;
//! Return aliases to specified font name. //! Return aliases to specified font name.
//! @param theFontNames [out] font names associated with alias name //! @param[out] theFontNames font names associated with alias name
//! @param theAliasName [in] alias name //! @param[in] theAliasName alias name
Standard_EXPORT void GetFontAliases (TColStd_SequenceOfHAsciiString& theFontNames, Standard_EXPORT void GetFontAliases (TColStd_SequenceOfHAsciiString& theFontNames,
const TCollection_AsciiString& theAliasName) const; const TCollection_AsciiString& theAliasName) const;
@ -173,16 +173,16 @@ public:
//! Aliases are defined "in advance", so that they could point to non-existing fonts, //! Aliases are defined "in advance", so that they could point to non-existing fonts,
//! and they are resolved dynamically on request - first existing font is returned in case of multiple aliases to the same name. //! and they are resolved dynamically on request - first existing font is returned in case of multiple aliases to the same name.
//! //!
//! @param theAliasName [in] alias name or name of another font to be used as alias //! @param[in] theAliasName alias name or name of another font to be used as alias
//! @param theFontName [in] font to be used as substitution for alias //! @param[in] theFontName font to be used as substitution for alias
//! @return FALSE if alias has been already registered //! @return FALSE if alias has been already registered
Standard_EXPORT bool AddFontAlias (const TCollection_AsciiString& theAliasName, Standard_EXPORT bool AddFontAlias (const TCollection_AsciiString& theAliasName,
const TCollection_AsciiString& theFontName); const TCollection_AsciiString& theFontName);
//! Unregister font alias. //! Unregister font alias.
//! @param theAliasName [in] alias name or name of another font to be used as alias; //! @param[in] theAliasName alias name or name of another font to be used as alias;
//! all aliases will be removed in case of empty name //! all aliases will be removed in case of empty name
//! @param theFontName [in] font to be used as substitution for alias; //! @param[in] theFontName font to be used as substitution for alias;
//! all fonts will be removed in case of empty name //! all fonts will be removed in case of empty name
//! @return TRUE if alias has been removed //! @return TRUE if alias has been removed
Standard_EXPORT bool RemoveFontAlias (const TCollection_AsciiString& theAliasName, Standard_EXPORT bool RemoveFontAlias (const TCollection_AsciiString& theAliasName,
@ -231,7 +231,7 @@ private:
Font_FontMap() {} Font_FontMap() {}
//! Try finding font with specified parameters or the closest one. //! Try finding font with specified parameters or the closest one.
//! @param theFontName [in] font family to find (or empty string if family name can be ignored) //! @param[in] theFontName font family to find (or empty string if family name can be ignored)
//! @return best match font or NULL if not found //! @return best match font or NULL if not found
Handle(Font_SystemFont) Find (const TCollection_AsciiString& theFontName) const; Handle(Font_SystemFont) Find (const TCollection_AsciiString& theFontName) const;
}; };

@ -69,55 +69,55 @@ public:
//! the package Geom2d (in the case of an Adaptor2d_Curve2d curve) //! the package Geom2d (in the case of an Adaptor2d_Curve2d curve)
//! or a 3D curve from the package Geom (in the case of an Adaptor3d_Curve curve), //! or a 3D curve from the package Geom (in the case of an Adaptor3d_Curve curve),
//! - and those required on the curve by the computation algorithm. //! - and those required on the curve by the computation algorithm.
//! @param theC [in] input 3D curve //! @param[in] theC input 3D curve
//! @param theNbPoints [in] defines the number of desired points //! @param[in] theNbPoints defines the number of desired points
//! @param theU1 [in] first parameter on curve //! @param[in] theU1 first parameter on curve
//! @param theU2 [in] last parameter on curve //! @param[in] theU2 last parameter on curve
Standard_EXPORT GCPnts_QuasiUniformAbscissa (const Adaptor3d_Curve& theC, Standard_EXPORT GCPnts_QuasiUniformAbscissa (const Adaptor3d_Curve& theC,
const Standard_Integer theNbPoints, const Standard_Integer theNbPoints,
const Standard_Real theU1, const Standard_Real theU2); const Standard_Real theU1, const Standard_Real theU2);
//! Initialize the algorithms with 3D curve and target number of points. //! Initialize the algorithms with 3D curve and target number of points.
//! @param theC [in] input 3D curve //! @param[in] theC input 3D curve
//! @param theNbPoints [in] defines the number of desired points //! @param[in] theNbPoints defines the number of desired points
Standard_EXPORT void Initialize (const Adaptor3d_Curve& theC, Standard_EXPORT void Initialize (const Adaptor3d_Curve& theC,
const Standard_Integer theNbPoints); const Standard_Integer theNbPoints);
//! Initialize the algorithms with 3D curve, target number of points and curve parameter range. //! Initialize the algorithms with 3D curve, target number of points and curve parameter range.
//! @param theC [in] input 3D curve //! @param[in] theC input 3D curve
//! @param theNbPoints [in] defines the number of desired points //! @param[in] theNbPoints defines the number of desired points
//! @param theU1 [in] first parameter on curve //! @param[in] theU1 first parameter on curve
//! @param theU2 [in] last parameter on curve //! @param[in] theU2 last parameter on curve
Standard_EXPORT void Initialize (const Adaptor3d_Curve& theC, Standard_EXPORT void Initialize (const Adaptor3d_Curve& theC,
const Standard_Integer theNbPoints, const Standard_Integer theNbPoints,
const Standard_Real theU1, const Standard_Real theU2); const Standard_Real theU1, const Standard_Real theU2);
//! Computes a uniform abscissa distribution of points on the 2D curve. //! Computes a uniform abscissa distribution of points on the 2D curve.
//! @param theC [in] input 2D curve //! @param[in] theC input 2D curve
//! @param theNbPoints [in] defines the number of desired points //! @param[in] theNbPoints defines the number of desired points
Standard_EXPORT GCPnts_QuasiUniformAbscissa (const Adaptor2d_Curve2d& theC, Standard_EXPORT GCPnts_QuasiUniformAbscissa (const Adaptor2d_Curve2d& theC,
const Standard_Integer theNbPoints); const Standard_Integer theNbPoints);
//! Computes a Uniform abscissa distribution of points on a part of the 2D curve. //! Computes a Uniform abscissa distribution of points on a part of the 2D curve.
//! @param theC [in] input 2D curve //! @param[in] theC input 2D curve
//! @param theNbPoints [in] defines the number of desired points //! @param[in] theNbPoints defines the number of desired points
//! @param theU1 [in] first parameter on curve //! @param[in] theU1 first parameter on curve
//! @param theU2 [in] last parameter on curve //! @param[in] theU2 last parameter on curve
Standard_EXPORT GCPnts_QuasiUniformAbscissa (const Adaptor2d_Curve2d& theC, Standard_EXPORT GCPnts_QuasiUniformAbscissa (const Adaptor2d_Curve2d& theC,
const Standard_Integer theNbPoints, const Standard_Integer theNbPoints,
const Standard_Real theU1, const Standard_Real theU2); const Standard_Real theU1, const Standard_Real theU2);
//! Initialize the algorithms with 2D curve and target number of points. //! Initialize the algorithms with 2D curve and target number of points.
//! @param theC [in] input 2D curve //! @param[in] theC input 2D curve
//! @param theNbPoints [in] defines the number of desired points //! @param[in] theNbPoints defines the number of desired points
Standard_EXPORT void Initialize (const Adaptor2d_Curve2d& theC, Standard_EXPORT void Initialize (const Adaptor2d_Curve2d& theC,
const Standard_Integer theNbPoints); const Standard_Integer theNbPoints);
//! Initialize the algorithms with 2D curve, target number of points and curve parameter range. //! Initialize the algorithms with 2D curve, target number of points and curve parameter range.
//! @param theC [in] input 2D curve //! @param[in] theC input 2D curve
//! @param theNbPoints [in] defines the number of desired points //! @param[in] theNbPoints defines the number of desired points
//! @param theU1 [in] first parameter on curve //! @param[in] theU1 first parameter on curve
//! @param theU2 [in] last parameter on curve //! @param[in] theU2 last parameter on curve
Standard_EXPORT void Initialize (const Adaptor2d_Curve2d& theC, Standard_EXPORT void Initialize (const Adaptor2d_Curve2d& theC,
const Standard_Integer theNbPoints, const Standard_Integer theNbPoints,
const Standard_Real theU1, const Standard_Real theU2); const Standard_Real theU1, const Standard_Real theU2);

@ -70,12 +70,12 @@ public:
Standard_EXPORT GCPnts_TangentialDeflection(); Standard_EXPORT GCPnts_TangentialDeflection();
//! Constructor for 3D curve. //! Constructor for 3D curve.
//! @param theC [in] 3d curve //! @param[in] theC 3d curve
//! @param theAngularDeflection [in] angular deflection in radians //! @param[in] theAngularDeflection angular deflection in radians
//! @param theCurvatureDeflection [in] linear deflection //! @param[in] theCurvatureDeflection linear deflection
//! @param theMinimumOfPoints [in] minimum number of points //! @param[in] theMinimumOfPoints minimum number of points
//! @param theUTol [in] tolerance in curve parametric scope //! @param[in] theUTol tolerance in curve parametric scope
//! @param theMinLen [in] minimal length //! @param[in] theMinLen minimal length
Standard_EXPORT GCPnts_TangentialDeflection (const Adaptor3d_Curve& theC, Standard_EXPORT GCPnts_TangentialDeflection (const Adaptor3d_Curve& theC,
const Standard_Real theAngularDeflection, const Standard_Real theCurvatureDeflection, const Standard_Real theAngularDeflection, const Standard_Real theCurvatureDeflection,
const Standard_Integer theMinimumOfPoints = 2, const Standard_Integer theMinimumOfPoints = 2,
@ -83,14 +83,14 @@ public:
const Standard_Real theMinLen = 1.0e-7); const Standard_Real theMinLen = 1.0e-7);
//! Constructor for 3D curve with restricted range. //! Constructor for 3D curve with restricted range.
//! @param theC [in] 3d curve //! @param[in] theC 3d curve
//! @param theFirstParameter [in] first parameter on curve //! @param[in] theFirstParameter first parameter on curve
//! @param theLastParameter [in] last parameter on curve //! @param[in] theLastParameter last parameter on curve
//! @param theAngularDeflection [in] angular deflection in radians //! @param[in] theAngularDeflection angular deflection in radians
//! @param theCurvatureDeflection [in] linear deflection //! @param[in] theCurvatureDeflection linear deflection
//! @param theMinimumOfPoints [in] minimum number of points //! @param[in] theMinimumOfPoints minimum number of points
//! @param theUTo l [in] tolerance in curve parametric scope //! @param theUTo l[in] tolerance in curve parametric scope
//! @param theMinLen [in] minimal length //! @param[in] theMinLen minimal length
Standard_EXPORT GCPnts_TangentialDeflection (const Adaptor3d_Curve& theC, Standard_EXPORT GCPnts_TangentialDeflection (const Adaptor3d_Curve& theC,
const Standard_Real theFirstParameter, const Standard_Real theLastParameter, const Standard_Real theFirstParameter, const Standard_Real theLastParameter,
const Standard_Real theAngularDeflection, const Standard_Real theCurvatureDeflection, const Standard_Real theAngularDeflection, const Standard_Real theCurvatureDeflection,
@ -99,12 +99,12 @@ public:
const Standard_Real theMinLen = 1.0e-7); const Standard_Real theMinLen = 1.0e-7);
//! Constructor for 2D curve. //! Constructor for 2D curve.
//! @param theC [in] 2d curve //! @param[in] theC 2d curve
//! @param theAngularDeflection [in] angular deflection in radians //! @param[in] theAngularDeflection angular deflection in radians
//! @param theCurvatureDeflection [in] linear deflection //! @param[in] theCurvatureDeflection linear deflection
//! @param theMinimumOfPoints [in] minimum number of points //! @param[in] theMinimumOfPoints minimum number of points
//! @param theUTol [in] tolerance in curve parametric scope //! @param[in] theUTol tolerance in curve parametric scope
//! @param theMinLen [in] minimal length //! @param[in] theMinLen minimal length
Standard_EXPORT GCPnts_TangentialDeflection (const Adaptor2d_Curve2d& theC, Standard_EXPORT GCPnts_TangentialDeflection (const Adaptor2d_Curve2d& theC,
const Standard_Real theAngularDeflection, const Standard_Real theCurvatureDeflection, const Standard_Real theAngularDeflection, const Standard_Real theCurvatureDeflection,
const Standard_Integer theMinimumOfPoints = 2, const Standard_Integer theMinimumOfPoints = 2,
@ -112,14 +112,14 @@ public:
const Standard_Real theMinLen = 1.0e-7); const Standard_Real theMinLen = 1.0e-7);
//! Constructor for 2D curve with restricted range. //! Constructor for 2D curve with restricted range.
//! @param theC [in] 2d curve //! @param[in] theC 2d curve
//! @param theFirstParameter [in] first parameter on curve //! @param[in] theFirstParameter first parameter on curve
//! @param theLastParameter [in] last parameter on curve //! @param[in] theLastParameter last parameter on curve
//! @param theAngularDeflection [in] angular deflection in radians //! @param[in] theAngularDeflection angular deflection in radians
//! @param theCurvatureDeflection [in] linear deflection //! @param[in] theCurvatureDeflection linear deflection
//! @param theMinimumOfPoints [in] minimum number of points //! @param[in] theMinimumOfPoints minimum number of points
//! @param theUTol [in] tolerance in curve parametric scope //! @param[in] theUTol tolerance in curve parametric scope
//! @param theMinLen [in] minimal length //! @param[in] theMinLen minimal length
Standard_EXPORT GCPnts_TangentialDeflection (const Adaptor2d_Curve2d& theC, Standard_EXPORT GCPnts_TangentialDeflection (const Adaptor2d_Curve2d& theC,
const Standard_Real theFirstParameter, const Standard_Real theLastParameter, const Standard_Real theFirstParameter, const Standard_Real theLastParameter,
const Standard_Real theAngularDeflection, const Standard_Real theCurvatureDeflection, const Standard_Real theAngularDeflection, const Standard_Real theCurvatureDeflection,
@ -128,12 +128,12 @@ public:
const Standard_Real theMinLen = 1.0e-7); const Standard_Real theMinLen = 1.0e-7);
//! Initialize algorithm for 3D curve. //! Initialize algorithm for 3D curve.
//! @param theC [in] 3d curve //! @param[in] theC 3d curve
//! @param theAngularDeflection [in] angular deflection in radians //! @param[in] theAngularDeflection angular deflection in radians
//! @param theCurvatureDeflection [in] linear deflection //! @param[in] theCurvatureDeflection linear deflection
//! @param theMinimumOfPoints [in] minimum number of points //! @param[in] theMinimumOfPoints minimum number of points
//! @param theUTol [in] tolerance in curve parametric scope //! @param[in] theUTol tolerance in curve parametric scope
//! @param theMinLen [in] minimal length //! @param[in] theMinLen minimal length
Standard_EXPORT void Initialize (const Adaptor3d_Curve& theC, Standard_EXPORT void Initialize (const Adaptor3d_Curve& theC,
const Standard_Real theAngularDeflection, const Standard_Real theCurvatureDeflection, const Standard_Real theAngularDeflection, const Standard_Real theCurvatureDeflection,
const Standard_Integer theMinimumOfPoints = 2, const Standard_Integer theMinimumOfPoints = 2,
@ -141,14 +141,14 @@ public:
const Standard_Real theMinLen = 1.0e-7); const Standard_Real theMinLen = 1.0e-7);
//! Initialize algorithm for 3D curve with restricted range. //! Initialize algorithm for 3D curve with restricted range.
//! @param theC [in] 3d curve //! @param[in] theC 3d curve
//! @param theFirstParameter [in] first parameter on curve //! @param[in] theFirstParameter first parameter on curve
//! @param theLastParameter [in] last parameter on curve //! @param[in] theLastParameter last parameter on curve
//! @param theAngularDeflection [in] angular deflection in radians //! @param[in] theAngularDeflection angular deflection in radians
//! @param theCurvatureDeflection [in] linear deflection //! @param[in] theCurvatureDeflection linear deflection
//! @param theMinimumOfPoints [in] minimum number of points //! @param[in] theMinimumOfPoints minimum number of points
//! @param theUTol [in] tolerance in curve parametric scope //! @param[in] theUTol tolerance in curve parametric scope
//! @param theMinLen [in] minimal length //! @param[in] theMinLen minimal length
Standard_EXPORT void Initialize (const Adaptor3d_Curve& theC, Standard_EXPORT void Initialize (const Adaptor3d_Curve& theC,
const Standard_Real theFirstParameter, const Standard_Real theLastParameter, const Standard_Real theFirstParameter, const Standard_Real theLastParameter,
const Standard_Real theAngularDeflection, const Standard_Real theCurvatureDeflection, const Standard_Real theAngularDeflection, const Standard_Real theCurvatureDeflection,
@ -157,12 +157,12 @@ public:
const Standard_Real theMinLen = 1.0e-7); const Standard_Real theMinLen = 1.0e-7);
//! Initialize algorithm for 2D curve. //! Initialize algorithm for 2D curve.
//! @param theC [in] 2d curve //! @param[in] theC 2d curve
//! @param theAngularDeflection [in] angular deflection in radians //! @param[in] theAngularDeflection angular deflection in radians
//! @param theCurvatureDeflection [in] linear deflection //! @param[in] theCurvatureDeflection linear deflection
//! @param theMinimumOfPoints [in] minimum number of points //! @param[in] theMinimumOfPoints minimum number of points
//! @param theUTol [in] tolerance in curve parametric scope //! @param[in] theUTol tolerance in curve parametric scope
//! @param theMinLen [in] minimal length //! @param[in] theMinLen minimal length
Standard_EXPORT void Initialize (const Adaptor2d_Curve2d& theC, Standard_EXPORT void Initialize (const Adaptor2d_Curve2d& theC,
const Standard_Real theAngularDeflection, const Standard_Real theCurvatureDeflection, const Standard_Real theAngularDeflection, const Standard_Real theCurvatureDeflection,
const Standard_Integer theMinimumOfPoints = 2, const Standard_Integer theMinimumOfPoints = 2,
@ -170,14 +170,14 @@ public:
const Standard_Real theMinLen = 1.0e-7); const Standard_Real theMinLen = 1.0e-7);
//! Initialize algorithm for 2D curve with restricted range. //! Initialize algorithm for 2D curve with restricted range.
//! @param theC [in] 2d curve //! @param[in] theC 2d curve
//! @param theFirstParameter [in] first parameter on curve //! @param[in] theFirstParameter first parameter on curve
//! @param theLastParameter [in] last parameter on curve //! @param[in] theLastParameter last parameter on curve
//! @param theAngularDeflection [in] angular deflection in radians //! @param[in] theAngularDeflection angular deflection in radians
//! @param theCurvatureDeflection [in] linear deflection //! @param[in] theCurvatureDeflection linear deflection
//! @param theMinimumOfPoints [in] minimum number of points //! @param[in] theMinimumOfPoints minimum number of points
//! @param theUTol [in] tolerance in curve parametric scope //! @param[in] theUTol tolerance in curve parametric scope
//! @param theMinLen [in] minimal length //! @param[in] theMinLen minimal length
Standard_EXPORT void Initialize (const Adaptor2d_Curve2d& theC, Standard_EXPORT void Initialize (const Adaptor2d_Curve2d& theC,
const Standard_Real theFirstParameter, const Standard_Real theLastParameter, const Standard_Real theFirstParameter, const Standard_Real theLastParameter,
const Standard_Real theAngularDeflection, const Standard_Real theCurvatureDeflection, const Standard_Real theAngularDeflection, const Standard_Real theCurvatureDeflection,

@ -35,20 +35,20 @@ public:
Standard_EXPORT GCPnts_UniformAbscissa(); Standard_EXPORT GCPnts_UniformAbscissa();
//! Computes a uniform abscissa distribution of points on the 3D curve. //! Computes a uniform abscissa distribution of points on the 3D curve.
//! @param theC [in] input curve //! @param[in] theC input curve
//! @param theAbscissa [in] abscissa (distance between two consecutive points) //! @param[in] theAbscissa abscissa (distance between two consecutive points)
//! @param theToler [in] used for more precise calculation of curve length //! @param[in] theToler used for more precise calculation of curve length
//! (Precision::Confusion() by default) //! (Precision::Confusion() by default)
Standard_EXPORT GCPnts_UniformAbscissa (const Adaptor3d_Curve& theC, Standard_EXPORT GCPnts_UniformAbscissa (const Adaptor3d_Curve& theC,
const Standard_Real theAbscissa, const Standard_Real theAbscissa,
const Standard_Real theToler = -1); const Standard_Real theToler = -1);
//! Computes a Uniform abscissa distribution of points on a part of the 3D Curve. //! Computes a Uniform abscissa distribution of points on a part of the 3D Curve.
//! @param theC [in] input curve //! @param[in] theC input curve
//! @param theAbscissa [in] abscissa (distance between two consecutive points) //! @param[in] theAbscissa abscissa (distance between two consecutive points)
//! @param theU1 [in] first parameter on curve //! @param[in] theU1 first parameter on curve
//! @param theU2 [in] last parameter on curve //! @param[in] theU2 last parameter on curve
//! @param theToler [in] used for more precise calculation of curve length //! @param[in] theToler used for more precise calculation of curve length
//! (Precision::Confusion() by default) //! (Precision::Confusion() by default)
Standard_EXPORT GCPnts_UniformAbscissa (const Adaptor3d_Curve& theC, Standard_EXPORT GCPnts_UniformAbscissa (const Adaptor3d_Curve& theC,
const Standard_Real theAbscissa, const Standard_Real theAbscissa,
@ -56,20 +56,20 @@ public:
const Standard_Real theToler = -1); const Standard_Real theToler = -1);
//! Computes a uniform abscissa distribution of points on the 3D Curve. //! Computes a uniform abscissa distribution of points on the 3D Curve.
//! @param theC [in] input curve //! @param[in] theC input curve
//! @param theNbPoints [in] defines the number of desired points //! @param[in] theNbPoints defines the number of desired points
//! @param theToler [in] used for more precise calculation of curve length //! @param[in] theToler used for more precise calculation of curve length
//! (Precision::Confusion() by default) //! (Precision::Confusion() by default)
Standard_EXPORT GCPnts_UniformAbscissa (const Adaptor3d_Curve& theC, Standard_EXPORT GCPnts_UniformAbscissa (const Adaptor3d_Curve& theC,
const Standard_Integer theNbPoints, const Standard_Integer theNbPoints,
const Standard_Real theToler = -1); const Standard_Real theToler = -1);
//! Computes a Uniform abscissa distribution of points on a part of the 3D Curve. //! Computes a Uniform abscissa distribution of points on a part of the 3D Curve.
//! @param theC [in] input curve //! @param[in] theC input curve
//! @param theNbPoints [in] defines the number of desired points //! @param[in] theNbPoints defines the number of desired points
//! @param theU1 [in] first parameter on curve //! @param[in] theU1 first parameter on curve
//! @param theU2 [in] last parameter on curve //! @param[in] theU2 last parameter on curve
//! @param theToler [in] used for more precise calculation of curve length //! @param[in] theToler used for more precise calculation of curve length
//! (Precision::Confusion() by default) //! (Precision::Confusion() by default)
Standard_EXPORT GCPnts_UniformAbscissa (const Adaptor3d_Curve& theC, Standard_EXPORT GCPnts_UniformAbscissa (const Adaptor3d_Curve& theC,
const Standard_Integer theNbPoints, const Standard_Integer theNbPoints,
@ -77,20 +77,20 @@ public:
const Standard_Real theToler = -1); const Standard_Real theToler = -1);
//! Initialize the algorithms with 3D curve, Abscissa, and Tolerance. //! Initialize the algorithms with 3D curve, Abscissa, and Tolerance.
//! @param theC [in] input curve //! @param[in] theC input curve
//! @param theAbscissa [in] abscissa (distance between two consecutive points) //! @param[in] theAbscissa abscissa (distance between two consecutive points)
//! @param theToler [in] used for more precise calculation of curve length //! @param[in] theToler used for more precise calculation of curve length
//! (Precision::Confusion() by default) //! (Precision::Confusion() by default)
Standard_EXPORT void Initialize (const Adaptor3d_Curve& theC, Standard_EXPORT void Initialize (const Adaptor3d_Curve& theC,
const Standard_Real theAbscissa, const Standard_Real theAbscissa,
const Standard_Real theToler = -1); const Standard_Real theToler = -1);
//! Initialize the algorithms with 3D curve, Abscissa, Tolerance, and parameter range. //! Initialize the algorithms with 3D curve, Abscissa, Tolerance, and parameter range.
//! @param theC [in] input curve //! @param[in] theC input curve
//! @param theAbscissa [in] abscissa (distance between two consecutive points) //! @param[in] theAbscissa abscissa (distance between two consecutive points)
//! @param theU1 [in] first parameter on curve //! @param[in] theU1 first parameter on curve
//! @param theU2 [in] last parameter on curve //! @param[in] theU2 last parameter on curve
//! @param theToler [in] used for more precise calculation of curve length //! @param[in] theToler used for more precise calculation of curve length
//! (Precision::Confusion() by default) //! (Precision::Confusion() by default)
Standard_EXPORT void Initialize (const Adaptor3d_Curve& theC, Standard_EXPORT void Initialize (const Adaptor3d_Curve& theC,
const Standard_Real theAbscissa, const Standard_Real theAbscissa,
@ -98,20 +98,20 @@ public:
const Standard_Real theToler = -1); const Standard_Real theToler = -1);
//! Initialize the algorithms with 3D curve, number of points, and Tolerance. //! Initialize the algorithms with 3D curve, number of points, and Tolerance.
//! @param theC [in] input curve //! @param[in] theC input curve
//! @param theNbPoints [in] defines the number of desired points //! @param[in] theNbPoints defines the number of desired points
//! @param theToler [in] used for more precise calculation of curve length //! @param[in] theToler used for more precise calculation of curve length
//! (Precision::Confusion() by default) //! (Precision::Confusion() by default)
Standard_EXPORT void Initialize (const Adaptor3d_Curve& theC, Standard_EXPORT void Initialize (const Adaptor3d_Curve& theC,
const Standard_Integer theNbPoints, const Standard_Integer theNbPoints,
const Standard_Real theToler = -1); const Standard_Real theToler = -1);
//! Initialize the algorithms with 3D curve, number of points, Tolerance, and parameter range. //! Initialize the algorithms with 3D curve, number of points, Tolerance, and parameter range.
//! @param theC [in] input curve //! @param[in] theC input curve
//! @param theNbPoints [in] defines the number of desired points //! @param[in] theNbPoints defines the number of desired points
//! @param theU1 [in] first parameter on curve //! @param[in] theU1 first parameter on curve
//! @param theU2 [in] last parameter on curve //! @param[in] theU2 last parameter on curve
//! @param theToler [in] used for more precise calculation of curve length //! @param[in] theToler used for more precise calculation of curve length
//! (Precision::Confusion() by default) //! (Precision::Confusion() by default)
Standard_EXPORT void Initialize (const Adaptor3d_Curve& theC, Standard_EXPORT void Initialize (const Adaptor3d_Curve& theC,
const Standard_Integer theNbPoints, const Standard_Integer theNbPoints,
@ -121,20 +121,20 @@ public:
public: public:
//! Computes a uniform abscissa distribution of points on the 2D curve. //! Computes a uniform abscissa distribution of points on the 2D curve.
//! @param theC [in] input curve //! @param[in] theC input curve
//! @param theAbscissa [in] abscissa (distance between two consecutive points) //! @param[in] theAbscissa abscissa (distance between two consecutive points)
//! @param theToler [in] used for more precise calculation of curve length //! @param[in] theToler used for more precise calculation of curve length
//! (Precision::Confusion() by default) //! (Precision::Confusion() by default)
Standard_EXPORT GCPnts_UniformAbscissa (const Adaptor2d_Curve2d& theC, Standard_EXPORT GCPnts_UniformAbscissa (const Adaptor2d_Curve2d& theC,
const Standard_Real theAbscissa, const Standard_Real theAbscissa,
const Standard_Real theToler = -1); const Standard_Real theToler = -1);
//! Computes a Uniform abscissa distribution of points on a part of the 2D Curve. //! Computes a Uniform abscissa distribution of points on a part of the 2D Curve.
//! @param theC [in] input curve //! @param[in] theC input curve
//! @param theAbscissa [in] abscissa (distance between two consecutive points) //! @param[in] theAbscissa abscissa (distance between two consecutive points)
//! @param theU1 [in] first parameter on curve //! @param[in] theU1 first parameter on curve
//! @param theU2 [in] last parameter on curve //! @param[in] theU2 last parameter on curve
//! @param theToler [in] used for more precise calculation of curve length //! @param[in] theToler used for more precise calculation of curve length
//! (Precision::Confusion() by default) //! (Precision::Confusion() by default)
Standard_EXPORT GCPnts_UniformAbscissa (const Adaptor2d_Curve2d& theC, Standard_EXPORT GCPnts_UniformAbscissa (const Adaptor2d_Curve2d& theC,
const Standard_Real theAbscissa, const Standard_Real theAbscissa,
@ -142,20 +142,20 @@ public:
const Standard_Real theToler = -1); const Standard_Real theToler = -1);
//! Computes a uniform abscissa distribution of points on the 2D Curve. //! Computes a uniform abscissa distribution of points on the 2D Curve.
//! @param theC [in] input curve //! @param[in] theC input curve
//! @param theNbPoints [in] defines the number of desired points //! @param[in] theNbPoints defines the number of desired points
//! @param theToler [in] used for more precise calculation of curve length //! @param[in] theToler used for more precise calculation of curve length
//! (Precision::Confusion() by default) //! (Precision::Confusion() by default)
Standard_EXPORT GCPnts_UniformAbscissa (const Adaptor2d_Curve2d& theC, Standard_EXPORT GCPnts_UniformAbscissa (const Adaptor2d_Curve2d& theC,
const Standard_Integer theNbPoints, const Standard_Integer theNbPoints,
const Standard_Real theToler = -1); const Standard_Real theToler = -1);
//! Computes a Uniform abscissa distribution of points on a part of the 2D Curve. //! Computes a Uniform abscissa distribution of points on a part of the 2D Curve.
//! @param theC [in] input curve //! @param[in] theC input curve
//! @param theNbPoints [in] defines the number of desired points //! @param[in] theNbPoints defines the number of desired points
//! @param theU1 [in] first parameter on curve //! @param[in] theU1 first parameter on curve
//! @param theU2 [in] last parameter on curve //! @param[in] theU2 last parameter on curve
//! @param theToler [in] used for more precise calculation of curve length //! @param[in] theToler used for more precise calculation of curve length
//! (Precision::Confusion() by default) //! (Precision::Confusion() by default)
Standard_EXPORT GCPnts_UniformAbscissa (const Adaptor2d_Curve2d& theC, Standard_EXPORT GCPnts_UniformAbscissa (const Adaptor2d_Curve2d& theC,
const Standard_Integer theNbPoints, const Standard_Integer theNbPoints,
@ -163,20 +163,20 @@ public:
const Standard_Real theToler = -1); const Standard_Real theToler = -1);
//! Initialize the algorithms with 2D curve, Abscissa, and Tolerance. //! Initialize the algorithms with 2D curve, Abscissa, and Tolerance.
//! @param theC [in] input curve //! @param[in] theC input curve
//! @param theAbscissa [in] abscissa (distance between two consecutive points) //! @param[in] theAbscissa abscissa (distance between two consecutive points)
//! @param theToler [in] used for more precise calculation of curve length //! @param[in] theToler used for more precise calculation of curve length
//! (Precision::Confusion() by default) //! (Precision::Confusion() by default)
Standard_EXPORT void Initialize (const Adaptor2d_Curve2d& theC, Standard_EXPORT void Initialize (const Adaptor2d_Curve2d& theC,
const Standard_Real theAbscissa, const Standard_Real theAbscissa,
const Standard_Real theToler = -1); const Standard_Real theToler = -1);
//! Initialize the algorithms with 2D curve, Abscissa, Tolerance, and parameter range. //! Initialize the algorithms with 2D curve, Abscissa, Tolerance, and parameter range.
//! @param theC [in] input curve //! @param[in] theC input curve
//! @param theAbscissa [in] abscissa (distance between two consecutive points) //! @param[in] theAbscissa abscissa (distance between two consecutive points)
//! @param theU1 [in] first parameter on curve //! @param[in] theU1 first parameter on curve
//! @param theU2 [in] last parameter on curve //! @param[in] theU2 last parameter on curve
//! @param theToler [in] used for more precise calculation of curve length //! @param[in] theToler used for more precise calculation of curve length
//! (Precision::Confusion() by default) //! (Precision::Confusion() by default)
Standard_EXPORT void Initialize (const Adaptor2d_Curve2d& theC, Standard_EXPORT void Initialize (const Adaptor2d_Curve2d& theC,
const Standard_Real theAbscissa, const Standard_Real theAbscissa,
@ -184,20 +184,20 @@ public:
const Standard_Real theToler = -1); const Standard_Real theToler = -1);
//! Initialize the algorithms with 2D curve, number of points, and Tolerance. //! Initialize the algorithms with 2D curve, number of points, and Tolerance.
//! @param theC [in] input curve //! @param[in] theC input curve
//! @param theNbPoints [in] defines the number of desired points //! @param[in] theNbPoints defines the number of desired points
//! @param theToler [in] used for more precise calculation of curve length //! @param[in] theToler used for more precise calculation of curve length
//! (Precision::Confusion() by default) //! (Precision::Confusion() by default)
Standard_EXPORT void Initialize (const Adaptor2d_Curve2d& theC, Standard_EXPORT void Initialize (const Adaptor2d_Curve2d& theC,
const Standard_Integer theNbPoints, const Standard_Integer theNbPoints,
const Standard_Real theToler = -1); const Standard_Real theToler = -1);
//! Initialize the algorithms with 2D curve, number of points, Tolerance, and parameter range. //! Initialize the algorithms with 2D curve, number of points, Tolerance, and parameter range.
//! @param theC [in] input curve //! @param[in] theC input curve
//! @param theNbPoints [in] defines the number of desired points //! @param[in] theNbPoints defines the number of desired points
//! @param theU1 [in] first parameter on curve //! @param[in] theU1 first parameter on curve
//! @param theU2 [in] last parameter on curve //! @param[in] theU2 last parameter on curve
//! @param theToler [in] used for more precise calculation of curve length //! @param[in] theToler used for more precise calculation of curve length
//! (Precision::Confusion() by default) //! (Precision::Confusion() by default)
Standard_EXPORT void Initialize (const Adaptor2d_Curve2d& theC, Standard_EXPORT void Initialize (const Adaptor2d_Curve2d& theC,
const Standard_Integer theNbPoints, const Standard_Integer theNbPoints,

@ -44,38 +44,38 @@ public:
Standard_EXPORT GCPnts_UniformDeflection(); Standard_EXPORT GCPnts_UniformDeflection();
//! Computes a uniform Deflection distribution of points on the curve. //! Computes a uniform Deflection distribution of points on the curve.
//! @param theC [in] input 3D curve //! @param[in] theC input 3D curve
//! @param theDeflection [in] target deflection //! @param[in] theDeflection target deflection
//! @param theWithControl [in] when TRUE, the algorithm controls the estimate deflection //! @param[in] theWithControl when TRUE, the algorithm controls the estimate deflection
Standard_EXPORT GCPnts_UniformDeflection (const Adaptor3d_Curve& theC, Standard_EXPORT GCPnts_UniformDeflection (const Adaptor3d_Curve& theC,
const Standard_Real theDeflection, const Standard_Real theDeflection,
const Standard_Boolean theWithControl = Standard_True); const Standard_Boolean theWithControl = Standard_True);
//! Computes a uniform Deflection distribution of points on the curve. //! Computes a uniform Deflection distribution of points on the curve.
//! @param theC [in] input 2D curve //! @param[in] theC input 2D curve
//! @param theDeflection [in] target deflection //! @param[in] theDeflection target deflection
//! @param theWithControl [in] when TRUE, the algorithm controls the estimate deflection //! @param[in] theWithControl when TRUE, the algorithm controls the estimate deflection
Standard_EXPORT GCPnts_UniformDeflection (const Adaptor2d_Curve2d& theC, Standard_EXPORT GCPnts_UniformDeflection (const Adaptor2d_Curve2d& theC,
const Standard_Real theDeflection, const Standard_Real theDeflection,
const Standard_Boolean theWithControl = Standard_True); const Standard_Boolean theWithControl = Standard_True);
//! Computes a Uniform Deflection distribution of points on a part of the curve. //! Computes a Uniform Deflection distribution of points on a part of the curve.
//! @param theC [in] input 3D curve //! @param[in] theC input 3D curve
//! @param theDeflection [in] target deflection //! @param[in] theDeflection target deflection
//! @param theU1 [in] first parameter on curve //! @param[in] theU1 first parameter on curve
//! @param theU2 [in] last parameter on curve //! @param[in] theU2 last parameter on curve
//! @param theWithControl [in] when TRUE, the algorithm controls the estimate deflection //! @param[in] theWithControl when TRUE, the algorithm controls the estimate deflection
Standard_EXPORT GCPnts_UniformDeflection (const Adaptor3d_Curve& theC, Standard_EXPORT GCPnts_UniformDeflection (const Adaptor3d_Curve& theC,
const Standard_Real theDeflection, const Standard_Real theDeflection,
const Standard_Real theU1, const Standard_Real theU2, const Standard_Real theU1, const Standard_Real theU2,
const Standard_Boolean theWithControl = Standard_True); const Standard_Boolean theWithControl = Standard_True);
//! Computes a Uniform Deflection distribution of points on a part of the curve. //! Computes a Uniform Deflection distribution of points on a part of the curve.
//! @param theC [in] input 2D curve //! @param[in] theC input 2D curve
//! @param theDeflection [in] target deflection //! @param[in] theDeflection target deflection
//! @param theU1 [in] first parameter on curve //! @param[in] theU1 first parameter on curve
//! @param theU2 [in] last parameter on curve //! @param[in] theU2 last parameter on curve
//! @param theWithControl [in] when TRUE, the algorithm controls the estimate deflection //! @param[in] theWithControl when TRUE, the algorithm controls the estimate deflection
Standard_EXPORT GCPnts_UniformDeflection (const Adaptor2d_Curve2d& theC, Standard_EXPORT GCPnts_UniformDeflection (const Adaptor2d_Curve2d& theC,
const Standard_Real theDeflection, const Standard_Real theDeflection,
const Standard_Real theU1, const Standard_Real theU2, const Standard_Real theU1, const Standard_Real theU2,

@ -155,13 +155,13 @@ public:
Standard_EXPORT static void DensifyArray1OfReal (const Standard_Integer MinNumPoints, const TColStd_Array1OfReal& InParameters, Handle(TColStd_HArray1OfReal)& OutParameters); Standard_EXPORT static void DensifyArray1OfReal (const Standard_Integer MinNumPoints, const TColStd_Array1OfReal& InParameters, Handle(TColStd_HArray1OfReal)& OutParameters);
//! This method fuse intervals Interval1 and Interval2 with specified Confusion //! This method fuse intervals Interval1 and Interval2 with specified Confusion
//! @param Interval1 [in] first interval to fuse //! @param[in] Interval1 first interval to fuse
//! @param Interval2 [in] second interval to fuse //! @param[in] Interval2 second interval to fuse
//! @param Confision [in] tolerance to compare intervals //! @param[in] Confision tolerance to compare intervals
//! @param IsAdjustToFirstInterval [in] flag to set method of fusion, if intervals are close //! @param[in] IsAdjustToFirstInterval flag to set method of fusion, if intervals are close
//! if false, intervals are fusing by half-division methdod //! if false, intervals are fusing by half-division methdod
//! if true, intervals are fusing by selecting value from Interval1 //! if true, intervals are fusing by selecting value from Interval1
//! @param Fusion [out] output interval //! @param[out] Fusion output interval
Standard_EXPORT static void FuseIntervals (const TColStd_Array1OfReal& Interval1, Standard_EXPORT static void FuseIntervals (const TColStd_Array1OfReal& Interval1,
const TColStd_Array1OfReal& Interval2, const TColStd_Array1OfReal& Interval2,
TColStd_SequenceOfReal& Fusion, TColStd_SequenceOfReal& Fusion,

@ -690,17 +690,17 @@ public: //! @name optional array of Indices/Edges for using shared Vertex data
//! Add triangle strip into indexed triangulation array. //! Add triangle strip into indexed triangulation array.
//! N-2 triangles are added from N input nodes. //! N-2 triangles are added from N input nodes.
//! Raises exception if array is not of type Graphic3d_TOPA_TRIANGLES. //! Raises exception if array is not of type Graphic3d_TOPA_TRIANGLES.
//! @param theVertexLower [in] index of first node defining triangle strip //! @param[in] theVertexLower index of first node defining triangle strip
//! @param theVertexUpper [in] index of last node defining triangle strip //! @param[in] theVertexUpper index of last node defining triangle strip
Standard_EXPORT void AddTriangleStripEdges (Standard_Integer theVertexLower, Standard_EXPORT void AddTriangleStripEdges (Standard_Integer theVertexLower,
Standard_Integer theVertexUpper); Standard_Integer theVertexUpper);
//! Add triangle fan into indexed triangulation array. //! Add triangle fan into indexed triangulation array.
//! N-2 triangles are added from N input nodes (or N-1 with closed flag). //! N-2 triangles are added from N input nodes (or N-1 with closed flag).
//! Raises exception if array is not of type Graphic3d_TOPA_TRIANGLES. //! Raises exception if array is not of type Graphic3d_TOPA_TRIANGLES.
//! @param theVertexLower [in] index of first node defining triangle fun (center) //! @param[in] theVertexLower index of first node defining triangle fun (center)
//! @param theVertexUpper [in] index of last node defining triangle fun //! @param[in] theVertexUpper index of last node defining triangle fun
//! @param theToClose [in] close triangle fan (connect first and last points) //! @param[in] theToClose close triangle fan (connect first and last points)
Standard_EXPORT void AddTriangleFanEdges (Standard_Integer theVertexLower, Standard_EXPORT void AddTriangleFanEdges (Standard_Integer theVertexLower,
Standard_Integer theVertexUpper, Standard_Integer theVertexUpper,
Standard_Boolean theToClose); Standard_Boolean theToClose);
@ -708,9 +708,9 @@ public: //! @name optional array of Indices/Edges for using shared Vertex data
//! Add line strip (polyline) into indexed segments array. //! Add line strip (polyline) into indexed segments array.
//! N-1 segments are added from N input nodes (or N with closed flag). //! N-1 segments are added from N input nodes (or N with closed flag).
//! Raises exception if array is not of type Graphic3d_TOPA_SEGMENTS. //! Raises exception if array is not of type Graphic3d_TOPA_SEGMENTS.
//! @param theVertexLower [in] index of first node defining line strip fun (center) //! @param[in] theVertexLower index of first node defining line strip fun (center)
//! @param theVertexUpper [in] index of last node defining triangle fun //! @param[in] theVertexUpper index of last node defining triangle fun
//! @param theToClose [in] close triangle fan (connect first and last points) //! @param[in] theToClose close triangle fan (connect first and last points)
Standard_EXPORT void AddPolylineEdges (Standard_Integer theVertexLower, Standard_EXPORT void AddPolylineEdges (Standard_Integer theVertexLower,
Standard_Integer theVertexUpper, Standard_Integer theVertexUpper,
Standard_Boolean theToClose); Standard_Boolean theToClose);

@ -32,12 +32,12 @@ public:
Standard_EXPORT Graphic3d_AspectText3d(); Standard_EXPORT Graphic3d_AspectText3d();
//! Creates a context table for text primitives defined with the specified values. //! Creates a context table for text primitives defined with the specified values.
//! @param theColor [in] text color //! @param[in] theColor text color
//! @param theFont [in] font family name or alias like Font_NOF_ASCII_MONO //! @param[in] theFont font family name or alias like Font_NOF_ASCII_MONO
//! @param theExpansionFactor [in] deprecated parameter, has no effect //! @param[in] theExpansionFactor deprecated parameter, has no effect
//! @param theSpace [in] deprecated parameter, has no effect //! @param[in] theSpace deprecated parameter, has no effect
//! @param theStyle [in] font style //! @param[in] theStyle font style
//! @param theDisplayType [in] display mode //! @param[in] theDisplayType display mode
Standard_EXPORT Graphic3d_AspectText3d (const Quantity_Color& theColor, Standard_EXPORT Graphic3d_AspectText3d (const Quantity_Color& theColor,
Standard_CString theFont, Standard_CString theFont,
Standard_Real theExpansionFactor, Standard_Real theExpansionFactor,

@ -272,24 +272,24 @@ public:
//! Dumps the graphical contents of a shadowmap framebuffer into an image. //! Dumps the graphical contents of a shadowmap framebuffer into an image.
//! @param theImage the image to store the shadow map. //! @param theImage the image to store the shadow map.
//! @param theLightName [in] name of the light used to generate the shadow map. //! @param[in] theLightName name of the light used to generate the shadow map.
virtual Standard_Boolean ShadowMapDump (Image_PixMap& theImage, const TCollection_AsciiString& theLightName) = 0; virtual Standard_Boolean ShadowMapDump (Image_PixMap& theImage, const TCollection_AsciiString& theLightName) = 0;
//! Marks BVH tree and the set of BVH primitives of correspondent priority list with id theLayerId as outdated. //! Marks BVH tree and the set of BVH primitives of correspondent priority list with id theLayerId as outdated.
virtual void InvalidateBVHData (const Graphic3d_ZLayerId theLayerId) = 0; virtual void InvalidateBVHData (const Graphic3d_ZLayerId theLayerId) = 0;
//! Add a layer to the view. //! Add a layer to the view.
//! @param theNewLayerId [in] id of new layer, should be > 0 (negative values are reserved for default layers). //! @param[in] theNewLayerId id of new layer, should be > 0 (negative values are reserved for default layers).
//! @param theSettings [in] new layer settings //! @param[in] theSettings new layer settings
//! @param theLayerAfter [in] id of layer to append new layer before //! @param[in] theLayerAfter id of layer to append new layer before
virtual void InsertLayerBefore (const Graphic3d_ZLayerId theNewLayerId, virtual void InsertLayerBefore (const Graphic3d_ZLayerId theNewLayerId,
const Graphic3d_ZLayerSettings& theSettings, const Graphic3d_ZLayerSettings& theSettings,
const Graphic3d_ZLayerId theLayerAfter) = 0; const Graphic3d_ZLayerId theLayerAfter) = 0;
//! Add a layer to the view. //! Add a layer to the view.
//! @param theNewLayerId [in] id of new layer, should be > 0 (negative values are reserved for default layers). //! @param[in] theNewLayerId id of new layer, should be > 0 (negative values are reserved for default layers).
//! @param theSettings [in] new layer settings //! @param[in] theSettings new layer settings
//! @param theLayerBefore [in] id of layer to append new layer after //! @param[in] theLayerBefore id of layer to append new layer after
virtual void InsertLayerAfter (const Graphic3d_ZLayerId theNewLayerId, virtual void InsertLayerAfter (const Graphic3d_ZLayerId theNewLayerId,
const Graphic3d_ZLayerSettings& theSettings, const Graphic3d_ZLayerSettings& theSettings,
const Graphic3d_ZLayerId theLayerBefore) = 0; const Graphic3d_ZLayerId theLayerBefore) = 0;
@ -383,9 +383,9 @@ public:
const Handle(Graphic3d_CubeMap)& IBLCubeMap() const { return myCubeMapIBL; } const Handle(Graphic3d_CubeMap)& IBLCubeMap() const { return myCubeMapIBL; }
//! Sets image texture or environment cubemap as background. //! Sets image texture or environment cubemap as background.
//! @param theTextureMap [in] source to set a background; //! @param[in] theTextureMap source to set a background;
//! should be either Graphic3d_Texture2D or Graphic3d_CubeMap //! should be either Graphic3d_Texture2D or Graphic3d_CubeMap
//! @param theToUpdatePBREnv [in] defines whether IBL maps will be generated or not //! @param[in] theToUpdatePBREnv defines whether IBL maps will be generated or not
//! (see GeneratePBREnvironment()) //! (see GeneratePBREnvironment())
virtual void SetBackgroundImage (const Handle(Graphic3d_TextureMap)& theTextureMap, virtual void SetBackgroundImage (const Handle(Graphic3d_TextureMap)& theTextureMap,
Standard_Boolean theToUpdatePBREnv = Standard_True) = 0; Standard_Boolean theToUpdatePBREnv = Standard_True) = 0;
@ -497,7 +497,7 @@ public:
void SetBaseXRCamera (const Handle(Graphic3d_Camera)& theCamera) { myBaseXRCamera = theCamera; } void SetBaseXRCamera (const Handle(Graphic3d_Camera)& theCamera) { myBaseXRCamera = theCamera; }
//! Convert XR pose to world space. //! Convert XR pose to world space.
//! @param thePoseXR [in] transformation defined in VR local coordinate system, //! @param[in] thePoseXR transformation defined in VR local coordinate system,
//! oriented as Y-up, X-right and -Z-forward //! oriented as Y-up, X-right and -Z-forward
//! @return transformation defining orientation of XR pose in world space //! @return transformation defining orientation of XR pose in world space
gp_Trsf PoseXRToWorld (const gp_Trsf& thePoseXR) const gp_Trsf PoseXRToWorld (const gp_Trsf& thePoseXR) const
@ -511,7 +511,7 @@ public:
} }
//! Returns view direction in the world space based on XR pose. //! Returns view direction in the world space based on XR pose.
//! @param thePoseXR [in] transformation defined in VR local coordinate system, //! @param[in] thePoseXR transformation defined in VR local coordinate system,
//! oriented as Y-up, X-right and -Z-forward //! oriented as Y-up, X-right and -Z-forward
gp_Ax1 ViewAxisInWorld (const gp_Trsf& thePoseXR) const gp_Ax1 ViewAxisInWorld (const gp_Trsf& thePoseXR) const
{ {
@ -548,8 +548,8 @@ public: //! @name obsolete Graduated Trihedron functionality
virtual void GraduatedTrihedronErase() {} virtual void GraduatedTrihedronErase() {}
//! Sets minimum and maximum points of scene bounding box for Graduated Trihedron stored in graphic view object. //! Sets minimum and maximum points of scene bounding box for Graduated Trihedron stored in graphic view object.
//! @param theMin [in] the minimum point of scene. //! @param[in] theMin the minimum point of scene.
//! @param theMax [in] the maximum point of scene. //! @param[in] theMax the maximum point of scene.
virtual void GraduatedTrihedronMinMaxValues (const Graphic3d_Vec3 theMin, const Graphic3d_Vec3 theMax) virtual void GraduatedTrihedronMinMaxValues (const Graphic3d_Vec3 theMin, const Graphic3d_Vec3 theMax)
{ {
(void )theMin; (void )theMin;

@ -166,10 +166,10 @@ public:
//! This transformation might be not in line with user expectations. //! This transformation might be not in line with user expectations.
//! In this case, application might define intermediate camera positions for interpolation or implement own interpolation logic. //! In this case, application might define intermediate camera positions for interpolation or implement own interpolation logic.
//! //!
//! @param theStart [in] initial camera position //! @param[in] theStart initial camera position
//! @param theEnd [in] final camera position //! @param[in] theEnd final camera position
//! @param theT [in] step between initial and final positions within [0,1] range //! @param[in] theT step between initial and final positions within [0,1] range
//! @param theCamera [out] interpolation result //! @param[out] theCamera interpolation result
Standard_EXPORT static void Interpolate (const Handle(Graphic3d_Camera)& theStart, Standard_EXPORT static void Interpolate (const Handle(Graphic3d_Camera)& theStart,
const Handle(Graphic3d_Camera)& theEnd, const Handle(Graphic3d_Camera)& theEnd,
const double theT, const double theT,
@ -186,7 +186,7 @@ public:
Standard_EXPORT Graphic3d_Camera(); Standard_EXPORT Graphic3d_Camera();
//! Copy constructor. //! Copy constructor.
//! @param theOther [in] the camera to copy from. //! @param[in] theOther the camera to copy from.
Standard_EXPORT Graphic3d_Camera (const Handle(Graphic3d_Camera)& theOther); Standard_EXPORT Graphic3d_Camera (const Handle(Graphic3d_Camera)& theOther);
//! Initialize mapping related parameters from other camera handle. //! Initialize mapping related parameters from other camera handle.
@ -196,7 +196,7 @@ public:
Standard_EXPORT void CopyOrientationData (const Handle(Graphic3d_Camera)& theOtherCamera); Standard_EXPORT void CopyOrientationData (const Handle(Graphic3d_Camera)& theOtherCamera);
//! Copy properties of another camera. //! Copy properties of another camera.
//! @param theOther [in] the camera to copy from. //! @param[in] theOther the camera to copy from.
Standard_EXPORT void Copy (const Handle(Graphic3d_Camera)& theOther); Standard_EXPORT void Copy (const Handle(Graphic3d_Camera)& theOther);
//! @name Public camera properties //! @name Public camera properties
@ -208,12 +208,12 @@ public:
//! Sets camera look direction preserving the current Eye() position. //! Sets camera look direction preserving the current Eye() position.
//! WARNING! This method does NOT verify that the current Up() vector is orthogonal to the new Direction. //! WARNING! This method does NOT verify that the current Up() vector is orthogonal to the new Direction.
//! @param theDir [in] the direction. //! @param[in] theDir the direction.
Standard_EXPORT void SetDirectionFromEye (const gp_Dir& theDir); Standard_EXPORT void SetDirectionFromEye (const gp_Dir& theDir);
//! Sets camera look direction and computes the new Eye position relative to current Center. //! Sets camera look direction and computes the new Eye position relative to current Center.
//! WARNING! This method does NOT verify that the current Up() vector is orthogonal to the new Direction. //! WARNING! This method does NOT verify that the current Up() vector is orthogonal to the new Direction.
//! @param theDir [in] the direction. //! @param[in] theDir the direction.
Standard_EXPORT void SetDirection (const gp_Dir& theDir); Standard_EXPORT void SetDirection (const gp_Dir& theDir);
//! Get camera Up direction vector. //! Get camera Up direction vector.
@ -222,7 +222,7 @@ public:
//! Sets camera Up direction vector, orthogonal to camera direction. //! Sets camera Up direction vector, orthogonal to camera direction.
//! WARNING! This method does NOT verify that the new Up vector is orthogonal to the current Direction(). //! WARNING! This method does NOT verify that the new Up vector is orthogonal to the current Direction().
//! @param theUp [in] the Up direction vector. //! @param[in] theUp the Up direction vector.
//! @sa OrthogonalizeUp(). //! @sa OrthogonalizeUp().
Standard_EXPORT void SetUp (const gp_Dir& theUp); Standard_EXPORT void SetUp (const gp_Dir& theUp);
@ -244,20 +244,20 @@ public:
//! Sets camera Eye position. //! Sets camera Eye position.
//! Unlike SetEye(), this method only changes Eye point and preserves camera direction. //! Unlike SetEye(), this method only changes Eye point and preserves camera direction.
//! @param theEye [in] the location of camera's Eye. //! @param[in] theEye the location of camera's Eye.
//! @sa SetEye() //! @sa SetEye()
Standard_EXPORT void MoveEyeTo (const gp_Pnt& theEye); Standard_EXPORT void MoveEyeTo (const gp_Pnt& theEye);
//! Sets camera Eye and Center positions. //! Sets camera Eye and Center positions.
//! @param theEye [in] the location of camera's Eye //! @param[in] theEye the location of camera's Eye
//! @param theCenter [in] the location of camera's Center //! @param[in] theCenter the location of camera's Center
Standard_EXPORT void SetEyeAndCenter (const gp_Pnt& theEye, Standard_EXPORT void SetEyeAndCenter (const gp_Pnt& theEye,
const gp_Pnt& theCenter); const gp_Pnt& theCenter);
//! Sets camera Eye position. //! Sets camera Eye position.
//! WARNING! For backward compatibility reasons, this method also changes view direction, //! WARNING! For backward compatibility reasons, this method also changes view direction,
//! so that the new direction is computed from new Eye position to old Center position. //! so that the new direction is computed from new Eye position to old Center position.
//! @param theEye [in] the location of camera's Eye. //! @param[in] theEye the location of camera's Eye.
//! @sa MoveEyeTo(), SetEyeAndCenter() //! @sa MoveEyeTo(), SetEyeAndCenter()
Standard_EXPORT void SetEye (const gp_Pnt& theEye); Standard_EXPORT void SetEye (const gp_Pnt& theEye);
@ -272,7 +272,7 @@ public:
//! Sets Center of the camera, e.g. the point where camera looks at. //! Sets Center of the camera, e.g. the point where camera looks at.
//! This methods changes camera direction, so that the new direction is computed //! This methods changes camera direction, so that the new direction is computed
//! from current Eye position to specified Center position. //! from current Eye position to specified Center position.
//! @param theCenter [in] the point where the camera looks at. //! @param[in] theCenter the point where the camera looks at.
Standard_EXPORT void SetCenter (const gp_Pnt& theCenter); Standard_EXPORT void SetCenter (const gp_Pnt& theCenter);
//! Get distance of Eye from camera Center. //! Get distance of Eye from camera Center.
@ -280,7 +280,7 @@ public:
Standard_Real Distance() const { return myDistance; } Standard_Real Distance() const { return myDistance; }
//! Set distance of Eye from camera Center. //! Set distance of Eye from camera Center.
//! @param theDistance [in] the distance. //! @param[in] theDistance the distance.
Standard_EXPORT void SetDistance (const Standard_Real theDistance); Standard_EXPORT void SetDistance (const Standard_Real theDistance);
//! Get camera scale. //! Get camera scale.
@ -294,7 +294,7 @@ public:
//! both dimensions assuming that the aspect is 1.0. The projection height //! both dimensions assuming that the aspect is 1.0. The projection height
//! and width are specified with the scale and correspondingly multiplied //! and width are specified with the scale and correspondingly multiplied
//! by the aspect. //! by the aspect.
//! @param theScale [in] the scale factor. //! @param[in] theScale the scale factor.
Standard_EXPORT void SetScale (const Standard_Real theScale); Standard_EXPORT void SetScale (const Standard_Real theScale);
//! Get camera axial scale. //! Get camera axial scale.
@ -302,7 +302,7 @@ public:
const gp_XYZ& AxialScale() const { return myAxialScale; } const gp_XYZ& AxialScale() const { return myAxialScale; }
//! Set camera axial scale. //! Set camera axial scale.
//! @param theAxialScale [in] the axial scale vector. //! @param[in] theAxialScale the axial scale vector.
Standard_EXPORT void SetAxialScale (const gp_XYZ& theAxialScale); Standard_EXPORT void SetAxialScale (const gp_XYZ& theAxialScale);
//! Change camera projection type. //! Change camera projection type.
@ -338,7 +338,7 @@ public:
//! Set Field Of View (FOV) in y axis for perspective projection. //! Set Field Of View (FOV) in y axis for perspective projection.
//! Field of View in x axis is automatically scaled from view aspect ratio. //! Field of View in x axis is automatically scaled from view aspect ratio.
//! @param theFOVy [in] the FOV in degrees. //! @param[in] theFOVy the FOV in degrees.
Standard_EXPORT void SetFOVy (const Standard_Real theFOVy); Standard_EXPORT void SetFOVy (const Standard_Real theFOVy);
//! Get Field Of View (FOV) in y axis. //! Get Field Of View (FOV) in y axis.
@ -394,8 +394,8 @@ public:
//! For perspective projection, only positive values are allowed. //! For perspective projection, only positive values are allowed.
//! Program error exception is raised if non-positive values are //! Program error exception is raised if non-positive values are
//! specified for perspective projection or theZNear >= theZFar. //! specified for perspective projection or theZNear >= theZFar.
//! @param theZNear [in] the distance of the plane from the Eye. //! @param[in] theZNear the distance of the plane from the Eye.
//! @param theZFar [in] the distance of the plane from the Eye. //! @param[in] theZFar the distance of the plane from the Eye.
Standard_EXPORT void SetZRange (const Standard_Real theZNear, const Standard_Real theZFar); Standard_EXPORT void SetZRange (const Standard_Real theZNear, const Standard_Real theZFar);
//! Get the Near Z-clipping plane position. //! Get the Near Z-clipping plane position.
@ -427,7 +427,7 @@ public:
} }
//! Changes width / height display ratio. //! Changes width / height display ratio.
//! @param theAspect [in] the display ratio. //! @param[in] theAspect the display ratio.
Standard_EXPORT void SetAspect (const Standard_Real theAspect); Standard_EXPORT void SetAspect (const Standard_Real theAspect);
//! Get camera display ratio. //! Get camera display ratio.
@ -438,10 +438,10 @@ public:
} }
//! Sets stereographic focus distance. //! Sets stereographic focus distance.
//! @param theType [in] the focus definition type. Focus can be defined //! @param[in] theType the focus definition type. Focus can be defined
//! as absolute value or relatively to (as coefficient of) coefficient of //! as absolute value or relatively to (as coefficient of) coefficient of
//! camera focal length. //! camera focal length.
//! @param theZFocus [in] the focus absolute value or coefficient depending //! @param[in] theZFocus the focus absolute value or coefficient depending
//! on the passed definition type. //! on the passed definition type.
Standard_EXPORT void SetZFocus (const FocusType theType, const Standard_Real theZFocus); Standard_EXPORT void SetZFocus (const FocusType theType, const Standard_Real theZFocus);
@ -461,9 +461,9 @@ public:
} }
//! Sets Intraocular distance. //! Sets Intraocular distance.
//! @param theType [in] the IOD definition type. IOD can be defined as //! @param[in] theType the IOD definition type. IOD can be defined as
//! absolute value or relatively to (as coefficient of) camera focal length. //! absolute value or relatively to (as coefficient of) camera focal length.
//! @param theIOD [in] the Intraocular distance. //! @param[in] theIOD the Intraocular distance.
Standard_EXPORT void SetIOD (const IODType theType, const Standard_Real theIOD); Standard_EXPORT void SetIOD (const IODType theType, const Standard_Real theIOD);
//! Get Intraocular distance value. //! Get Intraocular distance value.
@ -496,7 +496,7 @@ public:
//! Transform orientation components of the camera: //! Transform orientation components of the camera:
//! Eye, Up and Center points. //! Eye, Up and Center points.
//! @param theTrsf [in] the transformation to apply. //! @param[in] theTrsf the transformation to apply.
Standard_EXPORT void Transform (const gp_Trsf& theTrsf); Standard_EXPORT void Transform (const gp_Trsf& theTrsf);
//! Calculate view plane size at center (target) point //! Calculate view plane size at center (target) point
@ -509,7 +509,7 @@ public:
//! Calculate view plane size at center point with specified Z offset //! Calculate view plane size at center point with specified Z offset
//! and distance between ZFar and ZNear planes. //! and distance between ZFar and ZNear planes.
//! @param theZValue [in] the distance from the eye in eye-to-center direction //! @param[in] theZValue the distance from the eye in eye-to-center direction
//! @return values in form of gp_Pnt (Width, Height, Depth). //! @return values in form of gp_Pnt (Width, Height, Depth).
Standard_EXPORT gp_XYZ ViewDimensions (const Standard_Real theZValue) const; Standard_EXPORT gp_XYZ ViewDimensions (const Standard_Real theZValue) const;
@ -537,12 +537,12 @@ public:
//! The frustum planes are usually used as inputs for camera algorithms. //! The frustum planes are usually used as inputs for camera algorithms.
//! Thus, if any changes to projection matrix calculation are necessary, //! Thus, if any changes to projection matrix calculation are necessary,
//! the frustum planes calculation should be also touched. //! the frustum planes calculation should be also touched.
//! @param theLeft [out] the frustum plane for left side of view. //! @param[out] theLeft the frustum plane for left side of view.
//! @param theRight [out] the frustum plane for right side of view. //! @param[out] theRight the frustum plane for right side of view.
//! @param theBottom [out] the frustum plane for bottom side of view. //! @param[out] theBottom the frustum plane for bottom side of view.
//! @param theTop [out] the frustum plane for top side of view. //! @param[out] theTop the frustum plane for top side of view.
//! @param theNear [out] the frustum plane for near side of view. //! @param[out] theNear the frustum plane for near side of view.
//! @param theFar [out] the frustum plane for far side of view. //! @param[out] theFar the frustum plane for far side of view.
Standard_EXPORT void Frustum (gp_Pln& theLeft, Standard_EXPORT void Frustum (gp_Pln& theLeft,
gp_Pln& theRight, gp_Pln& theRight,
gp_Pln& theBottom, gp_Pln& theBottom,
@ -555,37 +555,37 @@ public:
//! Project point from world coordinate space to //! Project point from world coordinate space to
//! normalized device coordinates (mapping). //! normalized device coordinates (mapping).
//! @param thePnt [in] the 3D point in WCS. //! @param[in] thePnt the 3D point in WCS.
//! @return mapped point in NDC. //! @return mapped point in NDC.
Standard_EXPORT gp_Pnt Project (const gp_Pnt& thePnt) const; Standard_EXPORT gp_Pnt Project (const gp_Pnt& thePnt) const;
//! Unproject point from normalized device coordinates //! Unproject point from normalized device coordinates
//! to world coordinate space. //! to world coordinate space.
//! @param thePnt [in] the NDC point. //! @param[in] thePnt the NDC point.
//! @return 3D point in WCS. //! @return 3D point in WCS.
Standard_EXPORT gp_Pnt UnProject (const gp_Pnt& thePnt) const; Standard_EXPORT gp_Pnt UnProject (const gp_Pnt& thePnt) const;
//! Convert point from view coordinate space to //! Convert point from view coordinate space to
//! projection coordinate space. //! projection coordinate space.
//! @param thePnt [in] the point in VCS. //! @param[in] thePnt the point in VCS.
//! @return point in NDC. //! @return point in NDC.
Standard_EXPORT gp_Pnt ConvertView2Proj (const gp_Pnt& thePnt) const; Standard_EXPORT gp_Pnt ConvertView2Proj (const gp_Pnt& thePnt) const;
//! Convert point from projection coordinate space //! Convert point from projection coordinate space
//! to view coordinate space. //! to view coordinate space.
//! @param thePnt [in] the point in NDC. //! @param[in] thePnt the point in NDC.
//! @return point in VCS. //! @return point in VCS.
Standard_EXPORT gp_Pnt ConvertProj2View (const gp_Pnt& thePnt) const; Standard_EXPORT gp_Pnt ConvertProj2View (const gp_Pnt& thePnt) const;
//! Convert point from world coordinate space to //! Convert point from world coordinate space to
//! view coordinate space. //! view coordinate space.
//! @param thePnt [in] the 3D point in WCS. //! @param[in] thePnt the 3D point in WCS.
//! @return point in VCS. //! @return point in VCS.
Standard_EXPORT gp_Pnt ConvertWorld2View (const gp_Pnt& thePnt) const; Standard_EXPORT gp_Pnt ConvertWorld2View (const gp_Pnt& thePnt) const;
//! Convert point from view coordinate space to //! Convert point from view coordinate space to
//! world coordinates. //! world coordinates.
//! @param thePnt [in] the 3D point in VCS. //! @param[in] thePnt the 3D point in VCS.
//! @return point in WCS. //! @return point in WCS.
Standard_EXPORT gp_Pnt ConvertView2World (const gp_Pnt& thePnt) const; Standard_EXPORT gp_Pnt ConvertView2World (const gp_Pnt& thePnt) const;
@ -659,20 +659,20 @@ public:
public: public:
//! Get stereo projection matrices. //! Get stereo projection matrices.
//! @param theProjL [out] left eye projection matrix //! @param[out] theProjL left eye projection matrix
//! @param theHeadToEyeL [out] left head to eye translation matrix //! @param[out] theHeadToEyeL left head to eye translation matrix
//! @param theProjR [out] right eye projection matrix //! @param[out] theProjR right eye projection matrix
//! @param theHeadToEyeR [out] right head to eye translation matrix //! @param[out] theHeadToEyeR right head to eye translation matrix
Standard_EXPORT void StereoProjection (Graphic3d_Mat4d& theProjL, Standard_EXPORT void StereoProjection (Graphic3d_Mat4d& theProjL,
Graphic3d_Mat4d& theHeadToEyeL, Graphic3d_Mat4d& theHeadToEyeL,
Graphic3d_Mat4d& theProjR, Graphic3d_Mat4d& theProjR,
Graphic3d_Mat4d& theHeadToEyeR) const; Graphic3d_Mat4d& theHeadToEyeR) const;
//! Get stereo projection matrices. //! Get stereo projection matrices.
//! @param theProjL [out] left eye projection matrix //! @param[out] theProjL left eye projection matrix
//! @param theHeadToEyeL [out] left head to eye translation matrix //! @param[out] theHeadToEyeL left head to eye translation matrix
//! @param theProjR [out] right eye projection matrix //! @param[out] theProjR right eye projection matrix
//! @param theHeadToEyeR [out] right head to eye translation matrix //! @param[out] theHeadToEyeR right head to eye translation matrix
Standard_EXPORT void StereoProjectionF (Graphic3d_Mat4& theProjL, Standard_EXPORT void StereoProjectionF (Graphic3d_Mat4& theProjL,
Graphic3d_Mat4& theHeadToEyeL, Graphic3d_Mat4& theHeadToEyeL,
Graphic3d_Mat4& theProjR, Graphic3d_Mat4& theProjR,
@ -693,10 +693,10 @@ public:
bool IsCustomStereoProjection() const { return myIsCustomProjMatLR; } bool IsCustomStereoProjection() const { return myIsCustomProjMatLR; }
//! Set custom stereo projection matrices. //! Set custom stereo projection matrices.
//! @param theProjL [in] left eye projection matrix //! @param[in] theProjL left eye projection matrix
//! @param theHeadToEyeL [in] left head to eye translation matrix //! @param[in] theHeadToEyeL left head to eye translation matrix
//! @param theProjR [in] right eye projection matrix //! @param[in] theProjR right eye projection matrix
//! @param theHeadToEyeR [in] right head to eye translation matrix //! @param[in] theHeadToEyeR right head to eye translation matrix
Standard_EXPORT void SetCustomStereoProjection (const Graphic3d_Mat4d& theProjL, Standard_EXPORT void SetCustomStereoProjection (const Graphic3d_Mat4d& theProjL,
const Graphic3d_Mat4d& theHeadToEyeL, const Graphic3d_Mat4d& theHeadToEyeL,
const Graphic3d_Mat4d& theProjR, const Graphic3d_Mat4d& theProjR,
@ -715,10 +715,10 @@ public:
private: private:
//! Get stereo projection matrices. //! Get stereo projection matrices.
//! @param theProjL [out] left eye projection matrix //! @param[out] theProjL left eye projection matrix
//! @param theHeadToEyeL [out] left head to eye translation matrix //! @param[out] theHeadToEyeL left head to eye translation matrix
//! @param theProjR [out] right eye projection matrix //! @param[out] theProjR right eye projection matrix
//! @param theHeadToEyeR [out] right head to eye translation matrix //! @param[out] theHeadToEyeR right head to eye translation matrix
template <typename Elem_t> template <typename Elem_t>
Standard_EXPORT void stereoProjection (NCollection_Mat4<Elem_t>& theProjL, Standard_EXPORT void stereoProjection (NCollection_Mat4<Elem_t>& theProjL,
NCollection_Mat4<Elem_t>& theHeadToEyeL, NCollection_Mat4<Elem_t>& theHeadToEyeL,
@ -726,10 +726,10 @@ private:
NCollection_Mat4<Elem_t>& theHeadToEyeR) const; NCollection_Mat4<Elem_t>& theHeadToEyeR) const;
//! Compute projection matrices. //! Compute projection matrices.
//! @param theProjM [out] mono projection matrix //! @param[out] theProjM mono projection matrix
//! @param theProjL [out] left eye projection matrix //! @param[out] theProjL left eye projection matrix
//! @param theProjR [out] right eye projection matrix //! @param[out] theProjR right eye projection matrix
//! @param theToAddHeadToEye [in] flag to pre-multiply head-to-eye translation //! @param[in] theToAddHeadToEye flag to pre-multiply head-to-eye translation
template <typename Elem_t> template <typename Elem_t>
Standard_EXPORT void computeProjection (NCollection_Mat4<Elem_t>& theProjM, Standard_EXPORT void computeProjection (NCollection_Mat4<Elem_t>& theProjM,
NCollection_Mat4<Elem_t>& theProjL, NCollection_Mat4<Elem_t>& theProjL,
@ -737,7 +737,7 @@ private:
bool theToAddHeadToEye) const; bool theToAddHeadToEye) const;
//! Compute projection matrices. //! Compute projection matrices.
//! @param theMatrices [in] the matrices data container. //! @param[in] theMatrices the matrices data container.
template <typename Elem_t> template <typename Elem_t>
TransformMatrices<Elem_t>& UpdateProjection (TransformMatrices<Elem_t>& theMatrices) const TransformMatrices<Elem_t>& UpdateProjection (TransformMatrices<Elem_t>& theMatrices) const
{ {
@ -750,7 +750,7 @@ private:
} }
//! Compute orientation matrix. //! Compute orientation matrix.
//! @param theMatrices [in] the matrices data container. //! @param[in] theMatrices the matrices data container.
template <typename Elem_t> template <typename Elem_t>
Standard_EXPORT Standard_EXPORT
TransformMatrices<Elem_t>& UpdateOrientation (TransformMatrices<Elem_t>& theMatrices) const; TransformMatrices<Elem_t>& UpdateOrientation (TransformMatrices<Elem_t>& theMatrices) const;
@ -758,10 +758,10 @@ private:
private: private:
//! Compose orthographic projection matrix for the passed camera volume mapping. //! Compose orthographic projection matrix for the passed camera volume mapping.
//! @param theOutMx [out] the projection matrix //! @param[out] theOutMx the projection matrix
//! @param theLRBT [in] the left/right/bottom/top mapping (clipping) coordinates //! @param[in] theLRBT the left/right/bottom/top mapping (clipping) coordinates
//! @param theNear [in] the near mapping (clipping) coordinate //! @param[in] theNear the near mapping (clipping) coordinate
//! @param theFar [in] the far mapping (clipping) coordinate //! @param[in] theFar the far mapping (clipping) coordinate
template <typename Elem_t> template <typename Elem_t>
void orthoProj (NCollection_Mat4<Elem_t>& theOutMx, void orthoProj (NCollection_Mat4<Elem_t>& theOutMx,
const Aspect_FrustumLRBT<Elem_t>& theLRBT, const Aspect_FrustumLRBT<Elem_t>& theLRBT,
@ -769,10 +769,10 @@ private:
const Elem_t theFar) const; const Elem_t theFar) const;
//! Compose perspective projection matrix for the passed camera volume mapping. //! Compose perspective projection matrix for the passed camera volume mapping.
//! @param theOutMx [out] the projection matrix //! @param[out] theOutMx the projection matrix
//! @param theLRBT [in] the left/right/bottom/top mapping (clipping) coordinates //! @param[in] theLRBT the left/right/bottom/top mapping (clipping) coordinates
//! @param theNear [in] the near mapping (clipping) coordinate //! @param[in] theNear the near mapping (clipping) coordinate
//! @param theFar [in] the far mapping (clipping) coordinate //! @param[in] theFar the far mapping (clipping) coordinate
template <typename Elem_t> template <typename Elem_t>
void perspectiveProj (NCollection_Mat4<Elem_t>& theOutMx, void perspectiveProj (NCollection_Mat4<Elem_t>& theOutMx,
const Aspect_FrustumLRBT<Elem_t>& theLRBT, const Aspect_FrustumLRBT<Elem_t>& theLRBT,
@ -780,13 +780,13 @@ private:
const Elem_t theFar) const; const Elem_t theFar) const;
//! Compose projection matrix for L/R stereo eyes. //! Compose projection matrix for L/R stereo eyes.
//! @param theOutMx [out] the projection matrix //! @param[out] theOutMx the projection matrix
//! @param theLRBT [in] the left/right/bottom/top mapping (clipping) coordinates //! @param[in] theLRBT the left/right/bottom/top mapping (clipping) coordinates
//! @param theNear [in] the near mapping (clipping) coordinate //! @param[in] theNear the near mapping (clipping) coordinate
//! @param theFar [in] the far mapping (clipping) coordinate //! @param[in] theFar the far mapping (clipping) coordinate
//! @param theIOD [in] the Intraocular distance //! @param[in] theIOD the Intraocular distance
//! @param theZFocus [in] the z coordinate of off-axis projection plane with zero parallax //! @param[in] theZFocus the z coordinate of off-axis projection plane with zero parallax
//! @param theEyeIndex [in] choose between L/R eyes //! @param[in] theEyeIndex choose between L/R eyes
template <typename Elem_t> template <typename Elem_t>
void stereoEyeProj (NCollection_Mat4<Elem_t>& theOutMx, void stereoEyeProj (NCollection_Mat4<Elem_t>& theOutMx,
const Aspect_FrustumLRBT<Elem_t>& theLRBT, const Aspect_FrustumLRBT<Elem_t>& theLRBT,
@ -799,10 +799,10 @@ private:
//! Construct "look at" orientation transformation. //! Construct "look at" orientation transformation.
//! Reference point differs for perspective and ortho modes //! Reference point differs for perspective and ortho modes
//! (made for compatibility, to be improved..). //! (made for compatibility, to be improved..).
//! @param theEye [in] the eye coordinates in 3D space. //! @param[in] theEye the eye coordinates in 3D space.
//! @param theFwdDir [in] view direction //! @param[in] theFwdDir view direction
//! @param theUpDir [in] the up direction vector. //! @param[in] theUpDir the up direction vector.
//! @param theAxialScale [in] the axial scale vector. //! @param[in] theAxialScale the axial scale vector.
//! @param theOutMx [in/out] the orientation matrix. //! @param theOutMx [in/out] the orientation matrix.
template <typename Elem_t> template <typename Elem_t>
static void static void

@ -59,27 +59,27 @@ public:
Standard_EXPORT Graphic3d_ClipPlane(); Standard_EXPORT Graphic3d_ClipPlane();
//! Copy constructor. //! Copy constructor.
//! @param theOther [in] the copied plane. //! @param[in] theOther the copied plane.
Standard_EXPORT Graphic3d_ClipPlane(const Graphic3d_ClipPlane& theOther); Standard_EXPORT Graphic3d_ClipPlane(const Graphic3d_ClipPlane& theOther);
//! Construct clip plane for the passed equation. //! Construct clip plane for the passed equation.
//! By default the plane is on, capping is turned off. //! By default the plane is on, capping is turned off.
//! @param theEquation [in] the plane equation. //! @param[in] theEquation the plane equation.
Standard_EXPORT Graphic3d_ClipPlane (const Graphic3d_Vec4d& theEquation); Standard_EXPORT Graphic3d_ClipPlane (const Graphic3d_Vec4d& theEquation);
//! Construct clip plane from the passed geometrical definition. //! Construct clip plane from the passed geometrical definition.
//! By default the plane is on, capping is turned off. //! By default the plane is on, capping is turned off.
//! @param thePlane [in] the plane. //! @param[in] thePlane the plane.
Standard_EXPORT Graphic3d_ClipPlane (const gp_Pln& thePlane); Standard_EXPORT Graphic3d_ClipPlane (const gp_Pln& thePlane);
//! Set plane equation by its geometrical definition. //! Set plane equation by its geometrical definition.
//! The equation is specified in "world" coordinate system. //! The equation is specified in "world" coordinate system.
//! @param thePlane [in] the plane. //! @param[in] thePlane the plane.
Standard_EXPORT void SetEquation (const gp_Pln& thePlane); Standard_EXPORT void SetEquation (const gp_Pln& thePlane);
//! Set 4-component equation vector for clipping plane. //! Set 4-component equation vector for clipping plane.
//! The equation is specified in "world" coordinate system. //! The equation is specified in "world" coordinate system.
//! @param theEquation [in] the XYZW (or "ABCD") equation vector. //! @param[in] theEquation the XYZW (or "ABCD") equation vector.
Standard_EXPORT void SetEquation (const Graphic3d_Vec4d& theEquation); Standard_EXPORT void SetEquation (const Graphic3d_Vec4d& theEquation);
//! Get 4-component equation vector for clipping plane. //! Get 4-component equation vector for clipping plane.
@ -98,12 +98,12 @@ public:
} }
//! Change state of the clipping plane. //! Change state of the clipping plane.
//! @param theIsOn [in] the flag specifying whether the graphic driver //! @param[in] theIsOn the flag specifying whether the graphic driver
//! clipping by this plane should be turned on or off. //! clipping by this plane should be turned on or off.
Standard_EXPORT void SetOn(const Standard_Boolean theIsOn); Standard_EXPORT void SetOn(const Standard_Boolean theIsOn);
//! Change state of capping surface rendering. //! Change state of capping surface rendering.
//! @param theIsOn [in] the flag specifying whether the graphic driver should //! @param[in] theIsOn the flag specifying whether the graphic driver should
//! perform rendering of capping surface produced by this plane. The graphic //! perform rendering of capping surface produced by this plane. The graphic
//! driver produces this surface for convex graphics by means of stencil-test //! driver produces this surface for convex graphics by means of stencil-test
//! and multi-pass rendering. //! and multi-pass rendering.
@ -172,14 +172,14 @@ public: // @name user-defined graphical attributes
Standard_EXPORT void SetCappingColor (const Quantity_Color& theColor); Standard_EXPORT void SetCappingColor (const Quantity_Color& theColor);
//! Set material for rendering capping surface. //! Set material for rendering capping surface.
//! @param theMat [in] the material. //! @param[in] theMat the material.
Standard_EXPORT void SetCappingMaterial (const Graphic3d_MaterialAspect& theMat); Standard_EXPORT void SetCappingMaterial (const Graphic3d_MaterialAspect& theMat);
//! @return capping material. //! @return capping material.
const Graphic3d_MaterialAspect& CappingMaterial() const { return myAspect->FrontMaterial(); } const Graphic3d_MaterialAspect& CappingMaterial() const { return myAspect->FrontMaterial(); }
//! Set texture to be applied on capping surface. //! Set texture to be applied on capping surface.
//! @param theTexture [in] the texture. //! @param[in] theTexture the texture.
Standard_EXPORT void SetCappingTexture (const Handle(Graphic3d_TextureMap)& theTexture); Standard_EXPORT void SetCappingTexture (const Handle(Graphic3d_TextureMap)& theTexture);
//! @return capping texture map. //! @return capping texture map.
@ -188,14 +188,14 @@ public: // @name user-defined graphical attributes
: Handle(Graphic3d_TextureMap)(); } : Handle(Graphic3d_TextureMap)(); }
//! Set hatch style (stipple) and turn hatching on. //! Set hatch style (stipple) and turn hatching on.
//! @param theStyle [in] the hatch style. //! @param[in] theStyle the hatch style.
Standard_EXPORT void SetCappingHatch (const Aspect_HatchStyle theStyle); Standard_EXPORT void SetCappingHatch (const Aspect_HatchStyle theStyle);
//! @return hatching style. //! @return hatching style.
Aspect_HatchStyle CappingHatch() const { return (Aspect_HatchStyle)myAspect->HatchStyle()->HatchType(); } Aspect_HatchStyle CappingHatch() const { return (Aspect_HatchStyle)myAspect->HatchStyle()->HatchType(); }
//! Set custom hatch style (stipple) and turn hatching on. //! Set custom hatch style (stipple) and turn hatching on.
//! @param theStyle [in] the hatch pattern. //! @param[in] theStyle the hatch pattern.
Standard_EXPORT void SetCappingCustomHatch (const Handle(Graphic3d_HatchStyle)& theStyle); Standard_EXPORT void SetCappingCustomHatch (const Handle(Graphic3d_HatchStyle)& theStyle);
//! @return hatching style. //! @return hatching style.

@ -59,8 +59,8 @@ public:
Standard_EXPORT Graphic3d_CullingTool(); Standard_EXPORT Graphic3d_CullingTool();
//! Retrieves view volume's planes equations and its vertices from projection and world-view matrices. //! Retrieves view volume's planes equations and its vertices from projection and world-view matrices.
//! @param theCamera [in] camera definition //! @param[in] theCamera camera definition
//! @param theModelWorld [in] optional object transformation for computing frustum in object local coordinate system //! @param[in] theModelWorld optional object transformation for computing frustum in object local coordinate system
Standard_EXPORT void SetViewVolume (const Handle(Graphic3d_Camera)& theCamera, Standard_EXPORT void SetViewVolume (const Handle(Graphic3d_Camera)& theCamera,
const Graphic3d_Mat4d& theModelWorld = Graphic3d_Mat4d()); const Graphic3d_Mat4d& theModelWorld = Graphic3d_Mat4d());
@ -81,10 +81,10 @@ public:
Standard_EXPORT void CacheClipPtsProjections(); Standard_EXPORT void CacheClipPtsProjections();
//! Checks whether given AABB should be entirely culled or not. //! Checks whether given AABB should be entirely culled or not.
//! @param theCtx [in] culling properties //! @param[in] theCtx culling properties
//! @param theMinPnt [in] maximum point of AABB //! @param[in] theMinPnt maximum point of AABB
//! @param theMaxPnt [in] minimum point of AABB //! @param[in] theMaxPnt minimum point of AABB
//! @param theIsInside [out] flag indicating if AABB is fully inside; initial value should be set to TRUE //! @param[out] theIsInside flag indicating if AABB is fully inside; initial value should be set to TRUE
//! @return TRUE if AABB is completely outside of view frustum or culled by size/distance; //! @return TRUE if AABB is completely outside of view frustum or culled by size/distance;
//! FALSE in case of partial or complete overlap (use theIsInside to distinguish) //! FALSE in case of partial or complete overlap (use theIsInside to distinguish)
bool IsCulled (const CullingContext& theCtx, bool IsCulled (const CullingContext& theCtx,
@ -137,15 +137,15 @@ public:
public: public:
//! Calculates signed distance from plane to point. //! Calculates signed distance from plane to point.
//! @param theNormal [in] the plane's normal. //! @param[in] theNormal the plane's normal.
//! @param thePnt [in] //! @param[in] thePnt
Standard_EXPORT Standard_Real SignedPlanePointDistance (const Graphic3d_Vec4d& theNormal, Standard_EXPORT Standard_Real SignedPlanePointDistance (const Graphic3d_Vec4d& theNormal,
const Graphic3d_Vec4d& thePnt); const Graphic3d_Vec4d& thePnt);
//! Detects if AABB overlaps view volume using separating axis theorem (SAT). //! Detects if AABB overlaps view volume using separating axis theorem (SAT).
//! @param theMinPnt [in] maximum point of AABB //! @param[in] theMinPnt maximum point of AABB
//! @param theMaxPnt [in] minimum point of AABB //! @param[in] theMaxPnt minimum point of AABB
//! @param theIsInside [out] flag indicating if AABB is fully inside; initial value should be set to TRUE //! @param[out] theIsInside flag indicating if AABB is fully inside; initial value should be set to TRUE
//! @return TRUE if AABB is completely outside of view frustum; //! @return TRUE if AABB is completely outside of view frustum;
//! FALSE in case of partial or complete overlap (use theIsInside to distinguish) //! FALSE in case of partial or complete overlap (use theIsInside to distinguish)
//! @sa SelectMgr_Frustum::hasOverlap() //! @sa SelectMgr_Frustum::hasOverlap()
@ -217,9 +217,9 @@ public:
} }
//! Returns TRUE if given AABB should be discarded by distance culling criterion. //! Returns TRUE if given AABB should be discarded by distance culling criterion.
//! @param theMinPnt [in] maximum point of AABB //! @param[in] theMinPnt maximum point of AABB
//! @param theMaxPnt [in] minimum point of AABB //! @param[in] theMaxPnt minimum point of AABB
//! @param theIsInside [out] flag indicating if AABB is fully inside; initial value should be set to TRUE //! @param[out] theIsInside flag indicating if AABB is fully inside; initial value should be set to TRUE
//! @return TRUE if AABB is completely behind culling distance; //! @return TRUE if AABB is completely behind culling distance;
//! FALSE in case of partial or complete overlap (use theIsInside to distinguish) //! FALSE in case of partial or complete overlap (use theIsInside to distinguish)
bool IsTooDistant (const CullingContext& theCtx, bool IsTooDistant (const CullingContext& theCtx,

@ -90,17 +90,17 @@ public:
//! Adds a layer to all views. //! Adds a layer to all views.
//! To add a structure to desired layer on display it is necessary to set the layer ID for the structure. //! To add a structure to desired layer on display it is necessary to set the layer ID for the structure.
//! @param theNewLayerId [in] id of new layer, should be > 0 (negative values are reserved for default layers). //! @param[in] theNewLayerId id of new layer, should be > 0 (negative values are reserved for default layers).
//! @param theSettings [in] new layer settings //! @param[in] theSettings new layer settings
//! @param theLayerAfter [in] id of layer to append new layer before //! @param[in] theLayerAfter id of layer to append new layer before
Standard_EXPORT virtual void InsertLayerBefore (const Graphic3d_ZLayerId theNewLayerId, Standard_EXPORT virtual void InsertLayerBefore (const Graphic3d_ZLayerId theNewLayerId,
const Graphic3d_ZLayerSettings& theSettings, const Graphic3d_ZLayerSettings& theSettings,
const Graphic3d_ZLayerId theLayerAfter) = 0; const Graphic3d_ZLayerId theLayerAfter) = 0;
//! Adds a layer to all views. //! Adds a layer to all views.
//! @param theNewLayerId [in] id of new layer, should be > 0 (negative values are reserved for default layers). //! @param[in] theNewLayerId id of new layer, should be > 0 (negative values are reserved for default layers).
//! @param theSettings [in] new layer settings //! @param[in] theSettings new layer settings
//! @param theLayerBefore [in] id of layer to append new layer after //! @param[in] theLayerBefore id of layer to append new layer after
Standard_EXPORT virtual void InsertLayerAfter (const Graphic3d_ZLayerId theNewLayerId, Standard_EXPORT virtual void InsertLayerAfter (const Graphic3d_ZLayerId theNewLayerId,
const Graphic3d_ZLayerSettings& theSettings, const Graphic3d_ZLayerSettings& theSettings,
const Graphic3d_ZLayerId theLayerBefore) = 0; const Graphic3d_ZLayerId theLayerBefore) = 0;

@ -30,8 +30,8 @@ class Graphic3d_GraphicDriverFactory : public Standard_Transient
public: public:
//! Registers factory. //! Registers factory.
//! @param theFactory [in] factory to register //! @param[in] theFactory factory to register
//! @param theIsPreferred [in] add to the beginning of the list when TRUE, or add to the end otherwise //! @param[in] theIsPreferred add to the beginning of the list when TRUE, or add to the end otherwise
Standard_EXPORT static void RegisterFactory (const Handle(Graphic3d_GraphicDriverFactory)& theFactory, Standard_EXPORT static void RegisterFactory (const Handle(Graphic3d_GraphicDriverFactory)& theFactory,
bool theIsPreferred = false); bool theIsPreferred = false);

@ -38,16 +38,16 @@ public:
public: public:
//! Constructor from existing pixmap. //! Constructor from existing pixmap.
//! @param theImage [in] source image //! @param[in] theImage source image
//! @param theImageAlpha [in] colorless image //! @param[in] theImageAlpha colorless image
Standard_EXPORT Graphic3d_MarkerImage (const Handle(Image_PixMap)& theImage, Standard_EXPORT Graphic3d_MarkerImage (const Handle(Image_PixMap)& theImage,
const Handle(Image_PixMap)& theImageAlpha = Handle(Image_PixMap)()); const Handle(Image_PixMap)& theImageAlpha = Handle(Image_PixMap)());
//! Creates marker image from array of bytes //! Creates marker image from array of bytes
//! (method for compatibility with old markers definition). //! (method for compatibility with old markers definition).
//! @param theBitMap [in] source bitmap stored as array of bytes //! @param[in] theBitMap source bitmap stored as array of bytes
//! @param theWidth [in] number of bits in a row //! @param[in] theWidth number of bits in a row
//! @param theHeight [in] number of bits in a column //! @param[in] theHeight number of bits in a column
Standard_EXPORT Graphic3d_MarkerImage (const Handle(TColStd_HArray1OfByte)& theBitMap, Standard_EXPORT Graphic3d_MarkerImage (const Handle(TColStd_HArray1OfByte)& theBitMap,
const Standard_Integer theWidth, const Standard_Integer theWidth,
const Standard_Integer theHeight); const Standard_Integer theHeight);
@ -81,7 +81,7 @@ public:
//! @param theAlphaValue pixels in the image that have alpha value greater than //! @param theAlphaValue pixels in the image that have alpha value greater than
//! or equal to this parameter will be stored in bitmap as "1", //! or equal to this parameter will be stored in bitmap as "1",
//! others will be stored as "0" //! others will be stored as "0"
//! @param theIsTopDown [in] flag indicating expected rows order in returned bitmap, which is bottom-up by default //! @param[in] theIsTopDown flag indicating expected rows order in returned bitmap, which is bottom-up by default
Standard_EXPORT Handle(TColStd_HArray1OfByte) GetBitMapArray (const Standard_Real theAlphaValue = 0.5, Standard_EXPORT Handle(TColStd_HArray1OfByte) GetBitMapArray (const Standard_Real theAlphaValue = 0.5,
const Standard_Boolean theIsTopDown = false) const; const Standard_Boolean theIsTopDown = false) const;

@ -44,8 +44,8 @@ public:
Standard_EXPORT static Graphic3d_TypeOfMaterial MaterialType (const Standard_Integer theRank); Standard_EXPORT static Graphic3d_TypeOfMaterial MaterialType (const Standard_Integer theRank);
//! Finds the material for specified name. //! Finds the material for specified name.
//! @param theName [in] name to find //! @param[in] theName name to find
//! @param theMat [out] found material //! @param[out] theMat found material
//! @return FALSE if name was unrecognized //! @return FALSE if name was unrecognized
Standard_EXPORT static Standard_Boolean MaterialFromName (const Standard_CString theName, Standard_EXPORT static Standard_Boolean MaterialFromName (const Standard_CString theName,
Graphic3d_NameOfMaterial& theMat); Graphic3d_NameOfMaterial& theMat);

@ -108,20 +108,20 @@ public:
//! Generates 2D look up table of scale and bias for fresnell zero coefficient. //! Generates 2D look up table of scale and bias for fresnell zero coefficient.
//! It is needed for calculation reflectance part of environment lighting. //! It is needed for calculation reflectance part of environment lighting.
//! @param [out] theLUT table storage (must be Image_Format_RGF). //! @param[out] theLUT table storage (must be Image_Format_RGF).
//! @param [in] theNbIntegralSamples number of importance samples in hemisphere integral calculation for every table item. //! @param[in] theNbIntegralSamples number of importance samples in hemisphere integral calculation for every table item.
Standard_EXPORT static void GenerateEnvLUT (const Handle(Image_PixMap)& theLUT, Standard_EXPORT static void GenerateEnvLUT (const Handle(Image_PixMap)& theLUT,
unsigned int theNbIntegralSamples = 1024); unsigned int theNbIntegralSamples = 1024);
//! Compute material roughness from common material (specular color + shininess). //! Compute material roughness from common material (specular color + shininess).
//! @param theSpecular [in] specular color //! @param[in] theSpecular specular color
//! @param theShiness [in] normalized shininess coefficient within [0..1] range //! @param[in] theShiness normalized shininess coefficient within [0..1] range
//! @return roughness within [0..1] range //! @return roughness within [0..1] range
Standard_EXPORT static Standard_ShortReal RoughnessFromSpecular (const Quantity_Color& theSpecular, Standard_EXPORT static Standard_ShortReal RoughnessFromSpecular (const Quantity_Color& theSpecular,
const Standard_Real theShiness); const Standard_Real theShiness);
//! Compute material metallicity from common material (specular color). //! Compute material metallicity from common material (specular color).
//! @param theSpecular [in] specular color //! @param[in] theSpecular specular color
//! @return metallicity within [0..1] range //! @return metallicity within [0..1] range
static Standard_ShortReal MetallicFromSpecular (const Quantity_Color& theSpecular) static Standard_ShortReal MetallicFromSpecular (const Quantity_Color& theSpecular)
{ {

@ -104,8 +104,8 @@ public:
protected: protected:
//! Generate map key for light sources configuration. //! Generate map key for light sources configuration.
//! @param theLights [in] list of light sources //! @param[in] theLights list of light sources
//! @param theHasShadowMap [in] flag indicating shadow maps usage //! @param[in] theHasShadowMap flag indicating shadow maps usage
Standard_EXPORT TCollection_AsciiString genLightKey (const Handle(Graphic3d_LightSet)& theLights, Standard_EXPORT TCollection_AsciiString genLightKey (const Handle(Graphic3d_LightSet)& theLights,
const bool theHasShadowMap) const; const bool theHasShadowMap) const;
@ -113,23 +113,23 @@ protected:
Standard_EXPORT Handle(Graphic3d_ShaderProgram) getStdProgramFont() const; Standard_EXPORT Handle(Graphic3d_ShaderProgram) getStdProgramFont() const;
//! Prepare standard GLSL program without lighting. //! Prepare standard GLSL program without lighting.
//! @param theBits [in] program bits //! @param[in] theBits program bits
//! @param theIsOutline [in] draw silhouette //! @param[in] theIsOutline draw silhouette
Standard_EXPORT Handle(Graphic3d_ShaderProgram) getStdProgramUnlit (Standard_Integer theBits, Standard_EXPORT Handle(Graphic3d_ShaderProgram) getStdProgramUnlit (Standard_Integer theBits,
Standard_Boolean theIsOutline = false) const; Standard_Boolean theIsOutline = false) const;
//! Prepare standard GLSL program with per-vertex lighting. //! Prepare standard GLSL program with per-vertex lighting.
//! @param theLights [in] list of light sources //! @param[in] theLights list of light sources
//! @param theBits [in] program bits //! @param[in] theBits program bits
Standard_EXPORT Handle(Graphic3d_ShaderProgram) getStdProgramGouraud (const Handle(Graphic3d_LightSet)& theLights, Standard_EXPORT Handle(Graphic3d_ShaderProgram) getStdProgramGouraud (const Handle(Graphic3d_LightSet)& theLights,
Standard_Integer theBits) const; Standard_Integer theBits) const;
//! Prepare standard GLSL program with per-pixel lighting. //! Prepare standard GLSL program with per-pixel lighting.
//! @param theLights [in] list of light sources //! @param[in] theLights list of light sources
//! @param theBits [in] program bits //! @param[in] theBits program bits
//! @param theIsFlatNormal [in] when TRUE, the Vertex normals will be ignored and Face normal will be computed instead //! @param[in] theIsFlatNormal when TRUE, the Vertex normals will be ignored and Face normal will be computed instead
//! @param theIsPBR [in] when TRUE, the PBR pipeline will be activated //! @param[in] theIsPBR when TRUE, the PBR pipeline will be activated
//! @param theNbShadowMaps [in] number of shadow maps //! @param[in] theNbShadowMaps number of shadow maps
Standard_EXPORT Handle(Graphic3d_ShaderProgram) getStdProgramPhong (const Handle(Graphic3d_LightSet)& theLights, Standard_EXPORT Handle(Graphic3d_ShaderProgram) getStdProgramPhong (const Handle(Graphic3d_LightSet)& theLights,
const Standard_Integer theBits, const Standard_Integer theBits,
const Standard_Boolean theIsFlatNormal, const Standard_Boolean theIsFlatNormal,
@ -173,10 +173,10 @@ protected:
Standard_EXPORT bool hasGlslBitwiseOps() const; Standard_EXPORT bool hasGlslBitwiseOps() const;
//! Prepare GLSL version header. //! Prepare GLSL version header.
//! @param theProgram [in] [out] program to set version header //! @param[in][out] theProgram program to set version header
//! @param theName [in] program id suffix //! @param[in] theName program id suffix
//! @param theBits [in] program bits //! @param[in] theBits program bits
//! @param theUsesDerivates [in] program uses standard derivatives functions or not //! @param[in] theUsesDerivates program uses standard derivatives functions or not
//! @return filtered program bits with unsupported features disabled //! @return filtered program bits with unsupported features disabled
Standard_EXPORT Standard_Integer defaultGlslVersion (const Handle(Graphic3d_ShaderProgram)& theProgram, Standard_EXPORT Standard_Integer defaultGlslVersion (const Handle(Graphic3d_ShaderProgram)& theProgram,
const TCollection_AsciiString& theName, const TCollection_AsciiString& theName,
@ -184,9 +184,9 @@ protected:
bool theUsesDerivates = false) const; bool theUsesDerivates = false) const;
//! Prepare GLSL version header for OIT composition programs. //! Prepare GLSL version header for OIT composition programs.
//! @param theProgram [in] [out] program to set version header //! @param[in][out] theProgram program to set version header
//! @param theName [in] program id suffix //! @param[in] theName program id suffix
//! @param theMsaa [in] multisampling flag //! @param[in] theMsaa multisampling flag
Standard_EXPORT void defaultOitGlslVersion (const Handle(Graphic3d_ShaderProgram)& theProgram, Standard_EXPORT void defaultOitGlslVersion (const Handle(Graphic3d_ShaderProgram)& theProgram,
const TCollection_AsciiString& theName, const TCollection_AsciiString& theName,
bool theMsaa) const; bool theMsaa) const;
@ -199,12 +199,12 @@ protected:
Standard_Integer theBits) const; Standard_Integer theBits) const;
//! Define computeLighting GLSL function depending on current lights configuration //! Define computeLighting GLSL function depending on current lights configuration
//! @param theNbLights [out] number of defined light sources //! @param[out] theNbLights number of defined light sources
//! @param theLights [in] light sources list //! @param[in] theLights light sources list
//! @param theHasVertColor [in] flag to use getVertColor() instead of Ambient and Diffuse components of active material //! @param[in] theHasVertColor flag to use getVertColor() instead of Ambient and Diffuse components of active material
//! @param theIsPBR [in] flag to activate PBR pipeline //! @param[in] theIsPBR flag to activate PBR pipeline
//! @param theHasTexColor [in] flag to include color texturing //! @param[in] theHasTexColor flag to include color texturing
//! @param theNbShadowMaps [in] flag to include shadow map //! @param[in] theNbShadowMaps flag to include shadow map
Standard_EXPORT TCollection_AsciiString stdComputeLighting (Standard_Integer& theNbLights, Standard_EXPORT TCollection_AsciiString stdComputeLighting (Standard_Integer& theNbLights,
const Handle(Graphic3d_LightSet)& theLights, const Handle(Graphic3d_LightSet)& theLights,
Standard_Boolean theHasVertColor, Standard_Boolean theHasVertColor,

@ -95,8 +95,8 @@ public:
virtual void Erase() { erase(); } virtual void Erase() { erase(); }
//! Highlights the structure in all the views with the given style //! Highlights the structure in all the views with the given style
//! @param theStyle [in] the style (type of highlighting: box/color, color and opacity) //! @param[in] theStyle the style (type of highlighting: box/color, color and opacity)
//! @param theToUpdateMgr [in] defines whether related computed structures will be //! @param[in] theToUpdateMgr defines whether related computed structures will be
//! highlighted via structure manager or not //! highlighted via structure manager or not
Standard_EXPORT void Highlight (const Handle(Graphic3d_PresentationAttributes)& theStyle, const Standard_Boolean theToUpdateMgr = Standard_True); Standard_EXPORT void Highlight (const Handle(Graphic3d_PresentationAttributes)& theStyle, const Standard_Boolean theToUpdateMgr = Standard_True);
@ -130,7 +130,7 @@ public:
Graphic3d_ZLayerId GetZLayer() const { return myCStructure->ZLayer(); } Graphic3d_ZLayerId GetZLayer() const { return myCStructure->ZLayer(); }
//! Changes a sequence of clip planes slicing the structure on rendering. //! Changes a sequence of clip planes slicing the structure on rendering.
//! @param thePlanes [in] the set of clip planes. //! @param[in] thePlanes the set of clip planes.
void SetClipPlanes (const Handle(Graphic3d_SequenceOfHClipPlane)& thePlanes) void SetClipPlanes (const Handle(Graphic3d_SequenceOfHClipPlane)& thePlanes)
{ {
if (!myCStructure.IsNull()) { myCStructure->SetClipPlanes (thePlanes); } if (!myCStructure.IsNull()) { myCStructure->SetClipPlanes (thePlanes); }

@ -83,7 +83,7 @@ public:
//! This method will be called by graphic driver each time when texture resource should be created. //! This method will be called by graphic driver each time when texture resource should be created.
//! It is called in front of GetImage() for uploading compressed image formats natively supported by GPU. //! It is called in front of GetImage() for uploading compressed image formats natively supported by GPU.
//! @param theSupported [in] the list of supported compressed texture formats; //! @param[in] theSupported the list of supported compressed texture formats;
//! returning image in unsupported format will result in texture upload failure //! returning image in unsupported format will result in texture upload failure
//! @return compressed pixmap or NULL if image is not in supported compressed format //! @return compressed pixmap or NULL if image is not in supported compressed format
Standard_EXPORT virtual Handle(Image_CompressedPixMap) GetCompressedImage (const Handle(Image_SupportedFormats)& theSupported); Standard_EXPORT virtual Handle(Image_CompressedPixMap) GetCompressedImage (const Handle(Image_SupportedFormats)& theSupported);

@ -244,9 +244,9 @@ public:
public: public:
//! Find scale value based on the camera position and view dimensions //! Find scale value based on the camera position and view dimensions
//! @param theCamera [in] camera definition //! @param[in] theCamera camera definition
//! @param theViewportWidth [in] the width of viewport. //! @param[in] theViewportWidth the width of viewport.
//! @param theViewportHeight [in] the height of viewport. //! @param[in] theViewportHeight the height of viewport.
virtual Standard_Real persistentScale (const Handle(Graphic3d_Camera)& theCamera, virtual Standard_Real persistentScale (const Handle(Graphic3d_Camera)& theCamera,
const Standard_Integer theViewportWidth, const Standard_Integer theViewportWidth,
const Standard_Integer theViewportHeight) const const Standard_Integer theViewportHeight) const
@ -265,9 +265,9 @@ public:
//! Create orientation matrix based on camera and view dimensions. //! Create orientation matrix based on camera and view dimensions.
//! Default implementation locks rotation by nullifying rotation component. //! Default implementation locks rotation by nullifying rotation component.
//! Camera and view dimensions are not used, by default. //! Camera and view dimensions are not used, by default.
//! @param theCamera [in] camera definition //! @param[in] theCamera camera definition
//! @param theViewportWidth [in] the width of viewport //! @param[in] theViewportWidth the width of viewport
//! @param theViewportHeight [in] the height of viewport //! @param[in] theViewportHeight the height of viewport
virtual NCollection_Mat3<Standard_Real> persistentRotationMatrix (const Handle(Graphic3d_Camera)& theCamera, virtual NCollection_Mat3<Standard_Real> persistentRotationMatrix (const Handle(Graphic3d_Camera)& theCamera,
const Standard_Integer theViewportWidth, const Standard_Integer theViewportWidth,
const Standard_Integer theViewportHeight) const const Standard_Integer theViewportHeight) const
@ -281,11 +281,11 @@ public:
} }
//! Apply transformation to bounding box of presentation. //! Apply transformation to bounding box of presentation.
//! @param theCamera [in] camera definition //! @param[in] theCamera camera definition
//! @param theProjection [in] the projection transformation matrix. //! @param[in] theProjection the projection transformation matrix.
//! @param theWorldView [in] the world view transformation matrix. //! @param[in] theWorldView the world view transformation matrix.
//! @param theViewportWidth [in] the width of viewport (for 2d persistence). //! @param[in] theViewportWidth the width of viewport (for 2d persistence).
//! @param theViewportHeight [in] the height of viewport (for 2d persistence). //! @param[in] theViewportHeight the height of viewport (for 2d persistence).
//! @param theBoundingBox [in/out] the bounding box to transform. //! @param theBoundingBox [in/out] the bounding box to transform.
template<class T> template<class T>
void Apply (const Handle(Graphic3d_Camera)& theCamera, void Apply (const Handle(Graphic3d_Camera)& theCamera,
@ -296,11 +296,11 @@ public:
Bnd_Box& theBoundingBox) const; Bnd_Box& theBoundingBox) const;
//! Apply transformation to bounding box of presentation //! Apply transformation to bounding box of presentation
//! @param theCamera [in] camera definition //! @param[in] theCamera camera definition
//! @param theProjection [in] the projection transformation matrix. //! @param[in] theProjection the projection transformation matrix.
//! @param theWorldView [in] the world view transformation matrix. //! @param[in] theWorldView the world view transformation matrix.
//! @param theViewportWidth [in] the width of viewport (for 2d persistence). //! @param[in] theViewportWidth the width of viewport (for 2d persistence).
//! @param theViewportHeight [in] the height of viewport (for 2d persistence). //! @param[in] theViewportHeight the height of viewport (for 2d persistence).
//! @param theBoundingBox [in/out] the bounding box to transform. //! @param theBoundingBox [in/out] the bounding box to transform.
template<class T> template<class T>
void Apply (const Handle(Graphic3d_Camera)& theCamera, void Apply (const Handle(Graphic3d_Camera)& theCamera,
@ -313,12 +313,12 @@ public:
//! Compute transformation. //! Compute transformation.
//! Computed matrix can be applied to model world transformation //! Computed matrix can be applied to model world transformation
//! of an object to implement effect of transformation persistence. //! of an object to implement effect of transformation persistence.
//! @param theCamera [in] camera definition //! @param[in] theCamera camera definition
//! @param theProjection [in] the projection transformation matrix. //! @param[in] theProjection the projection transformation matrix.
//! @param theWorldView [in] the world view transformation matrix. //! @param[in] theWorldView the world view transformation matrix.
//! @param theViewportWidth [in] the width of viewport (for 2d persistence). //! @param[in] theViewportWidth the width of viewport (for 2d persistence).
//! @param theViewportHeight [in] the height of viewport (for 2d persistence). //! @param[in] theViewportHeight the height of viewport (for 2d persistence).
//! @param theToApplyProjPers [in] if should apply projection persistence to matrix (for orthographic persistence). //! @param[in] theToApplyProjPers if should apply projection persistence to matrix (for orthographic persistence).
//! @return transformation matrix to be applied to model world transformation of an object. //! @return transformation matrix to be applied to model world transformation of an object.
template<class T> template<class T>
NCollection_Mat4<T> Compute (const Handle(Graphic3d_Camera)& theCamera, NCollection_Mat4<T> Compute (const Handle(Graphic3d_Camera)& theCamera,
@ -329,13 +329,13 @@ public:
const Standard_Boolean theToApplyProjPers = false) const; const Standard_Boolean theToApplyProjPers = false) const;
//! Apply transformation persistence on specified matrices. //! Apply transformation persistence on specified matrices.
//! @param theCamera [in] camera definition //! @param[in] theCamera camera definition
//! @param theProjection [in] projection matrix to modify //! @param[in] theProjection projection matrix to modify
//! @param theWorldView [in/out] world-view matrix to modify //! @param theWorldView [in/out] world-view matrix to modify
//! @param theViewportWidth [in] viewport width //! @param[in] theViewportWidth viewport width
//! @param theViewportHeight [in] viewport height //! @param[in] theViewportHeight viewport height
//! @param theAnchor [in] if not NULL, overrides anchor point //! @param[in] theAnchor if not NULL, overrides anchor point
//! @param theToApplyProjPers [in] if should apply projection persistence to matrix (for orthographic persistence). //! @param[in] theToApplyProjPers if should apply projection persistence to matrix (for orthographic persistence).
template<class T> template<class T>
void Apply (const Handle(Graphic3d_Camera)& theCamera, void Apply (const Handle(Graphic3d_Camera)& theCamera,
const NCollection_Mat4<T>& theProjection, const NCollection_Mat4<T>& theProjection,
@ -346,10 +346,10 @@ public:
const Standard_Boolean theToApplyProjPers = true) const; const Standard_Boolean theToApplyProjPers = true) const;
//! Perform computations for applying transformation persistence on specified matrices. //! Perform computations for applying transformation persistence on specified matrices.
//! @param theCamera [in] camera definition //! @param[in] theCamera camera definition
//! @param theViewportWidth [in] viewport width //! @param[in] theViewportWidth viewport width
//! @param theViewportHeight [in] viewport height //! @param[in] theViewportHeight viewport height
//! @param theAnchor [in] if not NULL, overrides anchor point //! @param[in] theAnchor if not NULL, overrides anchor point
virtual NCollection_Mat4<Standard_Real> ComputeApply (Handle(Graphic3d_Camera)& theCamera, virtual NCollection_Mat4<Standard_Real> ComputeApply (Handle(Graphic3d_Camera)& theCamera,
const Standard_Integer theViewportWidth, const Standard_Integer theViewportWidth,
const Standard_Integer theViewportHeight, const Standard_Integer theViewportHeight,

@ -32,9 +32,9 @@ public:
//! Find scale value based on the camera position and view dimensions //! Find scale value based on the camera position and view dimensions
//! If the camera scale value less than the persistence scale, zoom persistence is not applied. //! If the camera scale value less than the persistence scale, zoom persistence is not applied.
//! @param theCamera [in] camera definition //! @param[in] theCamera camera definition
//! @param theViewportWidth [in] the width of viewport. //! @param[in] theViewportWidth the width of viewport.
//! @param theViewportHeight [in] the height of viewport. //! @param[in] theViewportHeight the height of viewport.
Standard_EXPORT virtual Standard_Real persistentScale (const Handle(Graphic3d_Camera)& theCamera, Standard_EXPORT virtual Standard_Real persistentScale (const Handle(Graphic3d_Camera)& theCamera,
const Standard_Integer theViewportWidth, const Standard_Integer theViewportWidth,
const Standard_Integer theViewportHeight) const Standard_OVERRIDE; const Standard_Integer theViewportHeight) const Standard_OVERRIDE;

@ -32,9 +32,9 @@ public:
} }
//! Constructor for custom projector type. //! Constructor for custom projector type.
//! @param theProjectionState [in] the projection state. //! @param[in] theProjectionState the projection state.
//! @param theWorldViewState [in] the world view state. //! @param[in] theWorldViewState the world view state.
//! @param theCamera [in] the pointer to the class supplying projection and //! @param[in] theCamera the pointer to the class supplying projection and
//! world view matrices (camera). //! world view matrices (camera).
Graphic3d_WorldViewProjState (const Standard_Size theProjectionState, Graphic3d_WorldViewProjState (const Standard_Size theProjectionState,
const Standard_Size theWorldViewState, const Standard_Size theWorldViewState,

@ -47,7 +47,7 @@ public:
//! @param[in] thePath path to the import CAD file //! @param[in] thePath path to the import CAD file
//! @param[out] theDocument document to save result //! @param[out] theDocument document to save result
//! @param[in] theWS current work session //! @param[in] theWS current work session
//! @param theProgress[in] progress indicator //! @param[in] theProgress progress indicator
//! @return true if Read operation has ended correctly //! @return true if Read operation has ended correctly
Standard_EXPORT virtual bool Read(const TCollection_AsciiString& thePath, Standard_EXPORT virtual bool Read(const TCollection_AsciiString& thePath,
const Handle(TDocStd_Document)& theDocument, const Handle(TDocStd_Document)& theDocument,
@ -58,7 +58,7 @@ public:
//! @param[in] thePath path to the export CAD file //! @param[in] thePath path to the export CAD file
//! @param[out] theDocument document to export //! @param[out] theDocument document to export
//! @param[in] theWS current work session //! @param[in] theWS current work session
//! @param theProgress[in] progress indicator //! @param[in] theProgress progress indicator
//! @return true if Write operation has ended correctly //! @return true if Write operation has ended correctly
Standard_EXPORT virtual bool Write(const TCollection_AsciiString& thePath, Standard_EXPORT virtual bool Write(const TCollection_AsciiString& thePath,
const Handle(TDocStd_Document)& theDocument, const Handle(TDocStd_Document)& theDocument,
@ -68,7 +68,7 @@ public:
//! Reads a CAD file, according internal configuration //! Reads a CAD file, according internal configuration
//! @param[in] thePath path to the import CAD file //! @param[in] thePath path to the import CAD file
//! @param[out] theDocument document to save result //! @param[out] theDocument document to save result
//! @param theProgress[in] progress indicator //! @param[in] theProgress progress indicator
//! @return true if Read operation has ended correctly //! @return true if Read operation has ended correctly
Standard_EXPORT virtual bool Read(const TCollection_AsciiString& thePath, Standard_EXPORT virtual bool Read(const TCollection_AsciiString& thePath,
const Handle(TDocStd_Document)& theDocument, const Handle(TDocStd_Document)& theDocument,
@ -77,7 +77,7 @@ public:
//! Writes a CAD file, according internal configuration //! Writes a CAD file, according internal configuration
//! @param[in] thePath path to the export CAD file //! @param[in] thePath path to the export CAD file
//! @param[out] theDocument document to export //! @param[out] theDocument document to export
//! @param theProgress[in] progress indicator //! @param[in] theProgress progress indicator
//! @return true if Write operation has ended correctly //! @return true if Write operation has ended correctly
Standard_EXPORT virtual bool Write(const TCollection_AsciiString& thePath, Standard_EXPORT virtual bool Write(const TCollection_AsciiString& thePath,
const Handle(TDocStd_Document)& theDocument, const Handle(TDocStd_Document)& theDocument,
@ -87,7 +87,7 @@ public:
//! @param[in] thePath path to the import CAD file //! @param[in] thePath path to the import CAD file
//! @param[out] theShape shape to save result //! @param[out] theShape shape to save result
//! @param[in] theWS current work session //! @param[in] theWS current work session
//! @param theProgress[in] progress indicator //! @param[in] theProgress progress indicator
//! @return true if Read operation has ended correctly //! @return true if Read operation has ended correctly
Standard_EXPORT virtual bool Read(const TCollection_AsciiString& thePath, Standard_EXPORT virtual bool Read(const TCollection_AsciiString& thePath,
TopoDS_Shape& theShape, TopoDS_Shape& theShape,
@ -98,7 +98,7 @@ public:
//! @param[in] thePath path to the export CAD file //! @param[in] thePath path to the export CAD file
//! @param[out] theShape shape to export //! @param[out] theShape shape to export
//! @param[in] theWS current work session //! @param[in] theWS current work session
//! @param theProgress[in] progress indicator //! @param[in] theProgress progress indicator
//! @return true if Write operation has ended correctly //! @return true if Write operation has ended correctly
Standard_EXPORT virtual bool Write(const TCollection_AsciiString& thePath, Standard_EXPORT virtual bool Write(const TCollection_AsciiString& thePath,
const TopoDS_Shape& theShape, const TopoDS_Shape& theShape,
@ -108,7 +108,7 @@ public:
//! Reads a CAD file, according internal configuration //! Reads a CAD file, according internal configuration
//! @param[in] thePath path to the import CAD file //! @param[in] thePath path to the import CAD file
//! @param[out] theShape shape to save result //! @param[out] theShape shape to save result
//! @param theProgress[in] progress indicator //! @param[in] theProgress progress indicator
//! @return true if Read operation has ended correctly //! @return true if Read operation has ended correctly
Standard_EXPORT virtual bool Read(const TCollection_AsciiString& thePath, Standard_EXPORT virtual bool Read(const TCollection_AsciiString& thePath,
TopoDS_Shape& theShape, TopoDS_Shape& theShape,
@ -117,7 +117,7 @@ public:
//! Writes a CAD file, according internal configuration //! Writes a CAD file, according internal configuration
//! @param[in] thePath path to the export CAD file //! @param[in] thePath path to the export CAD file
//! @param[out] theShape shape to export //! @param[out] theShape shape to export
//! @param theProgress[in] progress indicator //! @param[in] theProgress progress indicator
//! @return true if Write operation has ended correctly //! @return true if Write operation has ended correctly
Standard_EXPORT virtual bool Write(const TCollection_AsciiString& thePath, Standard_EXPORT virtual bool Write(const TCollection_AsciiString& thePath,
const TopoDS_Shape& theShape, const TopoDS_Shape& theShape,

@ -35,44 +35,44 @@ public:
DEFINE_STANDARD_RTTIEXT(IVtk_IShapeData,IVtk_Interface) DEFINE_STANDARD_RTTIEXT(IVtk_IShapeData,IVtk_Interface)
//! Insert a coordinate //! Insert a coordinate
//! @param [in] thePnt point position //! @param[in] thePnt point position
//! @param [in] theNorm point normal //! @param[in] theNorm point normal
//! @return id of added point //! @return id of added point
virtual IVtk_PointId InsertPoint (const gp_Pnt& thePnt, virtual IVtk_PointId InsertPoint (const gp_Pnt& thePnt,
const NCollection_Vec3<float>& theNorm) = 0; const NCollection_Vec3<float>& theNorm) = 0;
//! Insert a vertex. //! Insert a vertex.
//! @param [in] theShapeID id of the sub-shape to which the vertex belongs. //! @param[in] theShapeID id of the sub-shape to which the vertex belongs.
//! @param [in] thePointId id of the point that defines the coordinates of the vertex //! @param[in] thePointId id of the point that defines the coordinates of the vertex
//! @param [in] theMeshType mesh type of the sub-shape (MT_Undefined by default) //! @param[in] theMeshType mesh type of the sub-shape (MT_Undefined by default)
virtual void InsertVertex (const IVtk_IdType theShapeID, virtual void InsertVertex (const IVtk_IdType theShapeID,
const IVtk_PointId thePointId, const IVtk_PointId thePointId,
const IVtk_MeshType theMeshType = MT_Undefined) = 0; const IVtk_MeshType theMeshType = MT_Undefined) = 0;
//! Insert a line. //! Insert a line.
//! @param [in] theShapeID id of the subshape to which the line belongs. //! @param[in] theShapeID id of the subshape to which the line belongs.
//! @param [in] thePointId1 id of the first point //! @param[in] thePointId1 id of the first point
//! @param [in] thePointId2 id of the second point //! @param[in] thePointId2 id of the second point
//! @param [in] theMeshType mesh type of the subshape (MT_Undefined by default) //! @param[in] theMeshType mesh type of the subshape (MT_Undefined by default)
virtual void InsertLine (const IVtk_IdType theShapeID, virtual void InsertLine (const IVtk_IdType theShapeID,
const IVtk_PointId thePointId1, const IVtk_PointId thePointId1,
const IVtk_PointId thePointId2, const IVtk_PointId thePointId2,
const IVtk_MeshType theMeshType = MT_Undefined) = 0; const IVtk_MeshType theMeshType = MT_Undefined) = 0;
//! Insert a poly-line. //! Insert a poly-line.
//! @param [in] shapeID id of the subshape to which the polyline belongs. //! @param[in] shapeID id of the subshape to which the polyline belongs.
//! @param [in] pointIds vector of point ids //! @param[in] pointIds vector of point ids
//! @param [in] meshType mesh type of the subshape (MT_Undefined by default) //! @param[in] meshType mesh type of the subshape (MT_Undefined by default)
virtual void InsertLine (const IVtk_IdType theShapeID, virtual void InsertLine (const IVtk_IdType theShapeID,
const IVtk_PointIdList* thePointIds, const IVtk_PointIdList* thePointIds,
const IVtk_MeshType theMeshType = MT_Undefined) = 0; const IVtk_MeshType theMeshType = MT_Undefined) = 0;
//! Insert a triangle //! Insert a triangle
//! @param [in] theShapeID id of the subshape to which the triangle belongs. //! @param[in] theShapeID id of the subshape to which the triangle belongs.
//! @param [in] thePointId1 id of the first point //! @param[in] thePointId1 id of the first point
//! @param [in] thePointId2 id of the second point //! @param[in] thePointId2 id of the second point
//! @param [in] thePointId3 id of the third point //! @param[in] thePointId3 id of the third point
//! @param [in] theMeshType mesh type of the subshape (MT_Undefined by default) //! @param[in] theMeshType mesh type of the subshape (MT_Undefined by default)
virtual void InsertTriangle (const IVtk_IdType theShapeID, virtual void InsertTriangle (const IVtk_IdType theShapeID,
const IVtk_PointId thePointId1, const IVtk_PointId thePointId1,
const IVtk_PointId thePointId2, const IVtk_PointId thePointId2,
@ -82,9 +82,9 @@ public:
public: public:
//! Insert a coordinate //! Insert a coordinate
//! @param [in] theX X coordinate //! @param[in] theX X coordinate
//! @param [in] theY Y coordinate //! @param[in] theY Y coordinate
//! @param [in] theZ Z coordinate //! @param[in] theZ Z coordinate
//! @return id of added point //! @return id of added point
virtual IVtk_PointId InsertCoordinate (double theX, double theY, double theZ) virtual IVtk_PointId InsertCoordinate (double theX, double theY, double theZ)
{ {
@ -92,7 +92,7 @@ public:
} }
//! Insert a coordinate //! Insert a coordinate
//! @param [in] thePnt point position //! @param[in] thePnt point position
//! @return id of added point //! @return id of added point
IVtk_PointId InsertCoordinate (const gp_Pnt& thePnt) IVtk_PointId InsertCoordinate (const gp_Pnt& thePnt)
{ {

@ -32,8 +32,8 @@ public:
virtual ~IVtk_IShapeMesher() { } virtual ~IVtk_IShapeMesher() { }
//! Main entry point for building shape representation //! Main entry point for building shape representation
//! @param [in] shape IShape to be meshed //! @param[in] shape IShape to be meshed
//! @param [in] data IShapeData interface visualization data is passed to. //! @param[in] data IShapeData interface visualization data is passed to.
Standard_EXPORT void Build (const IVtk_IShape::Handle& theShape, const IVtk_IShapeData::Handle& theData); Standard_EXPORT void Build (const IVtk_IShape::Handle& theShape, const IVtk_IShapeData::Handle& theData);
DEFINE_STANDARD_RTTIEXT(IVtk_IShapeMesher,IVtk_Interface) DEFINE_STANDARD_RTTIEXT(IVtk_IShapeMesher,IVtk_Interface)

@ -37,7 +37,7 @@ public:
virtual int NbPicked() = 0; virtual int NbPicked() = 0;
//! Get activated selection modes for a shape. //! Get activated selection modes for a shape.
//! @param [in] theShape a shape with activated selection mode(s) //! @param[in] theShape a shape with activated selection mode(s)
//! @return list of active selection modes //! @return list of active selection modes
virtual IVtk_SelectionModeList GetSelectionModes (const IVtk_IShape::Handle& theShape) const = 0; virtual IVtk_SelectionModeList GetSelectionModes (const IVtk_IShape::Handle& theShape) const = 0;
@ -46,9 +46,9 @@ public: // @name Set selectable shapes and selection modes
//! Activates/deactivates the given selection mode for the shape. //! Activates/deactivates the given selection mode for the shape.
//! If mode == SM_None, the shape becomes non-selectable and //! If mode == SM_None, the shape becomes non-selectable and
//! is removed from the internal selection data. //! is removed from the internal selection data.
//! @param [in] theShape Shape for which the selection mode should be activated //! @param[in] theShape Shape for which the selection mode should be activated
//! @param [in] theMode Selection mode to be activated //! @param[in] theMode Selection mode to be activated
//! @param [in] theIsTurnOn Flag to turn on/off the selection mode //! @param[in] theIsTurnOn Flag to turn on/off the selection mode
virtual void SetSelectionMode (const IVtk_IShape::Handle& theShape, virtual void SetSelectionMode (const IVtk_IShape::Handle& theShape,
const IVtk_SelectionMode theMode, const IVtk_SelectionMode theMode,
const bool theIsTurnOn = true) = 0; const bool theIsTurnOn = true) = 0;
@ -56,9 +56,9 @@ public: // @name Set selectable shapes and selection modes
//! Activates/deactivates the given selection mode for the shape. //! Activates/deactivates the given selection mode for the shape.
//! If mode == SM_None, the shape becomes non-selectable and //! If mode == SM_None, the shape becomes non-selectable and
//! is removed from the internal selection data. //! is removed from the internal selection data.
//! @param [in] theShapes List of shapes for which the selection mode should be activated //! @param[in] theShapes List of shapes for which the selection mode should be activated
//! @param [in] theMode Selection mode to be activated //! @param[in] theMode Selection mode to be activated
//! @param [in] theIsTurnOn Flag to turn on/off the selection mode //! @param[in] theIsTurnOn Flag to turn on/off the selection mode
virtual void SetSelectionMode (const IVtk_ShapePtrList& theShapes, virtual void SetSelectionMode (const IVtk_ShapePtrList& theShapes,
const IVtk_SelectionMode theMode, const IVtk_SelectionMode theMode,
const bool theIsTurnOn = true) = 0; const bool theIsTurnOn = true) = 0;
@ -80,8 +80,8 @@ public: // @name Obtain picking results
//! is the first in the list) //! is the first in the list)
virtual const IVtk_ShapeIdList& ShapesPicked() const = 0; virtual const IVtk_ShapeIdList& ShapesPicked() const = 0;
//! @param [in] theId Top-level shape ID //! @param[in] theId Top-level shape ID
//! @param [out] theShapeList the list of picked sub-shape IDs for the given top-level shape ID, //! @param[out] theShapeList the list of picked sub-shape IDs for the given top-level shape ID,
//! in the order of increasing depth (the ID of the sub-shape closest to the eye //! in the order of increasing depth (the ID of the sub-shape closest to the eye
//! is the first in the list) //! is the first in the list)
virtual void SubShapesPicked (const IVtk_IdType theId, IVtk_ShapeIdList& theShapeList) const = 0; virtual void SubShapesPicked (const IVtk_IdType theId, IVtk_ShapeIdList& theShapeList) const = 0;

@ -86,8 +86,8 @@ public:
Standard_Boolean& theIsOrtho) const = 0; Standard_Boolean& theIsOrtho) const = 0;
//! Converts 3D display coordinates into 3D world coordinates. //! Converts 3D display coordinates into 3D world coordinates.
//! @param [in] theDisplayPnt 2d point of display coordinates //! @param[in] theDisplayPnt 2d point of display coordinates
//! @param [out] theWorldPnt 3d point of world coordinates //! @param[out] theWorldPnt 3d point of world coordinates
//! @return true if conversion was successful, false otherwise //! @return true if conversion was successful, false otherwise
virtual bool DisplayToWorld (const gp_XY& theDisplayPnt, gp_XYZ& theWorldPnt) const = 0; virtual bool DisplayToWorld (const gp_XY& theDisplayPnt, gp_XYZ& theWorldPnt) const = 0;

@ -34,7 +34,7 @@ public:
typedef Handle(IVtkOCC_SelectableObject) Handle; typedef Handle(IVtkOCC_SelectableObject) Handle;
//! Constructs a selectable object initialized by the given shape //! Constructs a selectable object initialized by the given shape
//! @param [in] theShape Selectable shape //! @param[in] theShape Selectable shape
IVtkOCC_SelectableObject (const IVtkOCC_Shape::Handle& theShape); IVtkOCC_SelectableObject (const IVtkOCC_Shape::Handle& theShape);
//! Constructs uninitialized selectable object. //! Constructs uninitialized selectable object.
@ -44,7 +44,7 @@ public:
virtual ~IVtkOCC_SelectableObject(); virtual ~IVtkOCC_SelectableObject();
//! Sets the selectable shape //! Sets the selectable shape
//! @param [in] theShape Selectable shape //! @param[in] theShape Selectable shape
Standard_EXPORT void SetShape (const IVtkOCC_Shape::Handle& theShape); Standard_EXPORT void SetShape (const IVtkOCC_Shape::Handle& theShape);
const IVtkOCC_Shape::Handle& GetShape() const { return myShape; }; const IVtkOCC_Shape::Handle& GetShape() const { return myShape; };
@ -58,8 +58,8 @@ private:
//! Internal method, computes selection data for viewer selector //! Internal method, computes selection data for viewer selector
//! Inspired by AIS_Shape::ComputeSelection() from OCCT 6.5.1 //! Inspired by AIS_Shape::ComputeSelection() from OCCT 6.5.1
//! @param [in] selection container for sensitive primitives //! @param[in] selection container for sensitive primitives
//! @param [in] mode Selection mode //! @param[in] mode Selection mode
virtual void ComputeSelection (const Handle(SelectMgr_Selection)& theSelection, virtual void ComputeSelection (const Handle(SelectMgr_Selection)& theSelection,
const Standard_Integer theMode) Standard_OVERRIDE; const Standard_Integer theMode) Standard_OVERRIDE;

@ -33,8 +33,8 @@ public:
typedef Handle(IVtkOCC_Shape) Handle; typedef Handle(IVtkOCC_Shape) Handle;
//! Constructor for OCC IShape implementation. //! Constructor for OCC IShape implementation.
//! @param theShape [in] shape to display //! @param[in] theShape shape to display
//! @param theDrawerLink [in] default attributes to link //! @param[in] theDrawerLink default attributes to link
Standard_EXPORT IVtkOCC_Shape (const TopoDS_Shape& theShape, Standard_EXPORT IVtkOCC_Shape (const TopoDS_Shape& theShape,
const Handle(Prs3d_Drawer)& theDrawerLink = Handle(Prs3d_Drawer)()); const Handle(Prs3d_Drawer)& theDrawerLink = Handle(Prs3d_Drawer)());
@ -58,7 +58,7 @@ public:
//! Returns unique ID of the given sub-shape within the top-level shape. //! Returns unique ID of the given sub-shape within the top-level shape.
//! Note that the sub-shape ID remains unchanged until the top-level is //! Note that the sub-shape ID remains unchanged until the top-level is
//! modified by some operation. //! modified by some operation.
//! @param [in] subShape sub-shape whose ID is returned //! @param[in] subShape sub-shape whose ID is returned
//! @return local ID of the sub-shape. //! @return local ID of the sub-shape.
Standard_EXPORT IVtk_IdType GetSubShapeId (const TopoDS_Shape& theSubShape) const; Standard_EXPORT IVtk_IdType GetSubShapeId (const TopoDS_Shape& theSubShape) const;
@ -67,7 +67,7 @@ public:
//! @brief Get a sub-shape by its local ID. //! @brief Get a sub-shape by its local ID.
//! //!
//! @param [in] id local ID of a sub-shape //! @param[in] id local ID of a sub-shape
//! @return TopoDS_Shape& a sub-shape //! @return TopoDS_Shape& a sub-shape
Standard_EXPORT const TopoDS_Shape& GetSubShape (const IVtk_IdType theId) const; Standard_EXPORT const TopoDS_Shape& GetSubShape (const IVtk_IdType theId) const;
@ -75,7 +75,7 @@ public:
//! in a data field. This object internally caches selection data //! in a data field. This object internally caches selection data
//! so it should be stored until the shape is no longer selectable. //! so it should be stored until the shape is no longer selectable.
//! Note that the selectable object keeps a pointer to OccShape. //! Note that the selectable object keeps a pointer to OccShape.
//! @param [in] selObj Handle to the selectable object //! @param[in] selObj Handle to the selectable object
void SetSelectableObject (const Handle(SelectMgr_SelectableObject)& theSelObj) void SetSelectableObject (const Handle(SelectMgr_SelectableObject)& theSelObj)
{ {
mySelectable = theSelObj; mySelectable = theSelObj;

@ -105,9 +105,9 @@ private:
//! Generates wireframe representation of the given TopoDS_Face object //! Generates wireframe representation of the given TopoDS_Face object
//! with help of OCCT algorithms. The resulting polylines are passed to IPolyData //! with help of OCCT algorithms. The resulting polylines are passed to IPolyData
//! interface and associated with the given sub-shape ID. //! interface and associated with the given sub-shape ID.
//! @param [in] theFace TopoDS_Face object to build wireframe representation for //! @param[in] theFace TopoDS_Face object to build wireframe representation for
//! @param [in] theShapeId The face' sub-shape ID //! @param[in] theShapeId The face' sub-shape ID
//! @param [in] theDeflection curve deflection //! @param[in] theDeflection curve deflection
void addWFFace (const TopoDS_Face& theFace, void addWFFace (const TopoDS_Face& theFace,
const IVtk_IdType theShapeId, const IVtk_IdType theShapeId,
const Standard_Real theDeflection); const Standard_Real theDeflection);
@ -116,8 +116,8 @@ private:
//! starting from OCCT triangulation that should be created in advance. //! starting from OCCT triangulation that should be created in advance.
//! The resulting triangles are passed to IPolyData //! The resulting triangles are passed to IPolyData
//! interface and associated with the given sub-shape ID. //! interface and associated with the given sub-shape ID.
//! @param [in] theFace TopoDS_Face object to build shaded representation for //! @param[in] theFace TopoDS_Face object to build shaded representation for
//! @param [in] theShapeId the face' sub-shape ID //! @param[in] theShapeId the face' sub-shape ID
//! @see IVtkOCC_ShapeMesher::meshShape, IVtkOCC_ShapeMesher::addEdge //! @see IVtkOCC_ShapeMesher::meshShape, IVtkOCC_ShapeMesher::addEdge
void addShadedFace (const TopoDS_Face& theFace, void addShadedFace (const TopoDS_Face& theFace,
const IVtk_IdType theShapeId); const IVtk_IdType theShapeId);

@ -44,7 +44,7 @@ public:
Standard_EXPORT virtual int NbPicked() Standard_OVERRIDE; Standard_EXPORT virtual int NbPicked() Standard_OVERRIDE;
//! Get activated selection modes for a shape. //! Get activated selection modes for a shape.
//! @param [in] theShape a shape with activated selection mode(s) //! @param[in] theShape a shape with activated selection mode(s)
//! @return list of active selection modes //! @return list of active selection modes
Standard_EXPORT virtual IVtk_SelectionModeList Standard_EXPORT virtual IVtk_SelectionModeList
GetSelectionModes (const IVtk_IShape::Handle& theShape) const Standard_OVERRIDE; GetSelectionModes (const IVtk_IShape::Handle& theShape) const Standard_OVERRIDE;
@ -54,9 +54,9 @@ public: //! @name Set selectable shapes and selection modes
//! Activates/deactivates the given selection mode for the shape. //! Activates/deactivates the given selection mode for the shape.
//! If mode == SM_None, the shape becomes non-selectable and //! If mode == SM_None, the shape becomes non-selectable and
//! is removed from the internal selection data. //! is removed from the internal selection data.
//! @param [in] theShape Shape for which the selection mode should be activated //! @param[in] theShape Shape for which the selection mode should be activated
//! @param [in] theMode Selection mode to be activated //! @param[in] theMode Selection mode to be activated
//! @param [in] theIsTurnOn Flag to turn on/off the selection mode //! @param[in] theIsTurnOn Flag to turn on/off the selection mode
Standard_EXPORT virtual void SetSelectionMode (const IVtk_IShape::Handle& theShape, Standard_EXPORT virtual void SetSelectionMode (const IVtk_IShape::Handle& theShape,
const IVtk_SelectionMode theMode, const IVtk_SelectionMode theMode,
const bool theIsTurnOn = true) Standard_OVERRIDE; const bool theIsTurnOn = true) Standard_OVERRIDE;
@ -64,9 +64,9 @@ public: //! @name Set selectable shapes and selection modes
//! Activates/deactivates the given selection mode for the shape. //! Activates/deactivates the given selection mode for the shape.
//! If mode == SM_None, the shape becomes non-selectable and //! If mode == SM_None, the shape becomes non-selectable and
//! is removed from the internal selection data. //! is removed from the internal selection data.
//! @param [in] theShapes List of shapes for which the selection mode should be activated //! @param[in] theShapes List of shapes for which the selection mode should be activated
//! @param [in] theMode Selection mode to be activated //! @param[in] theMode Selection mode to be activated
//! @param [in] theIsTurnOn Flag to turn on/off the selection mode //! @param[in] theIsTurnOn Flag to turn on/off the selection mode
Standard_EXPORT virtual void SetSelectionMode (const IVtk_ShapePtrList& theShapes, Standard_EXPORT virtual void SetSelectionMode (const IVtk_ShapePtrList& theShapes,
const IVtk_SelectionMode theMode, const IVtk_SelectionMode theMode,
const bool theIsTurnOn = true) Standard_OVERRIDE; const bool theIsTurnOn = true) Standard_OVERRIDE;
@ -89,15 +89,15 @@ public: //! @name Obtain picking results
//! is the first in the list) //! is the first in the list)
Standard_EXPORT virtual const IVtk_ShapeIdList& ShapesPicked() const Standard_OVERRIDE; Standard_EXPORT virtual const IVtk_ShapeIdList& ShapesPicked() const Standard_OVERRIDE;
//! @param [in] theId Top-level shape ID //! @param[in] theId Top-level shape ID
//! @param [out] theShapeList the list of picked sub-shape IDs for the given top-level shape ID, //! @param[out] theShapeList the list of picked sub-shape IDs for the given top-level shape ID,
//! in the order of increasing depth (the ID of the sub-shape closest to the eye //! in the order of increasing depth (the ID of the sub-shape closest to the eye
//! is the first in the list) //! is the first in the list)
Standard_EXPORT virtual void Standard_EXPORT virtual void
SubShapesPicked (const IVtk_IdType theId, IVtk_ShapeIdList& theShapeList) const Standard_OVERRIDE; SubShapesPicked (const IVtk_IdType theId, IVtk_ShapeIdList& theShapeList) const Standard_OVERRIDE;
//! Remove selectable object from the picker (from internal maps). //! Remove selectable object from the picker (from internal maps).
//! @param [in] theShape the selectable shape //! @param[in] theShape the selectable shape
Standard_EXPORT virtual void RemoveSelectableObject(const IVtk_IShape::Handle& theShape); Standard_EXPORT virtual void RemoveSelectableObject(const IVtk_IShape::Handle& theShape);
//! Return topmost picked 3D point or (Inf, Inf, Inf) if undefined. //! Return topmost picked 3D point or (Inf, Inf, Inf) if undefined.

@ -33,15 +33,15 @@ public:
virtual ~IVtkOCC_ViewerSelector(); virtual ~IVtkOCC_ViewerSelector();
//! Implements point picking //! Implements point picking
//! @param [in] theXPix, theYPix Display coordinates of the point //! @param[in] theXPix, theYPix Display coordinates of the point
//! @param [in] theView ICamera interface to update the projection parameters. //! @param[in] theView ICamera interface to update the projection parameters.
void Pick (const Standard_Integer theXPix, void Pick (const Standard_Integer theXPix,
const Standard_Integer theYPix, const Standard_Integer theYPix,
const IVtk_IView::Handle& theView); const IVtk_IView::Handle& theView);
//! Picking by rectangle //! Picking by rectangle
//! @param [in] theXMin, theYMin, theXMax, theYMax Rectangle coords //! @param[in] theXMin, theYMin, theXMax, theYMax Rectangle coords
//! @param [in] theView ICamera interface to calculate projections //! @param[in] theView ICamera interface to calculate projections
void Pick (const Standard_Integer theXMin, void Pick (const Standard_Integer theXMin,
const Standard_Integer theYMin, const Standard_Integer theYMin,
const Standard_Integer theXMax, const Standard_Integer theXMax,

@ -35,33 +35,33 @@ namespace IVtkTools
//! Set a color for given type of sub-shapes. //! Set a color for given type of sub-shapes.
//! @param [in,out] theColorTable vtkLookupTable to set the color. //! @param [in,out] theColorTable vtkLookupTable to set the color.
//! @param [in] theColorRole type of sub-shapes to set the color. //! @param[in] theColorRole type of sub-shapes to set the color.
//! @param [in] theR red color component. Use [0,1] double values. //! @param[in] theR red color component. Use [0,1] double values.
//! @param [in] theG green color component. Use [0,1] double values. //! @param[in] theG green color component. Use [0,1] double values.
//! @param [in] theB blue color component. Use [0,1] double values. //! @param[in] theB blue color component. Use [0,1] double values.
//! @param [in] theA the alpha value (the opacity) as a double between 0 and 1. //! @param[in] theA the alpha value (the opacity) as a double between 0 and 1.
Standard_EXPORT void SetLookupTableColor (vtkLookupTable* theColorTable, Standard_EXPORT void SetLookupTableColor (vtkLookupTable* theColorTable,
const IVtk_MeshType theColorRole, const IVtk_MeshType theColorRole,
const double theR, const double theG, const double theB, const double theR, const double theG, const double theB,
const double theA = 1); const double theA = 1);
//! Get a color for given type of sub-shapes. //! Get a color for given type of sub-shapes.
//! @param [in] theColorTable vtkLookupTable to set the color. //! @param[in] theColorTable vtkLookupTable to set the color.
//! @param [in] theColorRole type of sub-shapes to set the color. //! @param[in] theColorRole type of sub-shapes to set the color.
//! @param [out] theR red color component as a double between 0 and 1. //! @param[out] theR red color component as a double between 0 and 1.
//! @param [out] theG green color component as a double between 0 and 1. //! @param[out] theG green color component as a double between 0 and 1.
//! @param [out] theB blue color component as a double between 0 and 1. //! @param[out] theB blue color component as a double between 0 and 1.
Standard_EXPORT void GetLookupTableColor (vtkLookupTable* theColorTable, Standard_EXPORT void GetLookupTableColor (vtkLookupTable* theColorTable,
const IVtk_MeshType theColorRole, const IVtk_MeshType theColorRole,
double &theR, double &theG, double &theB); double &theR, double &theG, double &theB);
//! Get a color for given type of sub-shapes. //! Get a color for given type of sub-shapes.
//! @param [in] theColorTable vtkLookupTable to set the color. //! @param[in] theColorTable vtkLookupTable to set the color.
//! @param [in] theColorRole type of sub-shapes to set the color. //! @param[in] theColorRole type of sub-shapes to set the color.
//! @param [out] theR red color component as a double between 0 and 1. //! @param[out] theR red color component as a double between 0 and 1.
//! @param [out] theG green color component as a double between 0 and 1. //! @param[out] theG green color component as a double between 0 and 1.
//! @param [out] theB blue color component as a double between 0 and 1. //! @param[out] theB blue color component as a double between 0 and 1.
//! @param [out] theA the alpha value (the opacity) as a double between 0 and 1. //! @param[out] theA the alpha value (the opacity) as a double between 0 and 1.
Standard_EXPORT void GetLookupTableColor (vtkLookupTable* theColorTable, Standard_EXPORT void GetLookupTableColor (vtkLookupTable* theColorTable,
const IVtk_MeshType theColorRole, const IVtk_MeshType theColorRole,
double &theR, double &theG, double &theB, double &theR, double &theG, double &theB,
@ -72,7 +72,7 @@ namespace IVtkTools
//! Set up the initial shape mapper parameters with user colors. //! Set up the initial shape mapper parameters with user colors.
//! @param [in,out] theMapper mapper to initialize //! @param [in,out] theMapper mapper to initialize
//! @param [in] theColorTable a table with user's colors definition //! @param[in] theColorTable a table with user's colors definition
Standard_EXPORT void InitShapeMapper (vtkMapper* theMapper, Standard_EXPORT void InitShapeMapper (vtkMapper* theMapper,
vtkLookupTable* theColorTable); vtkLookupTable* theColorTable);

@ -46,7 +46,7 @@ public:
public: //! @name Initialization public: //! @name Initialization
//! Set the source OCCT shape. //! Set the source OCCT shape.
//! @param theOccShape [in] OCCT shape wrapper. //! @param[in] theOccShape OCCT shape wrapper.
void SetShape(const IVtkOCC_Shape::Handle& theOccShape); void SetShape(const IVtkOCC_Shape::Handle& theOccShape);
//! Get the source OCCT shape. //! Get the source OCCT shape.
@ -63,7 +63,7 @@ public: //! @name Data accessors
IVtk_IdType GetId() const; IVtk_IdType GetId() const;
//! Checks if the internal OccShape pointer is the same the argument. //! Checks if the internal OccShape pointer is the same the argument.
//! @param [in] shape OccShape pointer to be checked. //! @param[in] shape OccShape pointer to be checked.
//! @return true if the two OccShape instances are the same, and false otherwise. //! @return true if the two OccShape instances are the same, and false otherwise.
Standard_Boolean Contains (const IVtkOCC_Shape::Handle& theOccShape) const; Standard_Boolean Contains (const IVtkOCC_Shape::Handle& theOccShape) const;
@ -76,11 +76,11 @@ protected: //! @name Interface to override
//! This is called by the superclass. //! This is called by the superclass.
//! This is the method you should override if you use this class as ancestor. //! This is the method you should override if you use this class as ancestor.
//! Build output polygonal data set from the shape wrapper. //! Build output polygonal data set from the shape wrapper.
//! @param theRequest [in] information about data object. //! @param[in] theRequest information about data object.
//! In current implementation it is ignored. //! In current implementation it is ignored.
//! @param theInputVector [in] the input data. As adata source is the start //! @param[in] theInputVector the input data. As adata source is the start
//! stage of the VTK pipeline, theInputVector is empty and not used (no input port). //! stage of the VTK pipeline, theInputVector is empty and not used (no input port).
//! @param theOutputVector [in] the pointer to output data, that is filled in this method. //! @param[in] theOutputVector the pointer to output data, that is filled in this method.
virtual int RequestData(vtkInformation* theRequest, virtual int RequestData(vtkInformation* theRequest,
vtkInformationVector** theInputVector, vtkInformationVector** theInputVector,
vtkInformationVector* theOutputVector) Standard_OVERRIDE; vtkInformationVector* theOutputVector) Standard_OVERRIDE;
@ -89,8 +89,8 @@ protected: //! @name Internals
//! Transforms the passed polygonal data by the given OCCT transformation //! Transforms the passed polygonal data by the given OCCT transformation
//! matrix. //! matrix.
//! @param theSource [in] source polygonal data to transform. //! @param[in] theSource source polygonal data to transform.
//! @param theTrsf [in] transformation to apply. //! @param[in] theTrsf transformation to apply.
//! @return resulting polygonal data (transformed copy of source). //! @return resulting polygonal data (transformed copy of source).
vtkSmartPointer<vtkPolyData> transform (vtkPolyData* theSource, const gp_Trsf& theTrsf) const; vtkSmartPointer<vtkPolyData> transform (vtkPolyData* theSource, const gp_Trsf& theTrsf) const;

@ -67,38 +67,38 @@ public:
//! Sets the renderer to be used by OCCT selection algorithm //! Sets the renderer to be used by OCCT selection algorithm
void SetRenderer (vtkRenderer* theRenderer); void SetRenderer (vtkRenderer* theRenderer);
//! Sets area selection on/off //! Sets area selection on/off
//! @param [in] theIsOn true if area selection is turned on, false otherwise. //! @param[in] theIsOn true if area selection is turned on, false otherwise.
void SetAreaSelection (bool theIsOn); void SetAreaSelection (bool theIsOn);
//! Get activated selection modes for a shape. //! Get activated selection modes for a shape.
//! @param [in] theShape a shape with activated selection mode(s) //! @param[in] theShape a shape with activated selection mode(s)
//! @return list of active selection modes //! @return list of active selection modes
IVtk_SelectionModeList GetSelectionModes (const IVtk_IShape::Handle& theShape) const; IVtk_SelectionModeList GetSelectionModes (const IVtk_IShape::Handle& theShape) const;
//! Get activated selection modes for a shape actor. //! Get activated selection modes for a shape actor.
//! @param [in] theShapeActor an actor with activated selection mode(s) //! @param[in] theShapeActor an actor with activated selection mode(s)
//! @return list of active selection modes //! @return list of active selection modes
IVtk_SelectionModeList GetSelectionModes (vtkActor* theShapeActor) const; IVtk_SelectionModeList GetSelectionModes (vtkActor* theShapeActor) const;
//! Turn on/off a selection mode for a shape actor. //! Turn on/off a selection mode for a shape actor.
//! @param [in] theShape a shape to set a selection mode for //! @param[in] theShape a shape to set a selection mode for
//! @param [in] theMode selection mode to be activated //! @param[in] theMode selection mode to be activated
//! @param [in] theIsTurnOn Flag to turn on/off the selection mode //! @param[in] theIsTurnOn Flag to turn on/off the selection mode
void SetSelectionMode (const IVtk_IShape::Handle& theShape, void SetSelectionMode (const IVtk_IShape::Handle& theShape,
const IVtk_SelectionMode theMode, const IVtk_SelectionMode theMode,
const bool theIsTurnOn = true) const; const bool theIsTurnOn = true) const;
//! Turn on/off a selection mode for a shape actor. //! Turn on/off a selection mode for a shape actor.
//! @param [in] theShapeActor shape presentation actor to set a selection mode for //! @param[in] theShapeActor shape presentation actor to set a selection mode for
//! @param [in] theMode selection mode to be activated //! @param[in] theMode selection mode to be activated
//! @param [in] theIsTurnOn Flag to turn on/off the selection mode //! @param[in] theIsTurnOn Flag to turn on/off the selection mode
void SetSelectionMode (vtkActor* theShapeActor, void SetSelectionMode (vtkActor* theShapeActor,
const IVtk_SelectionMode theMode, const IVtk_SelectionMode theMode,
const bool theIsTurnOn = true) const; const bool theIsTurnOn = true) const;
//! Sets the current selection mode for all visible shape objects. //! Sets the current selection mode for all visible shape objects.
//! @param [in] theMode selection mode to be activated //! @param[in] theMode selection mode to be activated
//! @param [in] theIsTurnOn Flag to turn on/off the selection mode //! @param[in] theIsTurnOn Flag to turn on/off the selection mode
void SetSelectionMode (const IVtk_SelectionMode theMode, void SetSelectionMode (const IVtk_SelectionMode theMode,
const bool theIsTurnOn = true) const; const bool theIsTurnOn = true) const;
@ -109,30 +109,30 @@ public:
//! all OccShape objects found by the picking algorithm. e.g. all //! all OccShape objects found by the picking algorithm. e.g. all
//! shapes under the mouse cursor. Otherwise, ID of the shape closest to the eye //! shapes under the mouse cursor. Otherwise, ID of the shape closest to the eye
//! is returned. //! is returned.
//! @param [in] theIsAll Get all selected shapes or just the only //! @param[in] theIsAll Get all selected shapes or just the only
//! top one is returned, has no effect during area selection. //! top one is returned, has no effect during area selection.
//! @return List of top-level shape IDs //! @return List of top-level shape IDs
IVtk_ShapeIdList GetPickedShapesIds (bool theIsAll = false) const; IVtk_ShapeIdList GetPickedShapesIds (bool theIsAll = false) const;
//! Access to the list of sub-shapes ids picked. //! Access to the list of sub-shapes ids picked.
//! @param [in] theId top-level shape ID //! @param[in] theId top-level shape ID
//! @param [in] theIsAll Get all selected sub-shapes or just the //! @param[in] theIsAll Get all selected sub-shapes or just the
//! only top one is returned, has no effect during area selection. //! only top one is returned, has no effect during area selection.
//! @return List of sub-shapes IDs //! @return List of sub-shapes IDs
IVtk_ShapeIdList GetPickedSubShapesIds (const IVtk_IdType theId, bool theIsAll = false) const; IVtk_ShapeIdList GetPickedSubShapesIds (const IVtk_IdType theId, bool theIsAll = false) const;
//! Access to the list of actors picked. //! Access to the list of actors picked.
//! @param [in] theIsAll Get all selected actors or just the only //! @param[in] theIsAll Get all selected actors or just the only
//! top one is returned, has no effect during area selection. //! top one is returned, has no effect during area selection.
//! @return List of actors IDs //! @return List of actors IDs
vtkSmartPointer<vtkActorCollection> GetPickedActors (bool theIsAll = false) const; vtkSmartPointer<vtkActorCollection> GetPickedActors (bool theIsAll = false) const;
//! Remove selectable object from the picker (from internal maps). //! Remove selectable object from the picker (from internal maps).
//! @param [in] theShape the selectable shape //! @param[in] theShape the selectable shape
void RemoveSelectableObject(const IVtk_IShape::Handle& theShape); void RemoveSelectableObject(const IVtk_IShape::Handle& theShape);
//! Remove selectable object from the picker (from internal maps). //! Remove selectable object from the picker (from internal maps).
//! @param [in] theShapeActor the shape presentation actor to be removed from the picker //! @param[in] theShapeActor the shape presentation actor to be removed from the picker
void RemoveSelectableActor(vtkActor* theShapeActor); void RemoveSelectableActor(vtkActor* theShapeActor);
protected: protected:
@ -152,10 +152,10 @@ private: // not copyable
//! Implementation of picking algorithm. //! Implementation of picking algorithm.
//! The coordinates accepted by this method are display (pixel) coordinates. //! The coordinates accepted by this method are display (pixel) coordinates.
//! @param [in] pos contains the pick point (3 coordinates) or pick rectangle (6 coordinates) //! @param[in] pos contains the pick point (3 coordinates) or pick rectangle (6 coordinates)
//! or polyline (array of 2d coordinates) //! or polyline (array of 2d coordinates)
//! @param [in] renderer vtkRenderer object to be used (normally set in advance with setRenderer()) //! @param[in] renderer vtkRenderer object to be used (normally set in advance with setRenderer())
//! @param [in] nbPoints number of points for polyline case //! @param[in] nbPoints number of points for polyline case
//! @see IVtkTools_ShapePicker::setRenderer //! @see IVtkTools_ShapePicker::setRenderer
virtual void doPickImpl (double*, vtkRenderer* theRenderer, const int theNbPoints = -1); virtual void doPickImpl (double*, vtkRenderer* theRenderer, const int theNbPoints = -1);

@ -54,43 +54,43 @@ public:
DEFINE_STANDARD_RTTIEXT(IVtkVTK_ShapeData,IVtk_IShapeData) DEFINE_STANDARD_RTTIEXT(IVtkVTK_ShapeData,IVtk_IShapeData)
//! Insert a coordinate //! Insert a coordinate
//! @param [in] thePnt point position //! @param[in] thePnt point position
//! @param [in] theNorm point normal //! @param[in] theNorm point normal
//! @return id of added point //! @return id of added point
Standard_EXPORT virtual IVtk_PointId InsertPoint (const gp_Pnt& thePnt, Standard_EXPORT virtual IVtk_PointId InsertPoint (const gp_Pnt& thePnt,
const NCollection_Vec3<float>& theNorm) Standard_OVERRIDE; const NCollection_Vec3<float>& theNorm) Standard_OVERRIDE;
//! Insert a vertex. //! Insert a vertex.
//! @param [in] theShapeID id of the subshape to which the vertex belongs. //! @param[in] theShapeID id of the subshape to which the vertex belongs.
//! @param [in] thePointId id of the point that defines the coordinates of the vertex //! @param[in] thePointId id of the point that defines the coordinates of the vertex
//! @param [in] theMeshType mesh type of the subshape (MT_Undefined by default) //! @param[in] theMeshType mesh type of the subshape (MT_Undefined by default)
Standard_EXPORT virtual void InsertVertex (const IVtk_IdType theShapeID, Standard_EXPORT virtual void InsertVertex (const IVtk_IdType theShapeID,
const IVtk_PointId thePointId, const IVtk_PointId thePointId,
const IVtk_MeshType theMeshType) Standard_OVERRIDE; const IVtk_MeshType theMeshType) Standard_OVERRIDE;
//! Insert a line. //! Insert a line.
//! @param [in] theShapeID id of the subshape to which the line belongs. //! @param[in] theShapeID id of the subshape to which the line belongs.
//! @param [in] thePointId1 id of the first point //! @param[in] thePointId1 id of the first point
//! @param [in] thePointId2 id of the second point //! @param[in] thePointId2 id of the second point
//! @param [in] theMeshType mesh type of the subshape (MT_Undefined by default) //! @param[in] theMeshType mesh type of the subshape (MT_Undefined by default)
Standard_EXPORT virtual void InsertLine (const IVtk_IdType theShapeID, Standard_EXPORT virtual void InsertLine (const IVtk_IdType theShapeID,
const IVtk_PointId thePointId1, const IVtk_PointId thePointId1,
const IVtk_PointId thePointId2, const IVtk_PointId thePointId2,
const IVtk_MeshType theMeshType) Standard_OVERRIDE; const IVtk_MeshType theMeshType) Standard_OVERRIDE;
//! Insert a poly-line. //! Insert a poly-line.
//! @param [in] theShapeID id of the subshape to which the polyline belongs. //! @param[in] theShapeID id of the subshape to which the polyline belongs.
//! @param [in] thePointIds vector of point ids //! @param[in] thePointIds vector of point ids
//! @param [in] theMeshType mesh type of the subshape (MT_Undefined by default) //! @param[in] theMeshType mesh type of the subshape (MT_Undefined by default)
Standard_EXPORT virtual void InsertLine (const IVtk_IdType theShapeID, Standard_EXPORT virtual void InsertLine (const IVtk_IdType theShapeID,
const IVtk_PointIdList* thePointIds, const IVtk_PointIdList* thePointIds,
const IVtk_MeshType theMeshType) Standard_OVERRIDE; const IVtk_MeshType theMeshType) Standard_OVERRIDE;
//! Insert a triangle //! Insert a triangle
//! @param [in] theShapeID id of the subshape to which the triangle belongs. //! @param[in] theShapeID id of the subshape to which the triangle belongs.
//! @param [in] thePointId1 id of the first point //! @param[in] thePointId1 id of the first point
//! @param [in] thePointId2 id of the second point //! @param[in] thePointId2 id of the second point
//! @param [in] thePointId3 id of the third point //! @param[in] thePointId3 id of the third point
//! @param [in] theMeshType mesh type of the subshape (MT_Undefined by default) //! @param[in] theMeshType mesh type of the subshape (MT_Undefined by default)
Standard_EXPORT virtual void InsertTriangle (const IVtk_IdType theShapeID, Standard_EXPORT virtual void InsertTriangle (const IVtk_IdType theShapeID,
const IVtk_PointId thePointId1, const IVtk_PointId thePointId1,
const IVtk_PointId thePointId2, const IVtk_PointId thePointId2,

@ -94,8 +94,8 @@ public:
Standard_Real& theHeight) const Standard_OVERRIDE; Standard_Real& theHeight) const Standard_OVERRIDE;
//! Converts 3D display coordinates into 3D world coordinates. //! Converts 3D display coordinates into 3D world coordinates.
//! @param [in] theDisplayPnt 2d point of display coordinates //! @param[in] theDisplayPnt 2d point of display coordinates
//! @param [out] theWorldPnt 3d point of world coordinates //! @param[out] theWorldPnt 3d point of world coordinates
//! @return true if conversion was successful, false otherwise //! @return true if conversion was successful, false otherwise
Standard_EXPORT virtual bool DisplayToWorld (const gp_XY& theDisplayPnt, gp_XYZ& theWorldPnt) const Standard_OVERRIDE; Standard_EXPORT virtual bool DisplayToWorld (const gp_XY& theDisplayPnt, gp_XYZ& theWorldPnt) const Standard_OVERRIDE;

@ -25,11 +25,11 @@ class Image_DDSParser
public: public:
//! Load the face from DDS file. //! Load the face from DDS file.
//! @param theSupported [in] list of supported image formats //! @param[in] theSupported list of supported image formats
//! @param theFile [in] file path //! @param[in] theFile file path
//! @param theFaceIndex [in] face index, within [0, Image_CompressedPixMap::NbFaces()) range; //! @param[in] theFaceIndex face index, within [0, Image_CompressedPixMap::NbFaces()) range;
//! use -1 to skip reading the face data //! use -1 to skip reading the face data
//! @param theFileOffset [in] offset to the DDS data //! @param[in] theFileOffset offset to the DDS data
//! @return loaded face or NULL if file cannot be read or not valid DDS file //! @return loaded face or NULL if file cannot be read or not valid DDS file
Standard_EXPORT static Handle(Image_CompressedPixMap) Load (const Handle(Image_SupportedFormats)& theSupported, Standard_EXPORT static Handle(Image_CompressedPixMap) Load (const Handle(Image_SupportedFormats)& theSupported,
const TCollection_AsciiString& theFile, const TCollection_AsciiString& theFile,
@ -37,9 +37,9 @@ public:
const int64_t theFileOffset = 0); const int64_t theFileOffset = 0);
//! Load the face from DDS file. //! Load the face from DDS file.
//! @param theSupported [in] list of supported image formats //! @param[in] theSupported list of supported image formats
//! @param theBuffer [in] pre-loaded file data, should be at least of 128 bytes long defining DDS header. //! @param[in] theBuffer pre-loaded file data, should be at least of 128 bytes long defining DDS header.
//! @param theFaceIndex [in] face index, within [0, Image_CompressedPixMap::NbFaces()) range; //! @param[in] theFaceIndex face index, within [0, Image_CompressedPixMap::NbFaces()) range;
//! use -1 to skip reading the face data //! use -1 to skip reading the face data
//! @return loaded face or NULL if file cannot be read or not valid DDS file //! @return loaded face or NULL if file cannot be read or not valid DDS file
Standard_EXPORT static Handle(Image_CompressedPixMap) Load (const Handle(Image_SupportedFormats)& theSupported, Standard_EXPORT static Handle(Image_CompressedPixMap) Load (const Handle(Image_SupportedFormats)& theSupported,

@ -85,8 +85,8 @@ public:
Standard_EXPORT void Close(); Standard_EXPORT void Close();
//! Open output stream - initialize recorder. //! Open output stream - initialize recorder.
//! @param theFileName [in] video filename //! @param[in] theFileName video filename
//! @param theParams [in] video parameters //! @param[in] theParams video parameters
Standard_EXPORT Standard_Boolean Open (const char* theFileName, Standard_EXPORT Standard_Boolean Open (const char* theFileName,
const Image_VideoParams& theParams); const Image_VideoParams& theParams);
@ -109,8 +109,8 @@ protected:
Standard_EXPORT TCollection_AsciiString formatAvError (const int theError) const; Standard_EXPORT TCollection_AsciiString formatAvError (const int theError) const;
//! Append video stream. //! Append video stream.
//! theParams [in] video parameters //! theParams[in] video parameters
//! theDefCodecId [in] identifier of codec managed by FFmpeg library (AVCodecID enum) //! theDefCodecId[in] identifier of codec managed by FFmpeg library (AVCodecID enum)
Standard_EXPORT Standard_Boolean addVideoStream (const Image_VideoParams& theParams, Standard_EXPORT Standard_Boolean addVideoStream (const Image_VideoParams& theParams,
const Standard_Integer theDefCodecId); const Standard_Integer theDefCodecId);

@ -76,7 +76,7 @@ public:
Standard_EXPORT Standard_Boolean TangentFaces() const; Standard_EXPORT Standard_Boolean TangentFaces() const;
//! Provides post-processing the result lines. //! Provides post-processing the result lines.
//! @param bToSplit [in] split the closed 3D-curves on parts when TRUE, //! @param[in] bToSplit split the closed 3D-curves on parts when TRUE,
//! remain untouched otherwise //! remain untouched otherwise
Standard_EXPORT void PrepareLines3D (const Standard_Boolean bToSplit = Standard_True); Standard_EXPORT void PrepareLines3D (const Standard_Boolean bToSplit = Standard_True);

@ -36,16 +36,16 @@ class Media_PlayerContext : public Standard_Transient
public: public:
//! Dump first video frame. //! Dump first video frame.
//! @param theSrcVideo [in] path to the video //! @param[in] theSrcVideo path to the video
//! @param theMediaInfo [out] video description //! @param[out] theMediaInfo video description
Standard_EXPORT static Handle(Media_Frame) DumpFirstFrame (const TCollection_AsciiString& theSrcVideo, Standard_EXPORT static Handle(Media_Frame) DumpFirstFrame (const TCollection_AsciiString& theSrcVideo,
TCollection_AsciiString& theMediaInfo); TCollection_AsciiString& theMediaInfo);
//! Dump first video frame. //! Dump first video frame.
//! @param theSrcVideo [in] path to the video //! @param[in] theSrcVideo path to the video
//! @param theOutImage [in] path to make a screenshot //! @param[in] theOutImage path to make a screenshot
//! @param theMediaInfo [out] video description //! @param[out] theMediaInfo video description
//! @param theMaxSize [in] when positive - downscales image to specified size //! @param[in] theMaxSize when positive - downscales image to specified size
Standard_EXPORT static bool DumpFirstFrame (const TCollection_AsciiString& theSrcVideo, Standard_EXPORT static bool DumpFirstFrame (const TCollection_AsciiString& theSrcVideo,
const TCollection_AsciiString& theOutImage, const TCollection_AsciiString& theOutImage,
TCollection_AsciiString& theMediaInfo, TCollection_AsciiString& theMediaInfo,

@ -183,9 +183,9 @@ friend class MeshVS_PrsBuilder;
protected: protected:
//! Stores all vertices that belong to one of the faces to the given map //! Stores all vertices that belong to one of the faces to the given map
//! @param theAllElements [in] the map of all mesh elements //! @param[in] theAllElements the map of all mesh elements
//! @param theNbMaxFaceNodes [in] the maximum amount of nodes per face, retrieved from drawer //! @param[in] theNbMaxFaceNodes the maximum amount of nodes per face, retrieved from drawer
//! @param theSharedNodes [out] the result map of all vertices that belong to one face at least //! @param[out] theSharedNodes the result map of all vertices that belong to one face at least
Standard_EXPORT void scanFacesForSharedNodes (const TColStd_PackedMapOfInteger& theAllElements, Standard_EXPORT void scanFacesForSharedNodes (const TColStd_PackedMapOfInteger& theAllElements,
const Standard_Integer theNbMaxFaceNodes, const Standard_Integer theNbMaxFaceNodes,
TColStd_PackedMapOfInteger& theSharedNodes) const; TColStd_PackedMapOfInteger& theSharedNodes) const;

@ -112,14 +112,14 @@ public:
} }
//! Converts message metric to OSD memory info type. //! Converts message metric to OSD memory info type.
//! @param theMetric [in] message metric //! @param[in] theMetric message metric
//! @param theMemInfo [out] filled memory info type //! @param[out] theMemInfo filled memory info type
//! @return true if converted //! @return true if converted
static Standard_EXPORT Standard_Boolean ToOSDMetric (const Message_MetricType theMetric, OSD_MemInfo::Counter& theMemInfo); static Standard_EXPORT Standard_Boolean ToOSDMetric (const Message_MetricType theMetric, OSD_MemInfo::Counter& theMemInfo);
//! Converts OSD memory info type to message metric. //! Converts OSD memory info type to message metric.
//! @param theMemInfo [int] memory info type //! @param theMemInfo [int] memory info type
//! @param theMetric [out] filled message metric //! @param[out] theMetric filled message metric
//! @return true if converted //! @return true if converted
static Standard_EXPORT Standard_Boolean ToMessageMetric (const OSD_MemInfo::Counter theMemInfo, Message_MetricType& theMetric); static Standard_EXPORT Standard_Boolean ToMessageMetric (const OSD_MemInfo::Counter theMemInfo, Message_MetricType& theMetric);

@ -37,31 +37,31 @@ public:
Standard_EXPORT Message_AttributeMeter (const TCollection_AsciiString& theName = TCollection_AsciiString()); Standard_EXPORT Message_AttributeMeter (const TCollection_AsciiString& theName = TCollection_AsciiString());
//! Checks whether the attribute has values for the metric //! Checks whether the attribute has values for the metric
//! @param theMetric [in] metric type //! @param[in] theMetric metric type
//! @return true if the metric values exist in the attribute //! @return true if the metric values exist in the attribute
Standard_EXPORT Standard_Boolean HasMetric (const Message_MetricType& theMetric) const; Standard_EXPORT Standard_Boolean HasMetric (const Message_MetricType& theMetric) const;
//! Returns true when both values of the metric are set. //! Returns true when both values of the metric are set.
//! @param theMetric [in] metric type //! @param[in] theMetric metric type
//! @return true if metric values are valid //! @return true if metric values are valid
Standard_EXPORT Standard_Boolean IsMetricValid (const Message_MetricType& theMetric) const; Standard_EXPORT Standard_Boolean IsMetricValid (const Message_MetricType& theMetric) const;
//! Returns start value for the metric //! Returns start value for the metric
//! @param theMetric [in] metric type //! @param[in] theMetric metric type
//! @return real value //! @return real value
Standard_EXPORT Standard_Real StartValue (const Message_MetricType& theMetric) const; Standard_EXPORT Standard_Real StartValue (const Message_MetricType& theMetric) const;
//! Sets start values for the metric //! Sets start values for the metric
//! @param theMetric [in] metric type //! @param[in] theMetric metric type
Standard_EXPORT void SetStartValue (const Message_MetricType& theMetric, const Standard_Real theValue); Standard_EXPORT void SetStartValue (const Message_MetricType& theMetric, const Standard_Real theValue);
//! Returns stop value for the metric //! Returns stop value for the metric
//! @param theMetric [in] metric type //! @param[in] theMetric metric type
//! @return real value //! @return real value
Standard_EXPORT Standard_Real StopValue (const Message_MetricType& theMetric) const; Standard_EXPORT Standard_Real StopValue (const Message_MetricType& theMetric) const;
//! Sets stop values for the metric //! Sets stop values for the metric
//! @param theMetric [in] metric type //! @param[in] theMetric metric type
Standard_EXPORT void SetStopValue (const Message_MetricType& theMetric, const Standard_Real theValue); Standard_EXPORT void SetStopValue (const Message_MetricType& theMetric, const Standard_Real theValue);
public: public:

@ -28,11 +28,11 @@ class Message_LazyProgressScope : protected Message_ProgressScope
public: public:
//! Main constructor. //! Main constructor.
//! @param theRange [in] progress range to scope //! @param[in] theRange progress range to scope
//! @param theName [in] name of this scope //! @param[in] theName name of this scope
//! @param theMax [in] number of steps within this scope //! @param[in] theMax number of steps within this scope
//! @param thePatchStep [in] number of steps to update progress //! @param[in] thePatchStep number of steps to update progress
//! @param theIsInf [in] infinite flag //! @param[in] theIsInf infinite flag
Message_LazyProgressScope (const Message_ProgressRange& theRange, Message_LazyProgressScope (const Message_ProgressRange& theRange,
const char* theName, const char* theName,
const Standard_Real theMax, const Standard_Real theMax,

@ -217,10 +217,10 @@ public: //! @name Preparation methods
//! The topmost scope is created and owned by Message_ProgressIndicator //! The topmost scope is created and owned by Message_ProgressIndicator
//! and its pointer is contained in the Message_ProgressRange returned by the Start() method of progress indicator. //! and its pointer is contained in the Message_ProgressRange returned by the Start() method of progress indicator.
//! //!
//! @param theRange [in][out] range to fill (will be disarmed) //! @param[in][out] theRange range to fill (will be disarmed)
//! @param theName [in] new scope name //! @param[in] theName new scope name
//! @param theMax [in] number of steps in scope //! @param[in] theMax number of steps in scope
//! @param isInfinite [in] infinite flag //! @param[in] isInfinite infinite flag
Message_ProgressScope (const Message_ProgressRange& theRange, Message_ProgressScope (const Message_ProgressRange& theRange,
const TCollection_AsciiString& theName, const TCollection_AsciiString& theName,
Standard_Real theMax, Standard_Real theMax,
@ -233,10 +233,10 @@ public: //! @name Preparation methods
//! The topmost scope is created and owned by Message_ProgressIndicator //! The topmost scope is created and owned by Message_ProgressIndicator
//! and its pointer is contained in the Message_ProgressRange returned by the Start() method of progress indicator. //! and its pointer is contained in the Message_ProgressRange returned by the Start() method of progress indicator.
//! //!
//! @param theRange [in][out] range to fill (will be disarmed) //! @param[in][out] theRange range to fill (will be disarmed)
//! @param theName [in] new scope name constant (will be stored by pointer with no deep copy) //! @param[in] theName new scope name constant (will be stored by pointer with no deep copy)
//! @param theMax [in] number of steps in scope //! @param[in] theMax number of steps in scope
//! @param isInfinite [in] infinite flag //! @param[in] isInfinite infinite flag
template<size_t N> template<size_t N>
Message_ProgressScope (const Message_ProgressRange& theRange, Message_ProgressScope (const Message_ProgressRange& theRange,
const char (&theName)[N], const char (&theName)[N],
@ -250,10 +250,10 @@ public: //! @name Preparation methods
//! The topmost scope is created and owned by Message_ProgressIndicator //! The topmost scope is created and owned by Message_ProgressIndicator
//! and its pointer is contained in the Message_ProgressRange returned by the Start() method of progress indicator. //! and its pointer is contained in the Message_ProgressRange returned by the Start() method of progress indicator.
//! //!
//! @param theRange [in][out] range to fill (will be disarmed) //! @param[in][out] theRange range to fill (will be disarmed)
//! @param theName [in] empty scope name (only NULL is accepted as argument) //! @param[in] theName empty scope name (only NULL is accepted as argument)
//! @param theMax [in] number of steps in scope //! @param[in] theMax number of steps in scope
//! @param isInfinite [in] infinite flag //! @param[in] isInfinite infinite flag
Message_ProgressScope (const Message_ProgressRange& theRange, Message_ProgressScope (const Message_ProgressRange& theRange,
const NullString* theName, const NullString* theName,
Standard_Real theMax, Standard_Real theMax,

@ -408,8 +408,8 @@ public:
} }
//! Find the Key1 and return Key2 value (by copying its value). //! Find the Key1 and return Key2 value (by copying its value).
//! @param [in] theKey1 Key1 to find //! @param[in] theKey1 Key1 to find
//! @param [out] theKey2 Key2 to return //! @param[out] theKey2 Key2 to return
//! @return TRUE if Key1 has been found //! @return TRUE if Key1 has been found
Standard_Boolean Find1 (const TheKey1Type& theKey1, Standard_Boolean Find1 (const TheKey1Type& theKey1,
TheKey2Type& theKey2) const TheKey2Type& theKey2) const
@ -423,7 +423,7 @@ public:
} }
//! Find the Key1 and return pointer to Key2 or NULL if Key1 is not bound. //! Find the Key1 and return pointer to Key2 or NULL if Key1 is not bound.
//! @param [in] theKey1 Key1 to find //! @param[in] theKey1 Key1 to find
//! @return pointer to Key2 or NULL if Key1 is not found //! @return pointer to Key2 or NULL if Key1 is not found
const TheKey2Type* Seek1 (const TheKey1Type& theKey1) const const TheKey2Type* Seek1 (const TheKey1Type& theKey1) const
{ {
@ -450,8 +450,8 @@ public:
} }
//! Find the Key2 and return Key1 value (by copying its value). //! Find the Key2 and return Key1 value (by copying its value).
//! @param [in] theKey2 Key2 to find //! @param[in] theKey2 Key2 to find
//! @param [out] theKey1 Key1 to return //! @param[out] theKey1 Key1 to return
//! @return TRUE if Key2 has been found //! @return TRUE if Key2 has been found
Standard_Boolean Find2 (const TheKey2Type& theKey2, Standard_Boolean Find2 (const TheKey2Type& theKey2,
TheKey1Type& theKey1) const TheKey1Type& theKey1) const
@ -465,7 +465,7 @@ public:
} }
//! Find the Key2 and return pointer to Key1 or NULL if not bound. //! Find the Key2 and return pointer to Key1 or NULL if not bound.
//! @param [in] theKey2 Key2 to find //! @param[in] theKey2 Key2 to find
//! @return pointer to Key1 if Key2 has been found //! @return pointer to Key1 if Key2 has been found
const TheKey1Type* Seek2 (const TheKey2Type& theKey2) const const TheKey1Type* Seek2 (const TheKey2Type& theKey2) const
{ {

@ -57,7 +57,7 @@ public:
//! Compute interpolated value between two values. //! Compute interpolated value between two values.
//! @param theT normalized interpolation coefficient within [0, 1] range, //! @param theT normalized interpolation coefficient within [0, 1] range,
//! with 0 pointing to first value and 1 to the second value. //! with 0 pointing to first value and 1 to the second value.
//! @param theResult [out] interpolated value //! @param[out] theResult interpolated value
void Interpolate (double theT, T& theResult) const void Interpolate (double theT, T& theResult) const
{ {
theResult = (1.0 - theT) * myStart + theT * myEnd; theResult = (1.0 - theT) * myStart + theT * myEnd;

@ -57,8 +57,8 @@ public:
} }
//! Get element at the specified row and column. //! Get element at the specified row and column.
//! @param theRow [in] the row.to address. //! @param[in] theRow the row.to address.
//! @param theCol [in] the column to address. //! @param[in] theCol the column to address.
//! @return the value of the addressed element. //! @return the value of the addressed element.
Element_t GetValue (const size_t theRow, const size_t theCol) const Element_t GetValue (const size_t theRow, const size_t theCol) const
{ {
@ -66,8 +66,8 @@ public:
} }
//! Access element at the specified row and column. //! Access element at the specified row and column.
//! @param theRow [in] the row.to access. //! @param[in] theRow the row.to access.
//! @param theCol [in] the column to access. //! @param[in] theCol the column to access.
//! @return reference on the matrix element. //! @return reference on the matrix element.
Element_t& ChangeValue (const size_t theRow, const size_t theCol) Element_t& ChangeValue (const size_t theRow, const size_t theCol)
{ {
@ -75,9 +75,9 @@ public:
} }
//! Set value for the element specified by row and columns. //! Set value for the element specified by row and columns.
//! @param theRow [in] the row to change. //! @param[in] theRow the row to change.
//! @param theCol [in] the column to change. //! @param[in] theCol the column to change.
//! @param theValue [in] the value to set.s //! @param[in] theValue the value to set.s
void SetValue (const size_t theRow, void SetValue (const size_t theRow,
const size_t theCol, const size_t theCol,
const Element_t theValue) const Element_t theValue)
@ -98,8 +98,8 @@ public:
} }
//! Change first 3 row values by the passed vector. //! Change first 3 row values by the passed vector.
//! @param theRow [in] the row to change. //! @param[in] theRow the row to change.
//! @param theVec [in] the vector of values. //! @param[in] theVec the vector of values.
void SetRow (const size_t theRow, const NCollection_Vec3<Element_t>& theVec) void SetRow (const size_t theRow, const NCollection_Vec3<Element_t>& theVec)
{ {
SetValue (theRow, 0, theVec.x()); SetValue (theRow, 0, theVec.x());
@ -114,8 +114,8 @@ public:
} }
//! Change first 3 column values by the passed vector. //! Change first 3 column values by the passed vector.
//! @param theCol [in] the column to change. //! @param[in] theCol the column to change.
//! @param theVec [in] the vector of values. //! @param[in] theVec the vector of values.
void SetColumn (const size_t theCol, void SetColumn (const size_t theCol,
const NCollection_Vec3<Element_t>& theVec) const NCollection_Vec3<Element_t>& theVec)
{ {
@ -182,7 +182,7 @@ public:
Element_t* ChangeData() { return myMat; } Element_t* ChangeData() { return myMat; }
//! Multiply by the vector (M * V). //! Multiply by the vector (M * V).
//! @param theVec [in] the vector to multiply. //! @param[in] theVec the vector to multiply.
NCollection_Vec3<Element_t> operator* (const NCollection_Vec3<Element_t>& theVec) const NCollection_Vec3<Element_t> operator* (const NCollection_Vec3<Element_t>& theVec) const
{ {
return NCollection_Vec3<Element_t> ( return NCollection_Vec3<Element_t> (
@ -192,8 +192,8 @@ public:
} }
//! Compute matrix multiplication product: A * B. //! Compute matrix multiplication product: A * B.
//! @param theMatA [in] the matrix "A". //! @param[in] theMatA the matrix "A".
//! @param theMatB [in] the matrix "B". //! @param[in] theMatB the matrix "B".
static NCollection_Mat3 Multiply (const NCollection_Mat3& theMatA, static NCollection_Mat3 Multiply (const NCollection_Mat3& theMatA,
const NCollection_Mat3& theMatB) const NCollection_Mat3& theMatB)
{ {
@ -214,14 +214,14 @@ public:
} }
//! Compute matrix multiplication. //! Compute matrix multiplication.
//! @param theMat [in] the matrix to multiply. //! @param[in] theMat the matrix to multiply.
void Multiply (const NCollection_Mat3& theMat) void Multiply (const NCollection_Mat3& theMat)
{ {
*this = Multiply(*this, theMat); *this = Multiply(*this, theMat);
} }
//! Multiply by the another matrix. //! Multiply by the another matrix.
//! @param theMat [in] the other matrix. //! @param[in] theMat the other matrix.
NCollection_Mat3& operator*= (const NCollection_Mat3& theMat) NCollection_Mat3& operator*= (const NCollection_Mat3& theMat)
{ {
Multiply (theMat); Multiply (theMat);
@ -229,7 +229,7 @@ public:
} }
//! Compute matrix multiplication product. //! Compute matrix multiplication product.
//! @param theMat [in] the other matrix. //! @param[in] theMat the other matrix.
//! @return result of multiplication. //! @return result of multiplication.
Standard_NODISCARD NCollection_Mat3 operator* (const NCollection_Mat3& theMat) const Standard_NODISCARD NCollection_Mat3 operator* (const NCollection_Mat3& theMat) const
{ {
@ -237,7 +237,7 @@ public:
} }
//! Compute matrix multiplication product. //! Compute matrix multiplication product.
//! @param theMat [in] the other matrix. //! @param[in] theMat the other matrix.
//! @return result of multiplication. //! @return result of multiplication.
Standard_NODISCARD NCollection_Mat3 Multiplied (const NCollection_Mat3& theMat) const Standard_NODISCARD NCollection_Mat3 Multiplied (const NCollection_Mat3& theMat) const
{ {
@ -247,7 +247,7 @@ public:
} }
//! Compute per-component multiplication. //! Compute per-component multiplication.
//! @param theFactor [in] the scale factor. //! @param[in] theFactor the scale factor.
void Multiply (const Element_t theFactor) void Multiply (const Element_t theFactor)
{ {
for (size_t i = 0; i < 9; ++i) for (size_t i = 0; i < 9; ++i)
@ -257,7 +257,7 @@ public:
} }
//! Compute per-element multiplication. //! Compute per-element multiplication.
//! @param theFactor [in] the scale factor. //! @param[in] theFactor the scale factor.
NCollection_Mat3& operator*= (const Element_t theFactor) NCollection_Mat3& operator*= (const Element_t theFactor)
{ {
Multiply (theFactor); Multiply (theFactor);
@ -265,7 +265,7 @@ public:
} }
//! Compute per-element multiplication. //! Compute per-element multiplication.
//! @param theFactor [in] the scale factor. //! @param[in] theFactor the scale factor.
//! @return the result of multiplication. //! @return the result of multiplication.
Standard_NODISCARD NCollection_Mat3 operator* (const Element_t theFactor) const Standard_NODISCARD NCollection_Mat3 operator* (const Element_t theFactor) const
{ {
@ -273,7 +273,7 @@ public:
} }
//! Compute per-element multiplication. //! Compute per-element multiplication.
//! @param theFactor [in] the scale factor. //! @param[in] theFactor the scale factor.
//! @return the result of multiplication. //! @return the result of multiplication.
Standard_NODISCARD NCollection_Mat3 Multiplied (const Element_t theFactor) const Standard_NODISCARD NCollection_Mat3 Multiplied (const Element_t theFactor) const
{ {
@ -283,7 +283,7 @@ public:
} }
//! Compute per-component division. //! Compute per-component division.
//! @param theFactor [in] the scale factor. //! @param[in] theFactor the scale factor.
void Divide (const Element_t theFactor) void Divide (const Element_t theFactor)
{ {
for (size_t i = 0; i < 9; ++i) for (size_t i = 0; i < 9; ++i)
@ -293,7 +293,7 @@ public:
} }
//! Per-component division. //! Per-component division.
//! @param theScalar [in] the scale factor. //! @param[in] theScalar the scale factor.
NCollection_Mat3& operator/= (const Element_t theScalar) NCollection_Mat3& operator/= (const Element_t theScalar)
{ {
Divide (theScalar); Divide (theScalar);

@ -76,8 +76,8 @@ public:
} }
//! Get element at the specified row and column. //! Get element at the specified row and column.
//! @param theRow [in] the row to address. //! @param[in] theRow the row to address.
//! @param theCol [in] the column to address. //! @param[in] theCol the column to address.
//! @return the value of the addressed element. //! @return the value of the addressed element.
Element_t GetValue (const size_t theRow, const size_t theCol) const Element_t GetValue (const size_t theRow, const size_t theCol) const
{ {
@ -85,8 +85,8 @@ public:
} }
//! Access element at the specified row and column. //! Access element at the specified row and column.
//! @param theRow [in] the row to access. //! @param[in] theRow the row to access.
//! @param theCol [in] the column to access. //! @param[in] theCol the column to access.
//! @return reference on the matrix element. //! @return reference on the matrix element.
Element_t& ChangeValue (const size_t theRow, const size_t theCol) Element_t& ChangeValue (const size_t theRow, const size_t theCol)
{ {
@ -94,9 +94,9 @@ public:
} }
//! Set value for the element specified by row and columns. //! Set value for the element specified by row and columns.
//! @param theRow [in] the row to change. //! @param[in] theRow the row to change.
//! @param theCol [in] the column to change. //! @param[in] theCol the column to change.
//! @param theValue [in] the value to set. //! @param[in] theValue the value to set.
void SetValue (const size_t theRow, void SetValue (const size_t theRow,
const size_t theCol, const size_t theCol,
const Element_t theValue) const Element_t theValue)
@ -111,7 +111,7 @@ public:
Element_t operator() (const size_t theRow, const size_t theCol) const { return GetValue (theRow, theCol); } Element_t operator() (const size_t theRow, const size_t theCol) const { return GetValue (theRow, theCol); }
//! Get vector of elements for the specified row. //! Get vector of elements for the specified row.
//! @param theRow [in] the row to access. //! @param[in] theRow the row to access.
//! @return vector of elements. //! @return vector of elements.
NCollection_Vec4<Element_t> GetRow (const size_t theRow) const NCollection_Vec4<Element_t> GetRow (const size_t theRow) const
{ {
@ -122,8 +122,8 @@ public:
} }
//! Change first 3 row values by the passed vector. //! Change first 3 row values by the passed vector.
//! @param theRow [in] the row to change. //! @param[in] theRow the row to change.
//! @param theVec [in] the vector of values. //! @param[in] theVec the vector of values.
void SetRow (const size_t theRow, const NCollection_Vec3<Element_t>& theVec) void SetRow (const size_t theRow, const NCollection_Vec3<Element_t>& theVec)
{ {
SetValue (theRow, 0, theVec.x()); SetValue (theRow, 0, theVec.x());
@ -132,8 +132,8 @@ public:
} }
//! Set row values by the passed 4 element vector. //! Set row values by the passed 4 element vector.
//! @param theRow [in] the row to change. //! @param[in] theRow the row to change.
//! @param theVec [in] the vector of values. //! @param[in] theVec the vector of values.
void SetRow (const size_t theRow, const NCollection_Vec4<Element_t>& theVec) void SetRow (const size_t theRow, const NCollection_Vec4<Element_t>& theVec)
{ {
SetValue (theRow, 0, theVec.x()); SetValue (theRow, 0, theVec.x());
@ -143,7 +143,7 @@ public:
} }
//! Get vector of elements for the specified column. //! Get vector of elements for the specified column.
//! @param theCol [in] the column to access. //! @param[in] theCol the column to access.
//! @return vector of elements. //! @return vector of elements.
NCollection_Vec4<Element_t> GetColumn (const size_t theCol) const NCollection_Vec4<Element_t> GetColumn (const size_t theCol) const
{ {
@ -154,8 +154,8 @@ public:
} }
//! Change first 3 column values by the passed vector. //! Change first 3 column values by the passed vector.
//! @param theCol [in] the column to change. //! @param[in] theCol the column to change.
//! @param theVec [in] the vector of values. //! @param[in] theVec the vector of values.
void SetColumn (const size_t theCol, void SetColumn (const size_t theCol,
const NCollection_Vec3<Element_t>& theVec) const NCollection_Vec3<Element_t>& theVec)
{ {
@ -165,8 +165,8 @@ public:
} }
//! Set column values by the passed 4 element vector. //! Set column values by the passed 4 element vector.
//! @param theCol [in] the column to change. //! @param[in] theCol the column to change.
//! @param theVec [in] the vector of values. //! @param[in] theVec the vector of values.
void SetColumn (const size_t theCol, void SetColumn (const size_t theCol,
const NCollection_Vec4<Element_t>& theVec) const NCollection_Vec4<Element_t>& theVec)
{ {
@ -196,7 +196,7 @@ public:
} }
//! Set diagonal elements of the matrix by the passed vector. //! Set diagonal elements of the matrix by the passed vector.
//! @param theVec [in] the vector of values. //! @param[in] theVec the vector of values.
void SetDiagonal (const NCollection_Vec4<Element_t>& theVec) void SetDiagonal (const NCollection_Vec4<Element_t>& theVec)
{ {
SetValue (0, 0, theVec.x()); SetValue (0, 0, theVec.x());
@ -257,7 +257,7 @@ public:
Element_t* ChangeData() { return myMat; } Element_t* ChangeData() { return myMat; }
//! Multiply by the vector (M * V). //! Multiply by the vector (M * V).
//! @param theVec [in] the vector to multiply. //! @param[in] theVec the vector to multiply.
NCollection_Vec4<Element_t> operator* (const NCollection_Vec4<Element_t>& theVec) const NCollection_Vec4<Element_t> operator* (const NCollection_Vec4<Element_t>& theVec) const
{ {
return NCollection_Vec4<Element_t> ( return NCollection_Vec4<Element_t> (
@ -268,8 +268,8 @@ public:
} }
//! Compute matrix multiplication product: A * B. //! Compute matrix multiplication product: A * B.
//! @param theMatA [in] the matrix "A". //! @param[in] theMatA the matrix "A".
//! @param theMatB [in] the matrix "B". //! @param[in] theMatB the matrix "B".
static NCollection_Mat4 Multiply (const NCollection_Mat4& theMatA, static NCollection_Mat4 Multiply (const NCollection_Mat4& theMatA,
const NCollection_Mat4& theMatB) const NCollection_Mat4& theMatB)
{ {
@ -290,14 +290,14 @@ public:
} }
//! Compute matrix multiplication. //! Compute matrix multiplication.
//! @param theMat [in] the matrix to multiply. //! @param[in] theMat the matrix to multiply.
void Multiply (const NCollection_Mat4& theMat) void Multiply (const NCollection_Mat4& theMat)
{ {
*this = Multiply(*this, theMat); *this = Multiply(*this, theMat);
} }
//! Multiply by the another matrix. //! Multiply by the another matrix.
//! @param theMat [in] the other matrix. //! @param[in] theMat the other matrix.
NCollection_Mat4& operator*= (const NCollection_Mat4& theMat) NCollection_Mat4& operator*= (const NCollection_Mat4& theMat)
{ {
Multiply (theMat); Multiply (theMat);
@ -305,7 +305,7 @@ public:
} }
//! Compute matrix multiplication product. //! Compute matrix multiplication product.
//! @param theMat [in] the other matrix. //! @param[in] theMat the other matrix.
//! @return result of multiplication. //! @return result of multiplication.
Standard_NODISCARD NCollection_Mat4 operator* (const NCollection_Mat4& theMat) const Standard_NODISCARD NCollection_Mat4 operator* (const NCollection_Mat4& theMat) const
{ {
@ -313,7 +313,7 @@ public:
} }
//! Compute matrix multiplication product. //! Compute matrix multiplication product.
//! @param theMat [in] the other matrix. //! @param[in] theMat the other matrix.
//! @return result of multiplication. //! @return result of multiplication.
Standard_NODISCARD NCollection_Mat4 Multiplied (const NCollection_Mat4& theMat) const Standard_NODISCARD NCollection_Mat4 Multiplied (const NCollection_Mat4& theMat) const
{ {
@ -323,7 +323,7 @@ public:
} }
//! Compute per-component multiplication. //! Compute per-component multiplication.
//! @param theFactor [in] the scale factor. //! @param[in] theFactor the scale factor.
void Multiply (const Element_t theFactor) void Multiply (const Element_t theFactor)
{ {
for (size_t i = 0; i < 16; ++i) for (size_t i = 0; i < 16; ++i)
@ -333,7 +333,7 @@ public:
} }
//! Compute per-element multiplication. //! Compute per-element multiplication.
//! @param theFactor [in] the scale factor. //! @param[in] theFactor the scale factor.
NCollection_Mat4& operator*= (const Element_t theFactor) NCollection_Mat4& operator*= (const Element_t theFactor)
{ {
Multiply (theFactor); Multiply (theFactor);
@ -341,7 +341,7 @@ public:
} }
//! Compute per-element multiplication. //! Compute per-element multiplication.
//! @param theFactor [in] the scale factor. //! @param[in] theFactor the scale factor.
//! @return the result of multiplication. //! @return the result of multiplication.
Standard_NODISCARD NCollection_Mat4 operator* (const Element_t theFactor) const Standard_NODISCARD NCollection_Mat4 operator* (const Element_t theFactor) const
{ {
@ -349,7 +349,7 @@ public:
} }
//! Compute per-element multiplication. //! Compute per-element multiplication.
//! @param theFactor [in] the scale factor. //! @param[in] theFactor the scale factor.
//! @return the result of multiplication. //! @return the result of multiplication.
Standard_NODISCARD NCollection_Mat4 Multiplied (const Element_t theFactor) const Standard_NODISCARD NCollection_Mat4 Multiplied (const Element_t theFactor) const
{ {
@ -359,7 +359,7 @@ public:
} }
//! Compute per-component division. //! Compute per-component division.
//! @param theFactor [in] the scale factor. //! @param[in] theFactor the scale factor.
void Divide (const Element_t theFactor) void Divide (const Element_t theFactor)
{ {
for (size_t i = 0; i < 16; ++i) for (size_t i = 0; i < 16; ++i)
@ -369,7 +369,7 @@ public:
} }
//! Per-component division. //! Per-component division.
//! @param theScalar [in] the scale factor. //! @param[in] theScalar the scale factor.
NCollection_Mat4& operator/= (const Element_t theScalar) NCollection_Mat4& operator/= (const Element_t theScalar)
{ {
Divide (theScalar); Divide (theScalar);
@ -459,7 +459,7 @@ public:
Standard_NODISCARD NCollection_Mat4 operator-() const { return Negated(); } Standard_NODISCARD NCollection_Mat4 operator-() const { return Negated(); }
//! Translate the matrix on the passed vector. //! Translate the matrix on the passed vector.
//! @param theVec [in] the translation vector. //! @param[in] theVec the translation vector.
void Translate (const NCollection_Vec3<Element_t>& theVec) void Translate (const NCollection_Vec3<Element_t>& theVec)
{ {
NCollection_Mat4 aTempMat; NCollection_Mat4 aTempMat;
@ -486,8 +486,8 @@ public:
} }
//! Compute inverted matrix. //! Compute inverted matrix.
//! @param theOutMx [out] the inverted matrix //! @param[out] theOutMx the inverted matrix
//! @param theDet [out] determinant of matrix //! @param[out] theDet determinant of matrix
//! @return true if reversion success //! @return true if reversion success
bool Inverted (NCollection_Mat4<Element_t>& theOutMx, Element_t& theDet) const bool Inverted (NCollection_Mat4<Element_t>& theOutMx, Element_t& theDet) const
{ {
@ -578,7 +578,7 @@ public:
} }
//! Compute inverted matrix. //! Compute inverted matrix.
//! @param theOutMx [out] the inverted matrix //! @param[out] theOutMx the inverted matrix
//! @return true if reversion success //! @return true if reversion success
bool Inverted (NCollection_Mat4<Element_t>& theOutMx) const bool Inverted (NCollection_Mat4<Element_t>& theOutMx) const
{ {

@ -50,11 +50,11 @@ public:
//! Opens stream for specified file URL for reading operations (std::istream). //! Opens stream for specified file URL for reading operations (std::istream).
//! Default implementation create a stream from file buffer returned by OSD_FileSystem::OpenFileBuffer(). //! Default implementation create a stream from file buffer returned by OSD_FileSystem::OpenFileBuffer().
//! @param theUrl [in] path to open //! @param[in] theUrl path to open
//! @param theMode [in] flags describing the requested input mode for the stream (std::ios_base::in will be implicitly added) //! @param[in] theMode flags describing the requested input mode for the stream (std::ios_base::in will be implicitly added)
//! @param theOffset [in] expected stream position from the beginning of the file (beginning of the stream by default); //! @param[in] theOffset expected stream position from the beginning of the file (beginning of the stream by default);
//! -1 would keep seek position undefined (in case of re-using theOldStream) //! -1 would keep seek position undefined (in case of re-using theOldStream)
//! @param theOldStream [in] a pointer to existing stream pointing to theUrl to be reused (without re-opening) //! @param[in] theOldStream a pointer to existing stream pointing to theUrl to be reused (without re-opening)
//! @return pointer to newly created opened stream, to theOldStream if it can be reused or NULL in case of failure. //! @return pointer to newly created opened stream, to theOldStream if it can be reused or NULL in case of failure.
Standard_EXPORT virtual std::shared_ptr<std::istream> OpenIStream Standard_EXPORT virtual std::shared_ptr<std::istream> OpenIStream
(const TCollection_AsciiString& theUrl, (const TCollection_AsciiString& theUrl,
@ -64,17 +64,17 @@ public:
//! Opens stream for specified file URL for writing operations (std::ostream). //! Opens stream for specified file URL for writing operations (std::ostream).
//! Default implementation create a stream from file buffer returned by OSD_FileSystem::OpenFileBuffer(). //! Default implementation create a stream from file buffer returned by OSD_FileSystem::OpenFileBuffer().
//! @param theUrl [in] path to open //! @param[in] theUrl path to open
//! @param theMode [in] flags describing the requested output mode for the stream (std::ios_base::out will be implicitly added) //! @param[in] theMode flags describing the requested output mode for the stream (std::ios_base::out will be implicitly added)
//! @return pointer to newly created opened stream or NULL in case of failure. //! @return pointer to newly created opened stream or NULL in case of failure.
Standard_EXPORT virtual std::shared_ptr<std::ostream> OpenOStream (const TCollection_AsciiString& theUrl, Standard_EXPORT virtual std::shared_ptr<std::ostream> OpenOStream (const TCollection_AsciiString& theUrl,
const std::ios_base::openmode theMode); const std::ios_base::openmode theMode);
//! Opens stream buffer for specified file URL. //! Opens stream buffer for specified file URL.
//! @param theUrl [in] path to open //! @param[in] theUrl path to open
//! @param theMode [in] flags describing the requested input mode for the stream //! @param[in] theMode flags describing the requested input mode for the stream
//! @param theOffset [in] expected stream position from the beginning of the buffer (beginning of the stream buffer by default) //! @param[in] theOffset expected stream position from the beginning of the buffer (beginning of the stream buffer by default)
//! @param theOutBufSize [out] total buffer size (only if buffer is opened for read) //! @param[out] theOutBufSize total buffer size (only if buffer is opened for read)
//! @return pointer to newly created opened stream buffer or NULL in case of failure. //! @return pointer to newly created opened stream buffer or NULL in case of failure.
virtual std::shared_ptr<std::streambuf> OpenStreamBuffer (const TCollection_AsciiString& theUrl, virtual std::shared_ptr<std::streambuf> OpenStreamBuffer (const TCollection_AsciiString& theUrl,
const std::ios_base::openmode theMode, const std::ios_base::openmode theMode,

@ -28,8 +28,8 @@ public:
OSD_FileSystemSelector() {} OSD_FileSystemSelector() {}
//! Registers file system within this selector. //! Registers file system within this selector.
//! @param theFileSystem [in] file system to register //! @param[in] theFileSystem file system to register
//! @param theIsPreferred [in] add to the beginning of the list when TRUE, or add to the end otherwise //! @param[in] theIsPreferred add to the beginning of the list when TRUE, or add to the end otherwise
Standard_EXPORT void AddProtocol (const Handle(OSD_FileSystem)& theFileSystem, bool theIsPreferred = false); Standard_EXPORT void AddProtocol (const Handle(OSD_FileSystem)& theFileSystem, bool theIsPreferred = false);
//! Unregisters file system within this selector. //! Unregisters file system within this selector.

Some files were not shown because too many files have changed in this diff Show More