OpenCascade/occt
1
0
Fork 0
mirror of https://git.dev.opencascade.org/repos/occt.git synced 2025-08-14 13:30:48 +03:00
Code Activity

Documentation - Update parameter annotations for consistency #161

Browse Source 
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
Download Patch File Download Diff File Expand all files Collapse all files

34
src/IVtkTools/IVtkTools.hxx
View File

@@ -35,33 +35,33 @@ namespace IVtkTools
//! Set a color for given type of sub-shapes.
//! @param [in,out] theColorTable vtkLookupTable 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] theG green 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] theColorRole type of sub-shapes to set the color.
//! @param[in] theR red 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] theA the alpha value (the opacity) as a double between 0 and 1.
Standard_EXPORT void SetLookupTableColor (vtkLookupTable* theColorTable,
const IVtk_MeshType theColorRole,
const double theR, const double theG, const double theB,
const double theA = 1);
//! Get a color for given type of sub-shapes.
//! @param [in] theColorTable vtkLookupTable 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] 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[in] theColorTable vtkLookupTable 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] theG green 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,
const IVtk_MeshType theColorRole,
double &theR, double &theG, double &theB);
//! Get a color for given type of sub-shapes.
//! @param [in] theColorTable vtkLookupTable 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] 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] theA the alpha value (the opacity) as a double between 0 and 1.
//! @param[in] theColorTable vtkLookupTable 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] 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] theA the alpha value (the opacity) as a double between 0 and 1.
Standard_EXPORT void GetLookupTableColor (vtkLookupTable* theColorTable,
const IVtk_MeshType theColorRole,
double &theR, double &theG, double &theB,
@@ -72,7 +72,7 @@ namespace IVtkTools
//! Set up the initial shape mapper parameters with user colors.
//! @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,
vtkLookupTable* theColorTable);

14
src/IVtkTools/IVtkTools_ShapeDataSource.hxx
View File

@@ -46,7 +46,7 @@ public:
public: //! @name Initialization
//! Set the source OCCT shape.
//! @param theOccShape [in] OCCT shape wrapper.
//! @param[in] theOccShape OCCT shape wrapper.
void SetShape(const IVtkOCC_Shape::Handle& theOccShape);
//! Get the source OCCT shape.
@@ -63,7 +63,7 @@ public: //! @name Data accessors
IVtk_IdType GetId() const;
//! 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.
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 the method you should override if you use this class as ancestor.
//! 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.
//! @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).
//! @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,
vtkInformationVector** theInputVector,
vtkInformationVector* theOutputVector) Standard_OVERRIDE;
@@ -89,8 +89,8 @@ protected: //! @name Internals
//! Transforms the passed polygonal data by the given OCCT transformation
//! matrix.
//! @param theSource [in] source polygonal data to transform.
//! @param theTrsf [in] transformation to apply.
//! @param[in] theSource source polygonal data to transform.
//! @param[in] theTrsf transformation to apply.
//! @return resulting polygonal data (transformed copy of source).
vtkSmartPointer<vtkPolyData> transform (vtkPolyData* theSource, const gp_Trsf& theTrsf) const;

40
src/IVtkTools/IVtkTools_ShapePicker.hxx
View File

@@ -67,38 +67,38 @@ public:
//! Sets the renderer to be used by OCCT selection algorithm
void SetRenderer (vtkRenderer* theRenderer);
//! 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);
//! 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
IVtk_SelectionModeList GetSelectionModes (const IVtk_IShape::Handle& theShape) const;
//! 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
IVtk_SelectionModeList GetSelectionModes (vtkActor* theShapeActor) const;
//! Turn on/off a selection mode for a shape actor.
//! @param [in] theShape a shape to set a selection mode for
//! @param [in] theMode selection mode to be activated
//! @param [in] theIsTurnOn Flag to turn on/off the selection mode
//! @param[in] theShape a shape to set a selection mode for
//! @param[in] theMode selection mode to be activated
//! @param[in] theIsTurnOn Flag to turn on/off the selection mode
void SetSelectionMode (const IVtk_IShape::Handle& theShape,
const IVtk_SelectionMode theMode,
const bool theIsTurnOn = true) const;
//! Turn on/off a selection mode for a shape actor.
//! @param [in] theShapeActor shape presentation actor to set a selection mode for
//! @param [in] theMode selection mode to be activated
//! @param [in] theIsTurnOn Flag to turn on/off the selection mode
//! @param[in] theShapeActor shape presentation actor to set a selection mode for
//! @param[in] theMode selection mode to be activated
//! @param[in] theIsTurnOn Flag to turn on/off the selection mode
void SetSelectionMode (vtkActor* theShapeActor,
const IVtk_SelectionMode theMode,
const bool theIsTurnOn = true) const;
//! Sets the current selection mode for all visible shape objects.
//! @param [in] theMode selection mode to be activated
//! @param [in] theIsTurnOn Flag to turn on/off the selection mode
//! @param[in] theMode selection mode to be activated
//! @param[in] theIsTurnOn Flag to turn on/off the selection mode
void SetSelectionMode (const IVtk_SelectionMode theMode,
const bool theIsTurnOn = true) const;
@@ -109,30 +109,30 @@ public:
//! 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
//! 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.
//! @return List of top-level shape IDs
IVtk_ShapeIdList GetPickedShapesIds (bool theIsAll = false) const;
//! Access to the list of sub-shapes ids picked.
//! @param [in] theId top-level shape ID
//! @param [in] theIsAll Get all selected sub-shapes or just the
//! @param[in] theId top-level shape ID
//! @param[in] theIsAll Get all selected sub-shapes or just the
//! only top one is returned, has no effect during area selection.
//! @return List of sub-shapes IDs
IVtk_ShapeIdList GetPickedSubShapesIds (const IVtk_IdType theId, bool theIsAll = false) const;
//! 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.
//! @return List of actors IDs
vtkSmartPointer<vtkActorCollection> GetPickedActors (bool theIsAll = false) const;
//! 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);
//! 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);
protected:
@@ -152,10 +152,10 @@ private: // not copyable
//! Implementation of picking algorithm.
//! 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)
//! @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] renderer vtkRenderer object to be used (normally set in advance with setRenderer())
//! @param[in] nbPoints number of points for polyline case
//! @see IVtkTools_ShapePicker::setRenderer
virtual void doPickImpl (double*, vtkRenderer* theRenderer, const int theNbPoints = -1);