From 9edc5e12b6985033f3b48c642cbdde92eb278918 Mon Sep 17 00:00:00 2001 From: aba Date: Fri, 2 Nov 2012 16:02:19 +0400 Subject: [PATCH] 0023383: Bugs in CDL documentation of visualization classes Added lines in CDL documentation for SetDisplayPriority and SetViewingVolume. --- src/Graphic3d/Graphic3d_Structure.cdl | 8 +++++--- src/V3d/V3d_View.cdl | 5 ++++- 2 files changed, 9 insertions(+), 4 deletions(-) diff --git a/src/Graphic3d/Graphic3d_Structure.cdl b/src/Graphic3d/Graphic3d_Structure.cdl index 1e71d037f5..d142af84e5 100755 --- a/src/Graphic3d/Graphic3d_Structure.cdl +++ b/src/Graphic3d/Graphic3d_Structure.cdl @@ -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 is displayed then the SetDisplayPriority -- method erase and display with the diff --git a/src/V3d/V3d_View.cdl b/src/V3d/V3d_View.cdl index 0d67fc479e..f96274e58d 100755 --- a/src/V3d/V3d_View.cdl +++ b/src/V3d/V3d_View.cdl @@ -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. -- 2.20.1