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

0024737: Coding - remove <br> tag from header files

Browse Source 
Eliminate #ifdefs around #includes, some unnecessary includes and macros
This commit is contained in:
kgv
2014-03-20 14:12:12 +04:00
committed by bugmaster
parent df80c6ddda
commit ebc93ae74f
130 changed files with 563 additions and 1555 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
src/NIS/NIS_InteractiveContext.hxx
View File

@@ -24,10 +24,9 @@
#include <NIS_Drawer.hxx>
#include <NIS_SelectFilter.hxx>
#ifdef WNT
// undefine WinAPI macros
#ifdef GetObject
#undef GetObject
#endif
#undef GetObject
#endif
class NIS_View;
@@ -36,13 +35,11 @@ class Bnd_B2f;
/**
* InteractiveContext is the central NIS structure that stores and manages
* all NIS_InteractiveObject instances as well as the Drawers for their
* visualisation.
* all NIS_InteractiveObject instances as well as the Drawers for their visualisation.
* There may be one or more Views referred by an InteractiveContext instance.
* Also there may be one or more InteractiveContext instances referring the same
* View. However the latter case is not typical (see NIS_View description).<br>
* To add or remove a View in a Context, use methods AttachView() and
* DetachView().
* Also there may be one or more InteractiveContext instances referring the same View.
* However the latter case is not typical (see NIS_View description).
* To add or remove a View in a Context, use methods AttachView() and DetachView().
*
* @section nis_interactivecontext_mgtobjects Management of objects
* The main purpose of class NIS_InteractiveContext is allocation and
@@ -50,13 +47,10 @@ class Bnd_B2f;
* <p>An InteractiveObject should be added to the Context by a call to method
* Display() or DisplayOnTop(). After that (not before) it becomes possible to:
* <ul>
* <li>change the presentation of the InteractiveObject (e.g., modify the color)
* </li>
* <li>make the InteractiveObject visible or invisible, selectable or
* unselectable;</li>
* <li>change the presentation of the InteractiveObject (e.g., modify the color)</li>
* <li>make the InteractiveObject visible or invisible, selectable or unselectable;</li>
* <li>set Transparency;</li>
* <li>select InteractiveObject interactively, including the hilighting and
* the dynamic hilighting.</li>
* <li>select InteractiveObject interactively, including the hilighting and the dynamic hilighting.</li>
* </ul>
* Methods that add/remove/display/hide NIS_InteractiveObject instances have
* the optional parameter 'isUpdateViews'. When it is set to True (default),
@@ -348,14 +342,11 @@ class NIS_InteractiveContext : public Standard_Transient
{ mySelectionMode = theMode; }
/**
* Set or unset the selected state of the object, also changing its
* hilight status.<br>
* If mySelectionMode == Mode_NoSelection this method does nothing (returns
* False always).<br>
* Set or unset the selected state of the object, also changing its hilight status.
* If mySelectionMode == Mode_NoSelection this method does nothing (returns False always).
* If the given object is NULL (e.g., if the mouse was clicked on empty area),
* then the current selection is cleared (modes Normal and Additive only).<br>
* The selection algorithm with respect to the given object is defined by
* the current selection mode :
* then the current selection is cleared (modes Normal and Additive only).
* The selection algorithm with respect to the given object is defined by the current selection mode:
* <ul>
* <li>Mode_Normal - the selection state is toggled</li>
* <li>Mode_Additive - the object is always added to the selection</li>
@@ -388,8 +379,7 @@ class NIS_InteractiveContext : public Standard_Transient
= Standard_False);
/**
* Set or unset the selected state of the object, also changing its
* hilight status.<br>
* Set or unset the selected state of the object, also changing its hilight status.
* This method does not update the views.
* @param theObj
* Object to be selected or deselected
@@ -607,7 +597,7 @@ private:
* - #1 - top objects
* - #2 - hilighted objects (i.e., selected)
* - #3 - transparent objects
* <br>Each object can have only one entry in these maps.
* Each object can have only one entry in these maps.
*/
TColStd_PackedMapOfInteger myMapObjects[4];

10
src/NIS/NIS_InteractiveObject.hxx
View File

@@ -160,10 +160,10 @@ class NIS_InteractiveObject : public Standard_Transient
/**
* Replace the drawer. This method must not be called for Object that
* has not yet been added to a Context (thus has empty drawer).<br>
* has not yet been added to a Context (thus has empty drawer).
* It is possible to have unassigned myDrawer or a DefaultDrawer as the
* parameter value (but not both). The Context where we work is taken
* from theDrawer first, then (if NULL) -- from myDrawer.<br>
* from theDrawer first, then (if NULL) -- from myDrawer.
* This method matches theDrawer with the available Drawers in the Context
* and adds if no match is found.
* @return
@@ -291,8 +291,7 @@ class NIS_InteractiveObject : public Standard_Transient
* Intersect the InteractiveObject geometry with an oriented box.
* The default implementation (in this abstract class) always returns True,
* signalling that every object pre-selected by its bounding box is
* automatically selected. The specializations should define a more correct
* behaviour.<br>
* automatically selected. The specializations should define a more correct behaviour.
* The algorithm should transform the InteractiveObject geometry using the
* parameter theTrf and then reject it with box theBox, like:
* @code
@@ -320,8 +319,7 @@ class NIS_InteractiveObject : public Standard_Transient
* Intersect the InteractiveObject geometry with a selection polygon.
* The default implementation (in this abstract class) always returns True,
* signalling that every object pre-selected by its bounding box is
* automatically selected. The specializations should define a more correct
* behaviour.<br>
* automatically selected. The specializations should define a more correct behaviour.
* The algorithm should transform the InteractiveObject geometry using the
* parameter theTrf and then reject it with polygon.
* @param thePolygon

11
src/NIS/NIS_SelectFilter.hxx
View File

@@ -23,14 +23,11 @@ class NIS_InteractiveObject;
class Handle_Standard_Type;
/**
* Interface for selection filters. It can be used in NIS_InteractiveContext
* by methods SetFilter and GetFilter.<br>
* Unlike in AIS, only one filter can be installed in InteractiveContext. If
* you need more than one filter instance to work together, create a composite
* NIS_SelectFilter specialization that would hold a list of simpler Filter
* instances.
* Interface for selection filters. It can be used in NIS_InteractiveContext by methods SetFilter and GetFilter.
* Unlike in AIS, only one filter can be installed in InteractiveContext.
* If you need more than one filter instance to work together, create a composite
* NIS_SelectFilter specialization that would hold a list of simpler Filter instances.
*/
class NIS_SelectFilter : public Standard_Transient
{
public: