[occt.git] / src / PrsMgr / PrsMgr_PresentableObject.cdl

-- Created on: 1995-01-25
-- Created by: Jean-Louis Frenkel
-- Copyright (c) 1995-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 by  Rob (18/12/96) -> information about modes to update.
--              Rob (04/07/97) ->   TypeOfPresentation3d () Method 
--                                  changed to Public Method.
--                             -> Option Projector Dependant/Independant
--                                may be set at any time , not only in
--                                the constructor or the presentable.
--                               ->Insert Locations Methods...
--              Rob (16/12/97) -> Get the list of modes to be updated
--                             -> Flags all the Prs to be updated...                 
--              GG IMP020200   -> Presentations() method become protected
--                              and no more private.
--              SAN (22/03/04) -> OCC4895 High-level interface for controlling 
--                              polygon offsets: Fill() made protected virtual.

deferred class PresentableObject from PrsMgr inherits TShared from MMgt


    	---Purpose: A framework to supply the Graphic3d
    	-- structure of the object to be presented. On the first
    	-- display request, this structure is created by calling the
    	-- appropriate algorithm and retaining this frameworkfor
    	-- further display.
    	-- This abstract framework is inherited in Application
    	-- Interactive Services (AIS), notably in:
    	-- -   AIS_InteractiveObject
    	-- -   AIS_ConnectedInteractive
    	-- -   AIS_MultipleConnectedInteractive
    	-- -   AIS_Shape
    	--   Consequently, 3D presentation should be handled by
    	-- the relevant daughter classes and their member
    	-- functions in AIS. This is particularly true in the
    	-- creation of new interactive objects.

uses
    Presentation          from PrsMgr,
    Presentation          from Prs3d,
    Presentations         from PrsMgr,
    PresentationManager   from PrsMgr,
    PresentationManager3d from PrsMgr,
    TypeOfPresentation3d  from PrsMgr,
    DataStructureManager  from Graphic3d,
    Projector             from Prs3d,
    Transformation        from Geom,
    ListOfInteger         from TColStd,
    Location              from TopLoc, 
    ClipPlane_Handle      from Graphic3d,
    SequenceOfHClipPlane  from Graphic3d,
    --   ABD 29/10/04  Transform Persistence of Presentation( pan, zoom, rotate )
    TransModeFlags        from Graphic3d, 
    Pnt                   from gp, 
    CTransPersStruct      from  Graphic3d      
    --   ABD 29/10/04  Transform Persistence of Presentation( pan, zoom, rotate )

raises
    NotImplemented from Standard
is


    Initialize(aTypeOfPresentation3d: TypeOfPresentation3d from PrsMgr = PrsMgr_TOP_AllView);
    
---Category: deferred methods.
--           
    
    Compute(me:mutable;
                aPresentationManager: PresentationManager3d from PrsMgr;
                aPresentation: mutable Presentation from Prs3d;
                aMode: Integer from Standard = 0)
    	---Purpose: Calculates the 3D view aPresentation and its
    	-- updates. The latter are managed by aPresentationManager.
    	-- aPresentableObject has the display mode aMode;
    	-- this has the default value of 0, that is, the wireframe display mode.
    raises NotImplemented from Standard
    is virtual protected;
    
    Compute(me            : mutable;
            aProjector    : Projector from Prs3d;
            aPresentation  : mutable Presentation from Prs3d)
    	---Purpose: Calculates the 3D view aPresentation and its
    	-- updates. The latter are managed by
    	-- aPresentationManager. Each of the views in the
    	-- viewer and every modification such as rotation, for
    	-- example, entails recalculation.
    	-- It must be redefined to implement hidden line removal
    	-- for the object. The user never calls this method
    	-- himself. This is done via the InteractiveContext object
    	-- and is dependent on the point of view from which the
    	-- object is displayed.
    raises NotImplemented from Standard
    is virtual protected;

    Compute(me            : mutable;
            aProjector    : Projector from Prs3d;
            aTrsf         : Transformation from Geom;
            aPresentation : mutable Presentation from Prs3d)
    is virtual protected;
    	---Purpose: Calculates the 3D view aPresentation and its
    	-- updates. The latter are managed by
    	-- aPresentationManager. A point of view is provided
    	-- by the projector aProjector, and the geometric
    	-- transformation which has transformed associated
    	-- presentable objects is specified by aTrsf.
    	-- This function is to be used in case where a hidden
    	-- line removal display cannot be calculated
    	-- automatically. This occurs   when associated
    	-- presentable objects have been transformed
    	-- geometrically, but not translated.
    	-- Warning
    	-- The transformation aTrsf must be applied to the
    	-- object before computation.

    Update(me: mutable;AllModes: Boolean=Standard_False)
    	---Purpose: recomputes all presentations of the object.
    	---Level: Public 
    is protected;

    Update(me: mutable; aMode: Integer from Standard; ClearOther: Boolean from Standard)
    	---Purpose: Recomputes the presentation in the given mode.
    	--          If ClearOther is true, other presentation will be cleared.
    is protected;
    
    Fill(me: mutable; 
                aPresentationManager: PresentationManager from PrsMgr;
                aPresentation: mutable Presentation from PrsMgr;
                aMode: Integer from Standard = 0)
    -- 22-03-04 OCC4895 SAN High-level interface for controlling polygon offsets
    is virtual protected;
    	--- Purpose: High-level interface for controlling polygon offsets
        
        -- 22-03-04 OCC4895 SAN High-level interface for controlling polygon offsets

    
    -- Presentations(me: mutable) returns Presentations from PrsMgr
    -- is static private;
    
    Presentations(me : mutable) returns Presentations from PrsMgr
    is static protected;
    	---C++: return &
            
   TypeOfPresentation3d(me) returns TypeOfPresentation3d from PrsMgr
   is static;
    	---Purpose: Returns information on whether the object accepts display in HLR mode or not.
    
   --   ABD 29/10/04  Transform Persistence of Presentation( pan, zoom, rotate ) 
   SetTransformPersistence(  me     :  mutable; 
   			     aFlag  :  TransModeFlags  from  Graphic3d; 
    	    	    	     APoint :  Pnt from gp )
   is virtual; 
   ---Level:    Public 
   ---Purpose:  Sets up Transform Persistence Mode for this object.
   -- This function used to lock in object position, rotation and / or zooming relative to camera position.
   -- Object will be drawn in the origin setted by APoint parameter (except Graphic3d_TMF_TriedronPers flag
   -- - see description later). aFlag should be:
   -- -   Graphic3d_TMF_None - no persistence attributes (reset);
   -- -   Graphic3d_TMF_PanPers - object doesn't move;
   -- -   Graphic3d_TMF_ZoomPers - object doesn't resize;
   -- -   Graphic3d_TMF_RotatePers - object doesn't rotate;
   -- -   Graphic3d_TMF_FullPers - pan, zoom and rotate transform persistence;
   -- -   Graphic3d_TMF_TriedronPers - object behaves like trihedron;
   -- -   combination (Graphic3d_TMF_PanPers | Graphic3d_TMF_ZoomPers);
   -- -   combination (Graphic3d_TMF_PanPers | Graphic3d_TMF_RotatePers);
   -- -   combination (Graphic3d_TMF_ZoomPers | Graphic3d_TMF_RotatePers).
   -- If Graphic3d_TMF_TriedronPers persistence mode selected APoint coordinates X and Y means:
   -- -   X = 0.0, Y = 0.0 - center of view window;
   -- -   X > 0.0, Y > 0.0 - right upper corner of view window;
   -- -   X > 0.0, Y < 0.0 - right lower corner of view window;
   -- -   X < 0.0, Y > 0.0 - left  upper corner of view window;
   -- -   X < 0.0, Y < 0.0 - left  lower corner of view window.
   -- And Z coordinate defines the gap from border of view window (except center position).
   ---Category: Graphic attributes management  
   
   SetTransformPersistence(  me     :  mutable; 
   			     aFlag  :  TransModeFlags  from  Graphic3d ) 
   is  static; 
   ---Level:    Public 
   ---Purpose:  Calls previous method  with  point  (0,0,0)
   ---Category: Graphic attributes management 
   
    
   GetTransformPersistenceMode( me )  returns  TransModeFlags  from  Graphic3d  is  static;
    
   ---Level:    Public 
   ---Purpose:  Gets  Transform  Persistence Mode  for  this  object 
   ---Category: Graphic attributes management

   GetTransformPersistencePoint( me )  returns  Pnt  from  gp  is  static;
    
   ---Level:    Public 
   ---Purpose:  Gets  point  of  transform  persistence for  this  object 
   ---Category: Graphic attributes management
    
   --   ABD 29/10/04  Transform Persistence of Presentation( pan, zoom, rotate )
    
   SetTypeOfPresentation(me:mutable; aType: TypeOfPresentation3d from PrsMgr);    

   SetToUpdate    (me:mutable;aMode:Integer from Standard);
   ---Purpose: flags the Prs of mode <AMode> to be Updated.
   --          the Update will be done when needed.
   
   SetToUpdate(me:mutable); 
   ---Purpose: flags all the Presentations to be Updated.
    
   ToBeUpdated(me;ListOfMode : out ListOfInteger from TColStd);
   ---Purpose: gives the list of modes which are flagged "to be updated".
    
   SetLocation(me:mutable;aLoc:Location from TopLoc) is virtual;
    
   HasLocation(me) returns Boolean from Standard;
   
   Location(me) returns any Location from TopLoc;
   ---C++: inline
   ---C++: return const&
   
   ResetLocation(me:mutable)  is virtual;

   UpdateLocation(me:mutable) is virtual;
    
   UpdateLocation(me:mutable;P : mutable Presentation from Prs3d) is virtual;
    
   SetZLayer ( me         : mutable;
               thePrsMgr  : PresentationManager from PrsMgr;
               theLayerId : Integer from Standard )
     is virtual;
   ---Purpose: Set Z layer ID and update all presentations of
   -- the presentable object. The layer can be set only for displayed object.
   -- If all object presentations are removed, the layer ID will be set to 
   -- default value when computing presentation. The layers mechanism allows
   -- drawing objects in higher layers in overlay of objects in lower layers.
    
   GetZLayer ( me;
               thePrsMgr  : PresentationManager from PrsMgr )
     returns Integer from Standard is static;
   ---Purpose: Get ID of Z layer. If no presentations of object is displayed,
   -- and layer ID is unavailable, the -1 value is returned.

   AddClipPlane (me : mutable; thePlane : ClipPlane_Handle from Graphic3d) is virtual;
   ---Purpose: Adds clip plane for graphical clipping for all display mode
   -- presentations. The composition of clip planes truncates the rendering
   -- space to convex volume. Please be aware that number of supported
   -- clip plane is limited. The planes which exceed the limit are ignored.
   -- Besides of this, some planes can be already set in view where the object
   -- is shown: the number of these planes should be substracted from limit
   -- to predict the maximum possible number of object clipping planes.
   -- @param thePlane [in] the clip plane to be appended to map of clip planes.

   RemoveClipPlane (me : mutable; thePlane : ClipPlane_Handle from Graphic3d) is virtual;
   ---Purpose: Removes previously added clip plane.
   -- @param thePlane [in] the clip plane to be removed from map of clip planes.

   SetClipPlanes (me : mutable; thePlanes : SequenceOfHClipPlane from Graphic3d) is virtual;
   ---Purpose: Set clip planes for graphical clipping for all display mode presentations.
   -- The composition of clip planes truncates the rendering space to convex
   -- volume. Please be aware that number of supported clip plane is limited.
   -- The planes which exceed the limit are ignored. Besides of this, some
   -- planes can be already set in view where the object is shown: the number 
   -- of these planes should be substracted from limit to predict the maximum
   -- possible number of object clipping planes.

   GetClipPlanes (me) returns SequenceOfHClipPlane from Graphic3d;
   ---C++: inline
   ---C++: return const&
   ---Purpose: Get clip planes.
   -- @return set of previously added clip planes for all display mode presentations.

   UpdateClipping (me : mutable) is virtual protected;
   ---Purpose: General virtual method for internal update of presentation state
   -- when some modifications on list of clip planes occurs. Base 
   -- implementation propagate clip planes to every presentation.

fields
    myPresentations: Presentations from PrsMgr is protected;
    myTypeOfPresentation3d: TypeOfPresentation3d from PrsMgr is protected;
    myLocation  : Location from TopLoc is protected; 
    myClipPlanes : SequenceOfHClipPlane from Graphic3d is protected;
    --myTransformPersistence  :  TransModeFlags  from  Graphic3d; 
    myTransformPersistence  :  CTransPersStruct  from  Graphic3d;

friends
    class Presentation3d      from PrsMgr,
    class PresentationManager from PrsMgr,
    Compute from Presentation3d from PrsMgr(me : mutable; aProjector   : DataStructureManager from Graphic3d),
    Compute from Presentation3d from PrsMgr(me : mutable; aProjector   : DataStructureManager from Graphic3d;
                                                          aGivenStruct :  Structure from Graphic3d),
    Compute from Presentation3d from PrsMgr(me : mutable; aProjector   : DataStructureManager from Graphic3d;
                                                          TheTrsf   : Transformation from Geom),
    Compute from Presentation3d from PrsMgr(me : mutable; aProjector   : DataStructureManager from Graphic3d;
                                                          TheTrsf      : Transformation from Geom;
                                                          aGivenStruct : Structure from Graphic3d)
end PresentableObject from PrsMgr;
Commit	Line	Data
b311480e	1	-- Created on: 1995-01-25
	2	-- Created by: Jean-Louis Frenkel
	3	-- Copyright (c) 1995-1999 Matra Datavision
973c2be1	4	-- Copyright (c) 1999-2014 OPEN CASCADE SAS
b311480e	5	--
973c2be1	6	-- This file is part of Open CASCADE Technology software library.
b311480e	7	--
973c2be1	8	-- This library is free software; you can redistribute it and / or modify it
	9	-- under the terms of the GNU Lesser General Public version 2.1 as published
	10	-- by the Free Software Foundation, with special exception defined in the file
	11	-- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
	12	-- distribution for complete text of the license and disclaimer of any warranty.
b311480e	13	--
973c2be1	14	-- Alternatively, this file may be used under the terms of Open CASCADE
973c2be1	15	-- commercial license or contractual agreement.
b311480e	16
7fd59977	17	-- Modified by Rob (18/12/96) -> information about modes to update.
	18	-- Rob (04/07/97) -> TypeOfPresentation3d () Method
	19	-- changed to Public Method.
	20	-- -> Option Projector Dependant/Independant
	21	-- may be set at any time , not only in
	22	-- the constructor or the presentable.
	23	-- ->Insert Locations Methods...
	24	-- Rob (16/12/97) -> Get the list of modes to be updated
	25	-- -> Flags all the Prs to be updated...
	26	-- GG IMP020200 -> Presentations() method become protected
	27	-- and no more private.
	28	-- SAN (22/03/04) -> OCC4895 High-level interface for controlling
	29	-- polygon offsets: Fill() made protected virtual.
7fd59977	30
	31	deferred class PresentableObject from PrsMgr inherits TShared from MMgt
	32
	33
128cc8df	34	---Purpose: A framework to supply the Graphic3d
7fd59977	35	-- structure of the object to be presented. On the first
	36	-- display request, this structure is created by calling the
	37	-- appropriate algorithm and retaining this frameworkfor
	38	-- further display.
	39	-- This abstract framework is inherited in Application
	40	-- Interactive Services (AIS), notably in:
	41	-- - AIS_InteractiveObject
	42	-- - AIS_ConnectedInteractive
	43	-- - AIS_MultipleConnectedInteractive
	44	-- - AIS_Shape
	45	-- Consequently, 3D presentation should be handled by
	46	-- the relevant daughter classes and their member
	47	-- functions in AIS. This is particularly true in the
	48	-- creation of new interactive objects.
	49
	50	uses
	51	Presentation from PrsMgr,
	52	Presentation from Prs3d,
7fd59977	53	Presentations from PrsMgr,
7fd59977	54	PresentationManager from PrsMgr,
7fd59977	55	PresentationManager3d from PrsMgr,
	56	TypeOfPresentation3d from PrsMgr,
	57	DataStructureManager from Graphic3d,
	58	Projector from Prs3d,
	59	Transformation from Geom,
	60	ListOfInteger from TColStd,
	61	Location from TopLoc,
4269bd1b	62	ClipPlane_Handle from Graphic3d,
51b10cd4	63	SequenceOfHClipPlane from Graphic3d,
7fd59977	64	-- ABD 29/10/04 Transform Persistence of Presentation( pan, zoom, rotate )
	65	TransModeFlags from Graphic3d,
	66	Pnt from gp,
	67	CTransPersStruct from Graphic3d
	68	-- ABD 29/10/04 Transform Persistence of Presentation( pan, zoom, rotate )
	69
	70	raises
	71	NotImplemented from Standard
	72	is
	73
	74
	75	Initialize(aTypeOfPresentation3d: TypeOfPresentation3d from PrsMgr = PrsMgr_TOP_AllView);
	76
	77	---Category: deferred methods.
	78	--
7fd59977	79
	80	Compute(me:mutable;
	81	aPresentationManager: PresentationManager3d from PrsMgr;
	82	aPresentation: mutable Presentation from Prs3d;
	83	aMode: Integer from Standard = 0)
	84	---Purpose: Calculates the 3D view aPresentation and its
	85	-- updates. The latter are managed by aPresentationManager.
	86	-- aPresentableObject has the display mode aMode;
	87	-- this has the default value of 0, that is, the wireframe display mode.
	88	raises NotImplemented from Standard
	89	is virtual protected;
	90
	91	Compute(me : mutable;
	92	aProjector : Projector from Prs3d;
	93	aPresentation : mutable Presentation from Prs3d)
	94	---Purpose: Calculates the 3D view aPresentation and its
	95	-- updates. The latter are managed by
	96	-- aPresentationManager. Each of the views in the
	97	-- viewer and every modification such as rotation, for
	98	-- example, entails recalculation.
	99	-- It must be redefined to implement hidden line removal
	100	-- for the object. The user never calls this method
	101	-- himself. This is done via the InteractiveContext object
	102	-- and is dependent on the point of view from which the
	103	-- object is displayed.
	104	raises NotImplemented from Standard
	105	is virtual protected;
	106
	107	Compute(me : mutable;
	108	aProjector : Projector from Prs3d;
	109	aTrsf : Transformation from Geom;
	110	aPresentation : mutable Presentation from Prs3d)
	111	is virtual protected;
	112	---Purpose: Calculates the 3D view aPresentation and its
	113	-- updates. The latter are managed by
	114	-- aPresentationManager. A point of view is provided
	115	-- by the projector aProjector, and the geometric
	116	-- transformation which has transformed associated
	117	-- presentable objects is specified by aTrsf.
	118	-- This function is to be used in case where a hidden
	119	-- line removal display cannot be calculated
	120	-- automatically. This occurs when associated
	121	-- presentable objects have been transformed
	122	-- geometrically, but not translated.
	123	-- Warning
	124	-- The transformation aTrsf must be applied to the
	125	-- object before computation.
	126
	127	Update(me: mutable;AllModes: Boolean=Standard_False)
	128	---Purpose: recomputes all presentations of the object.
	129	---Level: Public
	130	is protected;
	131
	132	Update(me: mutable; aMode: Integer from Standard; ClearOther: Boolean from Standard)
	133	---Purpose: Recomputes the presentation in the given mode.
	134	-- If ClearOther is true, other presentation will be cleared.
	135	is protected;
	136
	137	Fill(me: mutable;
	138	aPresentationManager: PresentationManager from PrsMgr;
	139	aPresentation: mutable Presentation from PrsMgr;
	140	aMode: Integer from Standard = 0)
	141	-- 22-03-04 OCC4895 SAN High-level interface for controlling polygon offsets
	142	is virtual protected;
143	--- Purpose: High-level interface for controlling polygon offsets
144
145	-- 22-03-04 OCC4895 SAN High-level interface for controlling polygon offsets
146
147
148	-- Presentations(me: mutable) returns Presentations from PrsMgr
149	-- is static private;
150
151	Presentations(me : mutable) returns Presentations from PrsMgr
152	is static protected;
153	---C++: return &
154
155	TypeOfPresentation3d(me) returns TypeOfPresentation3d from PrsMgr
156	is static;
157	---Purpose: Returns information on whether the object accepts display in HLR mode or not.
158
159	-- ABD 29/10/04 Transform Persistence of Presentation( pan, zoom, rotate )
160	SetTransformPersistence( me : mutable;
161	aFlag : TransModeFlags from Graphic3d;
162	APoint : Pnt from gp )
163	is virtual;
164	---Level: Public
165	---Purpose: Sets up Transform Persistence Mode for this object.
166	-- This function used to lock in object position, rotation and / or zooming relative to camera position.
167	-- Object will be drawn in the origin setted by APoint parameter (except Graphic3d_TMF_TriedronPers flag
168	-- - see description later). aFlag should be:
169	-- - Graphic3d_TMF_None - no persistence attributes (reset);
170	-- - Graphic3d_TMF_PanPers - object doesn't move;
171	-- - Graphic3d_TMF_ZoomPers - object doesn't resize;
172	-- - Graphic3d_TMF_RotatePers - object doesn't rotate;
173	-- - Graphic3d_TMF_FullPers - pan, zoom and rotate transform persistence;
174	-- - Graphic3d_TMF_TriedronPers - object behaves like trihedron;
175	-- - combination (Graphic3d_TMF_PanPers \| Graphic3d_TMF_ZoomPers);
176	-- - combination (Graphic3d_TMF_PanPers \| Graphic3d_TMF_RotatePers);
177	-- - combination (Graphic3d_TMF_ZoomPers \| Graphic3d_TMF_RotatePers).
178	-- If Graphic3d_TMF_TriedronPers persistence mode selected APoint coordinates X and Y means:
179	-- - X = 0.0, Y = 0.0 - center of view window;
180	-- - X > 0.0, Y > 0.0 - right upper corner of view window;
181	-- - X > 0.0, Y < 0.0 - right lower corner of view window;
182	-- - X < 0.0, Y > 0.0 - left upper corner of view window;
183	-- - X < 0.0, Y < 0.0 - left lower corner of view window.
184	-- And Z coordinate defines the gap from border of view window (except center position).
185	---Category: Graphic attributes management
186
187	SetTransformPersistence( me : mutable;
188	aFlag : TransModeFlags from Graphic3d )
189	is static;
190	---Level: Public
191	---Purpose: Calls previous method with point (0,0,0)
192	---Category: Graphic attributes management
193
194
195	GetTransformPersistenceMode( me ) returns TransModeFlags from Graphic3d is static;
196
197	---Level: Public
198	---Purpose: Gets Transform Persistence Mode for this object
199	---Category: Graphic attributes management
200
201	GetTransformPersistencePoint( me ) returns Pnt from gp is static;
202
203	---Level: Public
204	---Purpose: Gets point of transform persistence for this object
205	---Category: Graphic attributes management
206
207	-- ABD 29/10/04 Transform Persistence of Presentation( pan, zoom, rotate )
208
209	SetTypeOfPresentation(me:mutable; aType: TypeOfPresentation3d from PrsMgr);
210
211	SetToUpdate (me:mutable;aMode:Integer from Standard);
212	---Purpose: flags the Prs of mode <AMode> to be Updated.
213	-- the Update will be done when needed.
214
215	SetToUpdate(me:mutable);
216	---Purpose: flags all the Presentations to be Updated.
217
218	ToBeUpdated(me;ListOfMode : out ListOfInteger from TColStd);
219	---Purpose: gives the list of modes which are flagged "to be updated".
220
221	SetLocation(me:mutable;aLoc:Location from TopLoc) is virtual;
222
223	HasLocation(me) returns Boolean from Standard;
224
225	Location(me) returns any Location from TopLoc;
226	---C++: inline
227	---C++: return const&
228
229	ResetLocation(me:mutable) is virtual;
230
231	UpdateLocation(me:mutable) is virtual;
232
233	UpdateLocation(me:mutable;P : mutable Presentation from Prs3d) is virtual;
234
59f45b7c	235	SetZLayer ( me : mutable;
	236	thePrsMgr : PresentationManager from PrsMgr;
	237	theLayerId : Integer from Standard )
	238	is virtual;
	239	---Purpose: Set Z layer ID and update all presentations of
	240	-- the presentable object. The layer can be set only for displayed object.
	241	-- If all object presentations are removed, the layer ID will be set to
	242	-- default value when computing presentation. The layers mechanism allows
	243	-- drawing objects in higher layers in overlay of objects in lower layers.
7fd59977	244
59f45b7c	245	GetZLayer ( me;
	246	thePrsMgr : PresentationManager from PrsMgr )
	247	returns Integer from Standard is static;
	248	---Purpose: Get ID of Z layer. If no presentations of object is displayed,
	249	-- and layer ID is unavailable, the -1 value is returned.
4269bd1b	250
	251	AddClipPlane (me : mutable; thePlane : ClipPlane_Handle from Graphic3d) is virtual;
	252	---Purpose: Adds clip plane for graphical clipping for all display mode
	253	-- presentations. The composition of clip planes truncates the rendering
	254	-- space to convex volume. Please be aware that number of supported
	255	-- clip plane is limited. The planes which exceed the limit are ignored.
	256	-- Besides of this, some planes can be already set in view where the object
	257	-- is shown: the number of these planes should be substracted from limit
	258	-- to predict the maximum possible number of object clipping planes.
	259	-- @param thePlane [in] the clip plane to be appended to map of clip planes.
	260
	261	RemoveClipPlane (me : mutable; thePlane : ClipPlane_Handle from Graphic3d) is virtual;
	262	---Purpose: Removes previously added clip plane.
	263	-- @param thePlane [in] the clip plane to be removed from map of clip planes.
	264
51b10cd4	265	SetClipPlanes (me : mutable; thePlanes : SequenceOfHClipPlane from Graphic3d) is virtual;
4269bd1b	266	---Purpose: Set clip planes for graphical clipping for all display mode presentations.
	267	-- The composition of clip planes truncates the rendering space to convex
	268	-- volume. Please be aware that number of supported clip plane is limited.
	269	-- The planes which exceed the limit are ignored. Besides of this, some
	270	-- planes can be already set in view where the object is shown: the number
	271	-- of these planes should be substracted from limit to predict the maximum
	272	-- possible number of object clipping planes.
	273
51b10cd4	274	GetClipPlanes (me) returns SequenceOfHClipPlane from Graphic3d;
4269bd1b	275	---C++: inline
	276	---C++: return const&
	277	---Purpose: Get clip planes.
	278	-- @return set of previously added clip planes for all display mode presentations.
	279
	280	UpdateClipping (me : mutable) is virtual protected;
	281	---Purpose: General virtual method for internal update of presentation state
	282	-- when some modifications on list of clip planes occurs. Base
	283	-- implementation propagate clip planes to every presentation.
	284
7fd59977	285	fields
	286	myPresentations: Presentations from PrsMgr is protected;
	287	myTypeOfPresentation3d: TypeOfPresentation3d from PrsMgr is protected;
	288	myLocation : Location from TopLoc is protected;
51b10cd4	289	myClipPlanes : SequenceOfHClipPlane from Graphic3d is protected;
7fd59977	290	--myTransformPersistence : TransModeFlags from Graphic3d;
	291	myTransformPersistence : CTransPersStruct from Graphic3d;
	292
	293	friends
eb4320f2	294	class Presentation3d from PrsMgr,
7fd59977	295	class PresentationManager from PrsMgr,
	296	Compute from Presentation3d from PrsMgr(me : mutable; aProjector : DataStructureManager from Graphic3d),
	297	Compute from Presentation3d from PrsMgr(me : mutable; aProjector : DataStructureManager from Graphic3d;
	298	aGivenStruct : Structure from Graphic3d),
	299	Compute from Presentation3d from PrsMgr(me : mutable; aProjector : DataStructureManager from Graphic3d;
	300	TheTrsf : Transformation from Geom),
	301	Compute from Presentation3d from PrsMgr(me : mutable; aProjector : DataStructureManager from Graphic3d;
	302	TheTrsf : Transformation from Geom;
	303	aGivenStruct : Structure from Graphic3d)
	304	end PresentableObject from PrsMgr;