0027860: Visualization - clean up Transformation Persistence API
[occt.git] / src / Graphic3d / Graphic3d_TransModeFlags.hxx
index f7e2512..550851f 100644 (file)
 #ifndef Graphic3d_TRANS_MODE_FLAGS_HXX
 #define Graphic3d_TRANS_MODE_FLAGS_HXX
 
-typedef Standard_Integer Graphic3d_TransModeFlags;
-
-enum {
-  Graphic3d_TMF_None               = 0x0000,
-  Graphic3d_TMF_PanPers            = 0x0001,
-  Graphic3d_TMF_ZoomPers           = 0x0002,
-  Graphic3d_TMF_RotatePers         = 0x0008,
-  Graphic3d_TMF_TriedronPers       = 0x0020,
-  Graphic3d_TMF_2d                 = 0x0040,
-  Graphic3d_TMF_FullPers           = Graphic3d_TMF_PanPers | Graphic3d_TMF_ZoomPers | Graphic3d_TMF_RotatePers
+//! Transform Persistence Mode defining whether to lock in object position, rotation and / or zooming relative to camera position.
+enum Graphic3d_TransModeFlags
+{
+  Graphic3d_TMF_None           = 0x0000,                  //!< no persistence attributes (normal 3D object)
+  Graphic3d_TMF_ZoomPers       = 0x0002,                  //!< object does not resize
+  Graphic3d_TMF_RotatePers     = 0x0008,                  //!< object does not rotate;
+  Graphic3d_TMF_TriedronPers   = 0x0020,                  //!< object behaves like trihedron - it is fixed at the corner of view and does not resizing (but rotating)
+  Graphic3d_TMF_2d             = 0x0040,                  //!< object is defined in 2D screen coordinates (pixels) and does not resize, pan and rotate
+  Graphic3d_TMF_ZoomRotatePers = Graphic3d_TMF_ZoomPers
+                               | Graphic3d_TMF_RotatePers //!< object doesn't resize and rotate
 };
 
-
 #endif