mirror of
https://git.dev.opencascade.org/repos/occt.git
synced 2025-08-14 13:30:48 +03:00
Documentation - Update parameter annotations for consistency #161
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
@@ -61,17 +61,17 @@ public:
|
||||
Standard_EXPORT virtual void SetPixelTolerance (const Standard_Integer theTol);
|
||||
|
||||
//! Note that this method does not perform any checks on type of the frustum.
|
||||
//! @param theScaleFactor [in] scale factor for new intersector or negative value if undefined;
|
||||
//! @param[in] theScaleFactor scale factor for new intersector or negative value if undefined;
|
||||
//! IMPORTANT: scaling makes sense only for scalable ::IsScalable() intersectors (built on a single point)!
|
||||
//! @param theTrsf [in] transformation for new intersector or gp_Identity if undefined
|
||||
//! @param theBuilder [in] an optional argument that represents corresponding settings for re-constructing transformed frustum from scratch;
|
||||
//! @param[in] theTrsf transformation for new intersector or gp_Identity if undefined
|
||||
//! @param[in] theBuilder an optional argument that represents corresponding settings for re-constructing transformed frustum from scratch;
|
||||
//! could be NULL if reconstruction is not expected furthermore
|
||||
//! @return a copy of the frustum resized according to the scale factor given and transforms it using the matrix given
|
||||
virtual Handle(SelectMgr_BaseIntersector) ScaleAndTransform (const Standard_Integer theScaleFactor,
|
||||
const gp_GTrsf& theTrsf,
|
||||
const Handle(SelectMgr_FrustumBuilder)& theBuilder) const = 0;
|
||||
|
||||
//! @param theBuilder [in] argument that represents corresponding settings for re-constructing transformed frustum from scratch;
|
||||
//! @param[in] theBuilder argument that represents corresponding settings for re-constructing transformed frustum from scratch;
|
||||
//! should NOT be NULL.
|
||||
//! @return a copy of the frustum with the input builder assigned
|
||||
virtual Handle(SelectMgr_BaseIntersector) CopyWithBuilder (const Handle(SelectMgr_FrustumBuilder)& theBuilder) const = 0;
|
||||
|
||||
@@ -137,7 +137,7 @@ public:
|
||||
Standard_Boolean IsSelected() const { return myIsSelected; }
|
||||
|
||||
//! Set the state of the owner.
|
||||
//! @param theIsSelected [in] shows if owner is selected.
|
||||
//! @param[in] theIsSelected shows if owner is selected.
|
||||
void SetSelected (const Standard_Boolean theIsSelected) { myIsSelected = theIsSelected; }
|
||||
|
||||
//! If the object needs to be selected, it returns true.
|
||||
|
||||
@@ -101,7 +101,7 @@ public:
|
||||
|
||||
//! Returns a copy of the frustum using the given frustum builder configuration.
|
||||
//! Returned frustum should be re-constructed before being used.
|
||||
//! @param theBuilder [in] argument that represents corresponding settings for re-constructing transformed frustum from scratch;
|
||||
//! @param[in] theBuilder argument that represents corresponding settings for re-constructing transformed frustum from scratch;
|
||||
//! should NOT be NULL.
|
||||
//! @return a copy of the frustum with the input builder assigned
|
||||
Standard_EXPORT virtual Handle(SelectMgr_BaseIntersector) CopyWithBuilder (const Handle(SelectMgr_FrustumBuilder)& theBuilder) const Standard_OVERRIDE;
|
||||
|
||||
@@ -225,9 +225,9 @@ public:
|
||||
|
||||
//! Valid for point selection only!
|
||||
//! Computes depth range for clipping planes.
|
||||
//! @param theViewPlanes [in] global view planes
|
||||
//! @param theObjPlanes [in] object planes
|
||||
//! @param theWorldSelMgr [in] selection volume in world space for computing clipping plane ranges
|
||||
//! @param[in] theViewPlanes global view planes
|
||||
//! @param[in] theObjPlanes object planes
|
||||
//! @param[in] theWorldSelMgr selection volume in world space for computing clipping plane ranges
|
||||
Standard_EXPORT void SetViewClipping (const Handle(Graphic3d_SequenceOfHClipPlane)& theViewPlanes,
|
||||
const Handle(Graphic3d_SequenceOfHClipPlane)& theObjPlanes,
|
||||
const SelectMgr_SelectingVolumeManager* theWorldSelMgr);
|
||||
|
||||
@@ -57,7 +57,7 @@ public:
|
||||
|
||||
//! Returns a copy of the frustum using the given frustum builder configuration.
|
||||
//! Returned frustum should be re-constructed before being used.
|
||||
//! @param theBuilder [in] argument that represents corresponding settings for re-constructing transformed frustum from scratch;
|
||||
//! @param[in] theBuilder argument that represents corresponding settings for re-constructing transformed frustum from scratch;
|
||||
//! should NOT be NULL.
|
||||
//! @return a copy of the frustum with the input builder assigned
|
||||
Standard_EXPORT virtual Handle(SelectMgr_BaseIntersector) CopyWithBuilder (const Handle(SelectMgr_FrustumBuilder)& theBuilder) const Standard_OVERRIDE;
|
||||
|
||||
@@ -64,7 +64,7 @@ public:
|
||||
|
||||
//! Returns a copy of the frustum using the given frustum builder configuration.
|
||||
//! Returned frustum should be re-constructed before being used.
|
||||
//! @param theBuilder [in] argument that represents corresponding settings for re-constructing transformed frustum from scratch;
|
||||
//! @param[in] theBuilder argument that represents corresponding settings for re-constructing transformed frustum from scratch;
|
||||
//! should NOT be NULL.
|
||||
//! @return a copy of the frustum with the input builder assigned
|
||||
Standard_EXPORT virtual Handle(SelectMgr_BaseIntersector) CopyWithBuilder (const Handle(SelectMgr_FrustumBuilder)& theBuilder) const Standard_OVERRIDE;
|
||||
|
||||
@@ -126,8 +126,8 @@ public:
|
||||
Standard_Real DepthTolerance() const { return myDepthTolerance; }
|
||||
|
||||
//! Set the tolerance for considering two entities having a similar depth (distance from eye to entity).
|
||||
//! @param theType [in] type of tolerance value
|
||||
//! @param theTolerance [in] tolerance value in 3D scale (SelectMgr_TypeOfDepthTolerance_Uniform)
|
||||
//! @param[in] theType type of tolerance value
|
||||
//! @param[in] theTolerance tolerance value in 3D scale (SelectMgr_TypeOfDepthTolerance_Uniform)
|
||||
//! or in pixels (SelectMgr_TypeOfDepthTolerance_UniformPixels);
|
||||
//! value is ignored in case of SelectMgr_TypeOfDepthTolerance_SensitivityFactor
|
||||
void SetDepthTolerance (SelectMgr_TypeOfDepthTolerance theType,
|
||||
@@ -325,10 +325,10 @@ protected:
|
||||
|
||||
//! Internal function that checks if there is possible overlap between some entity of selectable object theObject and
|
||||
//! current selecting volume.
|
||||
//! @param theObject [in] the selectable object for traversal.
|
||||
//! @param theMgr [in] the (un)transformed copy of the selecting volume manager representing active selection frustum.
|
||||
//! @param theCamera, theProjectionMat, theWorldViewMat [in] the source camera and matrices for theMgr given.
|
||||
//! @param theWinSize [in] viewport (window) dimensions for evaluating
|
||||
//! @param[in] theObject the selectable object for traversal.
|
||||
//! @param[in] theMgr the (un)transformed copy of the selecting volume manager representing active selection frustum.
|
||||
//! @param theCamera, theProjectionMat, theWorldViewMat[in] the source camera and matrices for theMgr given.
|
||||
//! @param[in] theWinSize viewport (window) dimensions for evaluating
|
||||
//! object's transformation persistence.
|
||||
Standard_EXPORT void traverseObject (const Handle(SelectMgr_SelectableObject)& theObject,
|
||||
const SelectMgr_SelectingVolumeManager& theMgr,
|
||||
|
||||
Reference in New Issue
Block a user