0024428: Implementation of LGPL license
[occt.git] / src / AIS / AIS_LocalContext.cdl
old mode 100755 (executable)
new mode 100644 (file)
index 7245e18..11341c0
@@ -1,8 +1,19 @@
--- File:        AIS_LocalContext.cdl
--- Created:     Wed Sep  4 16:13:24 1996
--- Author:      Robert COUBLANC
---              <rob@robox.paris1.matra-dtv.fr>
---              
+-- Created on: 1996-09-04
+-- Created by: Robert COUBLANC
+-- Copyright (c) 1996-1999 Matra Datavision
+-- Copyright (c) 1999-2014 OPEN CASCADE SAS
+--
+-- This file is part of Open CASCADE Technology software library.
+--
+-- This library is free software; you can redistribute it and / or modify it
+-- under the terms of the GNU Lesser General Public version 2.1 as published
+-- by the Free Software Foundation, with special exception defined in the file
+-- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
+-- distribution for complete text of the license and disclaimer of any warranty.
+--
+-- Alternatively, this file may be used under the terms of Open CASCADE
+-- commercial license or contractual agreement.
+
 -- Modified     May  20th 98  :  
 --              Modification in Management of selected entities 
 --              Now we store the selected entity Owner in AIS_Selection.
 --   ZSV : IMP160701 Add InitDetected(),MoreDetected(),NextDetected(),
 --                       DetectedCurrentShape(),DetectedCurrentObject()
 --                       methods
---        
----Copyright:    Matra Datavision 1996
 
 
-private class LocalContext from AIS inherits TShared from MMgt
+class LocalContext from AIS inherits TShared from MMgt
 
         ---Purpose: Defines a specific context  for selection.      
         --          It becomes possible to:
@@ -59,6 +68,7 @@ uses
     ListOfFilter              from SelectMgr,
     BRepOwner                 from StdSelect,
     ViewerSelector3d          from StdSelect,
+    SensitivityMode           from StdSelect,
     InteractiveContext        from AIS,
     ClearMode                 from AIS,
     InteractiveObject         from AIS,
@@ -373,6 +383,26 @@ is
                        anObject: InteractiveObject from AIS;
                        Prior   : Integer from Standard);
 
+    SetZLayer( me         : mutable;
+               theIObj    : InteractiveObject from AIS;
+               theLayerId : Integer from Standard );
+    ---Purpose: Set Z layer id for interactive object. The layer can be
+    -- specified for displayed object only. The Z layers can be used to display
+    -- temporarily presentations of some object in front of the other objects
+    -- in the scene. The ids for Z layers are generated by V3d_Viewer.
+    -- Note that Z layers differ from under-/overlayer in V3d_View:
+    -- under-/overlayer are intended for specific 2D drawings that appear
+    -- behind/in front of all 3D presentations, while SetZLayer() method
+    -- applies to regular 3D presentations and does not imply any specific
+    -- drawing methods.
+
+    GetZLayer( me;
+               theIObj : InteractiveObject from AIS )
+      returns Integer from Standard;
+    ---Purpose: Get Z layer id set for displayed interactive object.
+    -- If the object doesn't exists in context or has no computed presentations,
+    -- the method returns -1.
+
     DisplayedObjects(me;theMapToFill : in out MapOfTransient from TColStd)
     returns Integer from Standard;
 
@@ -410,18 +440,37 @@ is
                 HiCol     : out NameOfColor from Quantity)
     returns Boolean from Standard;
     
+    SetSensitivityMode(me    : mutable;
+                       aMode : SensitivityMode from StdSelect) is static;
+    ---Level: Public
+    ---Purpose: Sets the selection sensitivity mode. SM_WINDOW mode
+    -- uses the specified pixel tolerance to compute the sensitivity
+    -- value, SM_VIEW mode allows to define the sensitivity manually.
+
+    SensitivityMode(me) returns SensitivityMode from StdSelect;
+    ---Level: Public
+    ---Purpose: Returns the selection sensitivity mode.
+
     SetSensitivity(me:mutable;
                         aPrecision: Real from Standard);
     ---Level: Public
     ---Purpose: Define the current selection sensitivity for
     --          this local context according to the view size.
     
-    SetSensitivity(me:mutable;
+    Sensitivity (me) returns Real from Standard;
+    ---Level: Public 
+    ---Purpose: Returns the selection sensitivity value.
+
+    SetPixelTolerance(me:mutable;
                         aPrecision: Integer from Standard = 2);
     ---Level: Public
     ---Purpose: Define the current selection sensitivity for
     --          this local context according to the view size.
 
+    PixelTolerance(me) returns Integer from Standard;
+    ---Level: Public 
+    ---Purpose: Returns the pixel tolerance.
+
                         ---Category: IMMEDIATE MODE
 
 
@@ -531,10 +580,10 @@ is
 
 
     FindSelectedOwnerFromIO(me;anIObj:InteractiveObject from AIS)
-    returns EntityOwner from SelectMgr is private;
+    returns EntityOwner from SelectMgr;
 
     FindSelectedOwnerFromShape(me;aShape : Shape from TopoDS)
-    returns EntityOwner from SelectMgr is private;
+    returns EntityOwner from SelectMgr;