[occt.git] / src / PrsMgr / PrsMgr_PresentationManager.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.

deferred class PresentationManager from PrsMgr  
inherits TShared from MMgt

    	---Purpose: This class represents any kind of entity able to collect
    	--          representations of an object, to show or erase them.
    	--          Example: StructureManager from Graphic3d
    	--                   View from Graphic2d

uses 
    Presentation from PrsMgr,
    PresentableObject from PrsMgr,
    View from V3d,
    ListOfTransient from TColStd
    

raises 
    NoSuchObject from Standard
is

    Initialize;

    Is3D(me) returns Boolean from Standard is deferred;

    Display(me: mutable; aPresentableObject: mutable PresentableObject from PrsMgr;
                aMode: Integer from Standard = 0)
    	---Purpose: Displays the presentation of the object in the given
    	--          Presentation manager with the given mode.
    	--          The mode should be enumerated by the object which
    	--          inherits PresentableObject.
    is static;
    
    Erase(me:mutable; aPresentableObject: PresentableObject from PrsMgr;
                aMode: Integer from Standard = 0)
    	---Level: public
    	---Purpose: erases the presentation of the object in the given
    	--          Presentation manager with the given mode.
    is static;

    Clear(me:mutable; aPresentableObject: PresentableObject from PrsMgr;
                aMode: Integer from Standard = 0)
    is virtual;
	---Purpose:
	-- Clears the presentation of the presentable object
	-- aPresentableObject in this framework with the
	-- display mode aMode.

    SetVisibility (me: mutable; thePresentableObject: PresentableObject from PrsMgr;
                   theMode: Integer from Standard;
                   theValue: Boolean from Standard);
    ---Purpose: Sets the visibility of presentable object.

    Highlight(me: mutable; aPresentableObject: mutable PresentableObject from PrsMgr;
                  aMode: Integer from Standard = 0)
	---Purpose: Highlights the presentation of the presentable object
	-- aPresentableObject in this framework with the display mode aMode.
    is static;
    
    Unhighlight(me:mutable; aPresentableObject: PresentableObject from PrsMgr;
                aMode: Integer from Standard = 0)
        ---Purpose: Removes highlighting from the presentation of the
	-- presentable object aPresentableObject in this
	-- framework with the display mode aMode.
    is static;

    SetDisplayPriority(me;aPresentableObject: PresentableObject from PrsMgr; 
    	    	    	  amode:Integer from Standard;
    	    	          aNewPrior:Integer from Standard);
	---Purpose:
	-- Sets the display priority aNewPrior   of the
	-- presentable object aPresentableObject in this
	-- framework with the display mode aMode.
        
    DisplayPriority(me;aPresentableObject: PresentableObject from PrsMgr; 
    	    	    	  amode:Integer from Standard)
    returns Integer from Standard;
	---Purpose:
	-- Returns the display priority of the presentable object
	-- aPresentableObject in this framework with the
	-- display mode aMode.
    
    SetZLayer ( me                   : mutable;
                thePresentableObject : PresentableObject from PrsMgr;
                theLayerId           : Integer from Standard )
      is static;
    ---Purpose: Set Z layer ID for all presentations of the object.

    GetZLayer ( me;
                thePresentableObject : PresentableObject from PrsMgr )
      returns Integer from Standard is static;
    ---Purpose: Get Z layer ID assigned to all presentations of the object.
    -- Method returns -1 value if object has no presentations and is
    -- impossible to get layer index.
    
    IsDisplayed(me;aPresentableObject: PresentableObject from PrsMgr;
                aMode: Integer from Standard = 0) 
        ---Purpose: Returns true if the presentation of the presentable
	-- object aPresentableObject in this framework with the
	-- display mode aMode is displayed.
    returns Boolean from Standard
    is static;

    IsHighlighted(me;aPresentableObject: PresentableObject from PrsMgr;
                aMode: Integer from Standard = 0) 
        ---Purpose: Returns true if the presentation of the presentable
	-- object aPresentableObject in this framework with the
	-- display mode aMode is highlighted.
    returns Boolean from Standard
    is static;


    Update(me; aPresentableObject: PresentableObject from PrsMgr;
    	      aMode: Integer from Standard = 0)
        ---Purpose: Updates the presentation of the presentable object
        -- aPresentableObject in this framework with the display mode aMode.
    is static;
    
    	---Category: Immediate display methods.

    BeginDraw(me: mutable) is virtual;
        ---Purpose: initializes the list of Prs to be displayed in transient mode

    Add(me: mutable ; aPresentableObject: PresentableObject from PrsMgr;
    	    	      aMode: Integer from Standard = 0);
        ---Purpose: Performs an iteration of the transient objects to look
	-- for the presentable objects with the display mode aMode.
	-- Appends the presentation of the presentable object
	-- aPresentableObject with the mode aMode to the list
	-- of objects in immediate mode.

    Remove(me: mutable ; aPresentableObject: PresentableObject from PrsMgr;
    	    	      aMode: Integer from Standard = 0);
        ---Purpose: Performs an iteration of the transient objects to look
	-- for the presentable objects with the display mode aMode.
	-- Removes the presentation of the presentable object
	-- aPresentableObject with the mode aMode from the
	-- list of objects in immediate mode.

    EndDraw(me: mutable; aView: View from V3d; DoubleBuffer: Boolean from Standard = Standard_False)
        ---Purpose:  Allows rapid drawing of the view aView by avoiding
	-- an update of the whole background. If DoubleBuffer
	-- is true, the background is drawn.
    is deferred;

    IsImmediateModeOn(me) returns Boolean from Standard;
        ---C++: inline
        ---Purpose: Returns true if immediate (transient) mode is on.


           ---Category: Private & deferred methods.
           
    HasPresentation (me;
                    aPresentableObject: PresentableObject from PrsMgr;
		    aMode: Integer from Standard = 0)
    returns Boolean from Standard
    is static;
    	---Purpose: Returns true if there is a presentation of the
    	-- presentable object aPresentableObject in this
    	-- framework, aPresentableObject having the display mode aMode.
        
    Presentation (me;
                    aPresentableObject: PresentableObject from PrsMgr;
		    aMode: Integer from Standard = 0)
    returns mutable Presentation from PrsMgr 
    raises NoSuchObject from Standard
    is static;
    	---Purpose: Returns the presentation Presentation of the
    	-- presentable object aPresentableObject in this
    	-- framework. aPresentableObject has the display mode aMode.
        
    AddPresentation(me: mutable;
                    aPresentableObject: PresentableObject from PrsMgr;
		    aMode: Integer from Standard = 0)
	---Purpose: Adds a presentation of the presentable object
    	-- aPresentableObject to this framework.
    	-- aPresentableObject has the display mode aMode.
    is protected;

    RemovePresentation(me: mutable;
                       aPresentableObject: PresentableObject from PrsMgr;
		       aMode: Integer from Standard = 0)
	---Purpose: Removes a presentation of the presentable object
    	-- aPresentableObject to this framework.
    	-- aPresentableObject has the display mode aMode.
    is protected;

    newPresentation(me: mutable; aPresentableObject: PresentableObject from PrsMgr)
    returns mutable Presentation from PrsMgr
	---Level: Internal 
    	---Purpose: Creates a new presentation in the presentation manager.
    is deferred private;

fields
    myImmediateMode: Boolean from Standard is protected;
    myImmediateList: ListOfTransient from TColStd is protected;
    
end PresentationManager 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.
7fd59977	16
	17	deferred class PresentationManager from PrsMgr
	18	inherits TShared from MMgt
	19
	20	---Purpose: This class represents any kind of entity able to collect
	21	-- representations of an object, to show or erase them.
	22	-- Example: StructureManager from Graphic3d
	23	-- View from Graphic2d
	24
	25	uses
	26	Presentation from PrsMgr,
	27	PresentableObject from PrsMgr,
6942f04a	28	View from V3d,
7fd59977	29	ListOfTransient from TColStd
	30
	31
	32	raises
	33	NoSuchObject from Standard
	34	is
	35
	36	Initialize;
	37
	38	Is3D(me) returns Boolean from Standard is deferred;
	39
	40	Display(me: mutable; aPresentableObject: mutable PresentableObject from PrsMgr;
	41	aMode: Integer from Standard = 0)
	42	---Purpose: Displays the presentation of the object in the given
	43	-- Presentation manager with the given mode.
	44	-- The mode should be enumerated by the object which
	45	-- inherits PresentableObject.
	46	is static;
	47
	48	Erase(me:mutable; aPresentableObject: PresentableObject from PrsMgr;
	49	aMode: Integer from Standard = 0)
	50	---Level: public
	51	---Purpose: erases the presentation of the object in the given
	52	-- Presentation manager with the given mode.
	53	is static;
	54
	55	Clear(me:mutable; aPresentableObject: PresentableObject from PrsMgr;
	56	aMode: Integer from Standard = 0)
	57	is virtual;
	58	---Purpose:
	59	-- Clears the presentation of the presentable object
	60	-- aPresentableObject in this framework with the
	61	-- display mode aMode.
	62
eb4320f2	63	SetVisibility (me: mutable; thePresentableObject: PresentableObject from PrsMgr;
	64	theMode: Integer from Standard;
	65	theValue: Boolean from Standard);
	66	---Purpose: Sets the visibility of presentable object.
	67
7fd59977	68	Highlight(me: mutable; aPresentableObject: mutable PresentableObject from PrsMgr;
	69	aMode: Integer from Standard = 0)
	70	---Purpose: Highlights the presentation of the presentable object
	71	-- aPresentableObject in this framework with the display mode aMode.
	72	is static;
	73
	74	Unhighlight(me:mutable; aPresentableObject: PresentableObject from PrsMgr;
	75	aMode: Integer from Standard = 0)
	76	---Purpose: Removes highlighting from the presentation of the
	77	-- presentable object aPresentableObject in this
	78	-- framework with the display mode aMode.
	79	is static;
	80
	81	SetDisplayPriority(me;aPresentableObject: PresentableObject from PrsMgr;
	82	amode:Integer from Standard;
	83	aNewPrior:Integer from Standard);
	84	---Purpose:
	85	-- Sets the display priority aNewPrior of the
	86	-- presentable object aPresentableObject in this
	87	-- framework with the display mode aMode.
	88
	89	DisplayPriority(me;aPresentableObject: PresentableObject from PrsMgr;
	90	amode:Integer from Standard)
	91	returns Integer from Standard;
	92	---Purpose:
	93	-- Returns the display priority of the presentable object
	94	-- aPresentableObject in this framework with the
	95	-- display mode aMode.
	96
59f45b7c	97	SetZLayer ( me : mutable;
	98	thePresentableObject : PresentableObject from PrsMgr;
	99	theLayerId : Integer from Standard )
	100	is static;
	101	---Purpose: Set Z layer ID for all presentations of the object.
	102
	103	GetZLayer ( me;
	104	thePresentableObject : PresentableObject from PrsMgr )
	105	returns Integer from Standard is static;
	106	---Purpose: Get Z layer ID assigned to all presentations of the object.
	107	-- Method returns -1 value if object has no presentations and is
	108	-- impossible to get layer index.
	109
7fd59977	110	IsDisplayed(me;aPresentableObject: PresentableObject from PrsMgr;
	111	aMode: Integer from Standard = 0)
	112	---Purpose: Returns true if the presentation of the presentable
	113	-- object aPresentableObject in this framework with the
	114	-- display mode aMode is displayed.
	115	returns Boolean from Standard
	116	is static;
	117
	118	IsHighlighted(me;aPresentableObject: PresentableObject from PrsMgr;
	119	aMode: Integer from Standard = 0)
	120	---Purpose: Returns true if the presentation of the presentable
	121	-- object aPresentableObject in this framework with the
	122	-- display mode aMode is highlighted.
	123	returns Boolean from Standard
	124	is static;
	125
	126
	127	Update(me; aPresentableObject: PresentableObject from PrsMgr;
	128	aMode: Integer from Standard = 0)
	129	---Purpose: Updates the presentation of the presentable object
	130	-- aPresentableObject in this framework with the display mode aMode.
	131	is static;
	132
	133	---Category: Immediate display methods.
	134
	135	BeginDraw(me: mutable) is virtual;
	136	---Purpose: initializes the list of Prs to be displayed in transient mode
	137
	138	Add(me: mutable ; aPresentableObject: PresentableObject from PrsMgr;
	139	aMode: Integer from Standard = 0);
	140	---Purpose: Performs an iteration of the transient objects to look
	141	-- for the presentable objects with the display mode aMode.
	142	-- Appends the presentation of the presentable object
	143	-- aPresentableObject with the mode aMode to the list
	144	-- of objects in immediate mode.
	145
	146	Remove(me: mutable ; aPresentableObject: PresentableObject from PrsMgr;
	147	aMode: Integer from Standard = 0);
	148	---Purpose: Performs an iteration of the transient objects to look
	149	-- for the presentable objects with the display mode aMode.
	150	-- Removes the presentation of the presentable object
	151	-- aPresentableObject with the mode aMode from the
	152	-- list of objects in immediate mode.
	153
6942f04a	154	EndDraw(me: mutable; aView: View from V3d; DoubleBuffer: Boolean from Standard = Standard_False)
7fd59977	155	---Purpose: Allows rapid drawing of the view aView by avoiding
	156	-- an update of the whole background. If DoubleBuffer
	157	-- is true, the background is drawn.
	158	is deferred;
	159
	160	IsImmediateModeOn(me) returns Boolean from Standard;
	161	---C++: inline
	162	---Purpose: Returns true if immediate (transient) mode is on.
	163
	164
	165
	166	---Category: Private & deferred methods.
	167
	168	HasPresentation (me;
	169	aPresentableObject: PresentableObject from PrsMgr;
	170	aMode: Integer from Standard = 0)
	171	returns Boolean from Standard
	172	is static;
	173	---Purpose: Returns true if there is a presentation of the
	174	-- presentable object aPresentableObject in this
	175	-- framework, aPresentableObject having the display mode aMode.
	176
	177	Presentation (me;
	178	aPresentableObject: PresentableObject from PrsMgr;
	179	aMode: Integer from Standard = 0)
	180	returns mutable Presentation from PrsMgr
	181	raises NoSuchObject from Standard
	182	is static;
	183	---Purpose: Returns the presentation Presentation of the
	184	-- presentable object aPresentableObject in this
	185	-- framework. aPresentableObject has the display mode aMode.
	186
	187	AddPresentation(me: mutable;
	188	aPresentableObject: PresentableObject from PrsMgr;
	189	aMode: Integer from Standard = 0)
	190	---Purpose: Adds a presentation of the presentable object
	191	-- aPresentableObject to this framework.
	192	-- aPresentableObject has the display mode aMode.
	193	is protected;
	194
	195	RemovePresentation(me: mutable;
	196	aPresentableObject: PresentableObject from PrsMgr;
	197	aMode: Integer from Standard = 0)
	198	---Purpose: Removes a presentation of the presentable object
	199	-- aPresentableObject to this framework.
	200	-- aPresentableObject has the display mode aMode.
	201	is protected;
	202
	203	newPresentation(me: mutable; aPresentableObject: PresentableObject from PrsMgr)
	204	returns mutable Presentation from PrsMgr
	205	---Level: Internal
	206	---Purpose: Creates a new presentation in the presentation manager.
	207	is deferred private;
	208
	209	fields
	210	myImmediateMode: Boolean from Standard is protected;
	211	myImmediateList: ListOfTransient from TColStd is protected;
	212
	213	end PresentationManager from PrsMgr;