0023383: Bugs in CDL documentation of visualization classes
authoraba <aba@opencascade.com>
Fri, 2 Nov 2012 12:02:19 +0000 (16:02 +0400)
committeraba <aba@opencascade.com>
Fri, 2 Nov 2012 12:02:19 +0000 (16:02 +0400)
Added lines in CDL documentation for SetDisplayPriority and SetViewingVolume.

src/Graphic3d/Graphic3d_Structure.cdl
src/V3d/V3d_View.cdl

index 1e71d03..d142af8 100755 (executable)
@@ -235,9 +235,11 @@ is
                             Priority   : Integer from Standard )
        ---Level: Public
        ---Purpose: Modifies the order of displaying the structure.
-       --          Values are between 0 et 10.
-       --          The priority 10 being displayed first.
-       --          The default value is 5
+       --          Values are between 0 and 10.
+       --      Structures are drawn according to their display priorities
+       --      in ascending order.
+       --          A structure of priority 10 is displayed the last and appears over the others.
+       --          The default value is 5.
        --  Category: Methods to modify the class definition
        --  Warning: If <me> is displayed then the SetDisplayPriority
        --          method erase <me> and display <me> with the
index 0d67fc4..f96274e 100755 (executable)
@@ -967,7 +967,10 @@ is
     SetViewingVolume ( me : mutable ; Left, Right, Bottom, Top, ZNear, ZFar : Real from Standard)
         ---Level: Public
         ---Purpose: Sets Z and XY size of the view according to given values
-    --          with respecting the initial view depth (eye position)
+        --          with respecting the initial view depth (eye position).
+        --          Width/heigth aspect ratio should be preserved by the caller
+        --          of this method similarly to SetSize() to avoid unexpected
+        --          visual results like non-uniform scaling of objects in the view. 
                 raises BadValue from Viewer;
         --              If the ZNear<0, ZFar<0 or ZNear>=Zfar.