lili/OCCT
1
0
Fork 0
mirror of https://github.com/Open-Cascade-SAS/OCCT.git synced 2026-07-13 06:37:18 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
8abada55ca8fceae8f96d58037b1984f2007dadf
OCCT/src/Graphic3d/Graphic3d_StructureManager.cdl
kgv 679ecdeeac 0024637: Visualization - clean up implementation of rendering in immediate mode 
Remove unused flag "DoubleBuf".
Remove Visual3d_TransientManager "class" (functionality moved to PrsMgr_PresentationManager).
Remove unused "Add" immediate mode.

V3d_View class - remove methods ::TransientManagerBeginDraw(), ::TransientManagerClearDraw(), ::TransientManagerBeginAddDraw().
Add method ::RedrawImmediate() to redraw only immediate presentations.

OpenGl_GraphicDriver - add methods ::DisplayImmediateStructure(), ::EraseImmediateStructure(), ::RedrawImmediate().
OpenGl_View - manage list of immediate structures.
OpenGl_Workspace - automate rendering workflow of immediate + persistent layers.

Merge PrsMgr_PresentationManager3d class into PrsMgr_PresentationManager.
Mark PrsMgr_PresentationManager3d as alias to PrsMgr_PresentationManager to simplify porting.

Prs3d_Presentation - remove unused field myStruct.
Prs3d_PresentationShadow - shadow link to existing presentation with custom attributes.
Graphic3d_Structure::Highlight() - do not register undisplayed structure in structure manager.

AIS_InteractiveContext, AIS_LocalContext add flag to prevent view update into methods
::MoveTo(), ::HilightNextDetected(), ::HilightPreviousDetected()
to allow update of customized immediate structures before redraw but after ::MoveTo().

Remove unused method AIS_InteractiveContext::Drag().

StdSelect_ViewerSelector3d do not user immediate mode in methods
::DisplayAreas(), ::ClearAreas(), ::ClearSensitive(), ::DisplaySensitive(),

GridEcho - update value in StdSelect_ViewerSelector3d::Pick() instead of V3d_View::Compute().
Do not use global variable for GridEcho vertex.
Redraw immediate mode not within GridEcho but at AIS_InteractiveContext, AIS_LocalContext layer.

V3d_View::ToPixMap() - disable autoupdate during FitAll.
Avoid Redraw() into FBO without ImmediateModeDrawToFront flag.

PrsMgr_PresentationManager stores list of temporary immediate presentations,
automatically cleared within BeginImmediateMode() call.
Methods with ambiguous names have been renamed
(new names now consistent with pre-existed method names in AIS_LocalContext class):
- BeginDraw -> BeginImmediateDraw
- EndDraw -> EndImmediateDraw
Remove now useless Remove() method (and ImmediateRemove() in AIS).

Visual3d_View now stores map of displayed immediate presentations.

ViewerTest_EventManager - eliminate double redraw in selection methods.

Fix warning
2014-03-20 13:54:55 +04:00

518 lines
17 KiB
Plaintext
Raw Blame History

-- Created on: 1991-09-05
-- Created by: NW,JPB,CAL
-- Copyright (c) 1991-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 License 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.
-- 11/97 ; CAL : gestion du GraphicClear
-- 05/98 ; CAL : gestion du GraphicConnect et Disconnect
deferred class StructureManager from Graphic3d inherits TShared
---Version:
---Purpose: This class allows the definition of a manager to
-- which the graphic objects are associated.
-- It allows them to be globally manipulated.
-- It defines the global attributes.
-- Keywords: Structure, Structure Manager, Update Mode,
-- Destroy, Highlight, Visible, Detectable
---Warning:
---References:
uses
Array2OfReal from TColStd,
SequenceOfInteger from TColStd,
GenId from Aspect,
TypeOfHighlightMethod from Aspect,
TypeOfUpdate from Aspect,
DataStructureManager from Graphic3d,
AspectFillArea3d from Graphic3d,
AspectLine3d from Graphic3d,
AspectMarker3d from Graphic3d,
AspectText3d from Graphic3d,
Structure from Graphic3d,
MapOfStructure from Graphic3d,
SequenceOfStructure from Graphic3d,
GraphicDriver from Graphic3d
raises
InitialisationError from Graphic3d
is
Initialize ( theDriver: GraphicDriver from Graphic3d )
---Level: Public
---Purpose: Initialises the ViewManager.
-- Currently creating of more than 100 viewer instances
-- is not supported and leads to InitializationError and
-- initialisation failure.
-- This limitation might be addressed in some future OCCT releases.
-- Warning: Raises InitialisationError if the initialisation
-- of the ViewManager failed.
raises InitialisationError from Graphic3d;
-- if the initialisation of the ViewManager failed.
Destroy ( me : mutable )
is virtual;
---Level: Public
---Purpose: Deletes the manager <me>.
---C++: alias ~
---------------------------------------------------
-- Category: Methods to modify the class definition
---------------------------------------------------
SetPrimitivesAspect ( me : mutable;
CTX : AspectLine3d from Graphic3d )
is static;
---Level: Public
---Purpose: Modifies the default attributes for lines
-- in the visualiser.
---Category: Methods to modify the class definition
SetPrimitivesAspect ( me : mutable;
CTX : AspectFillArea3d from Graphic3d)
is static;
---Level: Public
---Purpose: Modifies the default attributes for faces
-- in the visualiser.
---Category: Methods to modify the class definition
SetPrimitivesAspect ( me : mutable;
CTX : AspectText3d from Graphic3d )
is static;
---Level: Public
---Purpose: Modifies the default attributes for text
-- in the visualiser.
---Category: Methods to modify the class definition
SetPrimitivesAspect ( me : mutable;
CTX : AspectMarker3d from Graphic3d)
is static;
---Level: Public
---Purpose: Modifies the default attributes for markers
-- in the visualiser.
---Category: Methods to modify the class definition
---------------------------------------------------
-- Summary of Dynamic Operations and Update Mode --
-- --
-- Use SetUpdateMode to control when changes to --
-- the display are made. --
-- --
-- Use one of the following functions to update --
-- one or more views : --
-- --
-- Update all views of the viewer : --
-- Visual3d_ViewManager::Update () --
-- --
-- Update one view of the viewer --
-- Visual3d_View::Update () --
-- --
-- Use one of the following functions to update --
-- the entire display : --
-- --
-- Redraw all structures in all views : --
-- Visual3d_ViewManager::Redraw () --
-- --
-- Redraw all structures in one view : --
-- Visual3d_View::Redraw () --
---------------------------------------------------
SetUpdateMode ( me : mutable;
AType : TypeOfUpdate from Aspect )
is static;
---Level: Public
---Purpose: Modifies the screen update mode.
--
-- TOU_ASAP as soon as possible
-- TOU_WAIT on demand (with the Update function)
-- Note : Dynamic Operations and Update Mode
-- Use SetUpdateMode to control when changes to
-- the display are made. Use one of the following
-- functions to update one or more views:
-- - Update all views of the viewer: Visual3d_ViewManager::Update ()
-- - Update one view of the viewer: Visual3d_View::Update () Use one of
-- the following functions to update the entire display:
-- - Redraw all structures in all views: Visual3d_ViewManager::Redraw ()
-- - Redraw all structures in one view: Visual3d_View::Redraw () Update)
Update ( me )
is deferred;
---Purpose: Updates screen in function of modifications of
-- the structures.
-- Warning: Not necessary if the update mode is TOU_ASAP.
---------------------------------------------
-- Category: Inquire methods, MapOfStructure
---------------------------------------------
DisplayedStructures ( me; SG: in out MapOfStructure from Graphic3d)
is static;
---Level: Internal
---Purpose: Returns the set of structures displayed in
-- visualiser <me>.
---Category: Inquire methods, MapOfStructure
NumberOfDisplayedStructures ( me )
returns Integer from Standard
is static protected;
---Level: Internal
---Purpose: Returns the number of structures displayed in
-- visualiser <me>.
--DisplayedStructure ( me;
-- AnIndex : Integer from Standard )
--returns Structure from Graphic3d
--is static protected;
---Level: Internal
---Purpose: Returns the structure displayed in visualiser <me>.
HighlightedStructures ( me; SG: in out MapOfStructure from Graphic3d )
is static;
---Level: Internal
---Purpose: Returns the set of highlighted structures
-- in a visualiser <me>.
---Category: Inquire methods, MapOfStructure
PickStructures ( me; SG: in out MapOfStructure from Graphic3d )
is static;
---Level: Internal
---Purpose: Returns the set of detectable structures
-- in a visualiser <me>.
---Category: Inquire methods, MapOfStructure
----------------------------
-- Category: Inquire methods
----------------------------
FillArea3dAspect ( me )
returns AspectFillArea3d from Graphic3d
is static;
---Level: Public
---Purpose: Returns the values of the current default attributes.
---Category: Inquire methods
Limit ( myclass )
returns Integer from Standard;
---Level: Internal
---Purpose: Returns maximum number of managers defineable.
---Category: Inquire methods
Line3dAspect ( me )
returns AspectLine3d from Graphic3d
is static;
---Level: Public
---Purpose: Returns the values of the current default attributes.
---Category: Inquire methods
Marker3dAspect ( me )
returns AspectMarker3d from Graphic3d
is static;
---Level: Public
---Purpose: Returns the values of the current default attributes.
---Category: Inquire methods
MinMaxValues ( me;
XMin, YMin, ZMin : out Real from Standard;
XMax, YMax, ZMax : out Real from Standard )
is static;
---Level: Public
---Purpose: Returns the coordinates of the boundary box of all
-- structures displayed in the manager <me>.
---Category: Inquire methods
PrimitivesAspect ( me;
CTXL : out AspectLine3d from Graphic3d;
CTXT : out AspectText3d from Graphic3d;
CTXM : out AspectMarker3d from Graphic3d;
CTXF : out AspectFillArea3d from Graphic3d )
is static;
---Level: Public
---Purpose: Returns the values of the current default attributes.
---Category: Inquire methods
Text3dAspect ( me )
returns AspectText3d from Graphic3d
is static;
---Level: Public
---Purpose: Returns the values of the current default attributes.
---Category: Inquire methods
UpdateMode ( me )
returns TypeOfUpdate from Aspect
is static;
---Level: Public
---Purpose: Returns the screen update mode.
--
-- TOU_ASAP as soon as possible
-- TOU_WAIT on demand (Update)
--
---Category: Inquire methods
----------------------------
-- Category: Private methods
----------------------------
ChangeDisplayPriority ( me : mutable;
AStructure : Structure from Graphic3d;
OldPriority : Integer from Standard;
NewPriority : Integer from Standard )
is deferred;
---Level: Internal
---Purpose: Changes the display priority of the structure <AStructure>.
---Category: Private methods
ChangeZLayer ( me : mutable;
theStructure : Structure from Graphic3d;
theLayerId : Integer from Standard )
is deferred;
---Purpose: Change Z layer for structure. The z layer mechanism allows
-- to display structures in higher layers in overlay of structures in
-- lower layers.
GetZLayer ( me;
theStructure : Structure from Graphic3d )
returns Integer from Standard is deferred;
---Purpose: Get Z layer ID assigned to structure. If the structure
-- has no layer ID (deleted from graphic driver), the method returns -1.
AddZLayer ( me : mutable;
theLayerId : in out Integer from Standard )
returns Boolean from Standard is deferred;
---Purpose: Add a new top-level Z layer and get its ID as
-- <theLayerId> value. The method returns Standard_False if the layer
-- can not be created. The z layer mechanism allows to display
-- structures in higher layers in overlay of structures in lower layers.
RemoveZLayer ( me : mutable;
theLayerId : Integer from Standard )
returns Boolean from Standard is deferred;
---Purpose: Remove Z layer with ID <theLayerId>. Method returns
-- Standard_False if the layer can not be removed or doesn't exists.
-- By default, there is always a default bottom-level layer that can't
-- be removed.
GetAllZLayers ( me;
theLayerSeq : out SequenceOfInteger from TColStd )
is deferred;
---Purpose: Return all Z layer ids in sequence ordered by level
-- from lowest layer to highest. The first layer ID in sequence is
-- the default layer that can't be removed.
CurrentId ( myclass )
returns Integer from Standard;
---Level: Internal
---Purpose: Returns a current identifier available.
---Category: Private methods
ReCompute ( me : mutable;
AStructure : Structure from Graphic3d )
is deferred;
---Level: Advanced
---Purpose: Forces a new construction of the structure <AStructure>
-- if <AStructure> is displayed and TOS_COMPUTED.
---Category: Private methods
ReCompute ( me : mutable;
AStructure : Structure from Graphic3d;
AProjector : DataStructureManager from Graphic3d )
is deferred;
---Level: Advanced
---Purpose: Forces a new construction of the structure <AStructure>
-- if <AStructure> is displayed in <AProjector> and TOS_COMPUTED.
---Category: Private methods
Detectable ( me : mutable;
AStructure : Structure from Graphic3d )
is static private;
---Level: Internal
---Purpose: Sets detectable the structure <AStructure>.
---Category: Private methods
Clear ( me : mutable;
AStructure : Structure from Graphic3d;
WithDestruction : Boolean from Standard )
is deferred;
---Level: Internal
---Purpose: Clears the structure <AStructure>.
---Category: Private methods
Connect ( me : mutable;
AMother : Structure from Graphic3d;
ADaughter : Structure from Graphic3d )
is deferred;
---Level: Internal
---Purpose: Connects the structures <AMother> and <ADaughter>.
---Category: Private methods
Disconnect ( me : mutable;
AMother : Structure from Graphic3d;
ADaughter : Structure from Graphic3d )
is deferred;
---Level: Internal
---Purpose: Disconnects the structures <AMother> and <ADaughter>.
---Category: Private methods
Display ( me : mutable;
AStructure : Structure from Graphic3d )
is deferred;
---Level: Internal
---Purpose: Display the structure <AStructure>.
---Category: Private methods
Erase ( me : mutable;
AStructure : Structure from Graphic3d )
is deferred;
---Level: Internal
---Purpose: Erases the structure <AStructure>.
---Category: Private methods
Highlight ( me : mutable;
AStructure : Structure from Graphic3d;
AMethod : TypeOfHighlightMethod from Aspect )
is deferred;
---Level: Internal
---Purpose: Highlights the structure <AStructure>.
---Category: Private methods
SetTransform ( me : mutable;
AStructure : Structure from Graphic3d;
ATrsf : Array2OfReal from TColStd )
is deferred;
---Level: Internal
---Purpose: Transforms the structure <AStructure>.
---Category: Private methods
GraphicDriver ( me )
returns GraphicDriver from Graphic3d;
---Level: Internal
---Purpose: Returns the graphic driver of <me>.
---Category: Private methods
---C++: return const &
Identification ( me )
returns Integer from Standard
is virtual;
---Level: Internal
---Purpose: Returns the identification number of the manager.
---Category: Private methods
Identification ( me;
AId : Integer from Standard )
returns Structure from Graphic3d
is virtual;
---Level: Internal
---Purpose: Returns the structure with the identification number <AId>.
---Warning: Returns a null structure if the identification number
-- is not a structure identifier.
---Category: Private methods
NewIdentification ( me : mutable )
returns Integer from Standard
is static;
---Level: Internal
---Purpose: Returns a new identification number for a new structure in the manager.
Remove ( me : mutable;
AnId : Integer from Standard )
is static private;
---Level: Internal
---Purpose: Frees the identifieur <AnId>.
---Category: Private methods
Undetectable ( me : mutable;
AStructure : Structure from Graphic3d )
is static private;
---Level: Internal
---Purpose: Sets no detectable the structure <AStructure>.
---Category: Private methods
UnHighlight ( me : mutable )
is deferred;
---Level: Internal
---Purpose: Suppresses the highlighting on all the structures in <me>.
---Category: Private methods
UnHighlight ( me : mutable;
AStructure : Structure from Graphic3d )
is deferred;
---Level: Internal
---Purpose: Suppress the highlighting on the structure <AStructure>.
---Category: Private methods
RecomputeStructures (me: mutable);
-- Purpose: Recomputes all displayed structures. Used to recompute GL
-- resources after the last view has been closed without removing objects.
RecomputeStructures (me: mutable;
theStructures : MapOfStructure from Graphic3d);
---Purpose: Recomputes all structures from theStructures.
--
fields
--
-- Class : Graphic3d_StructureManager
--
-- Purpose : Declaration of variables specific to managers
--
-- Reminder : A manager manipulates a group of structures
-- the identifier of the manager
MyId : Integer from Standard is protected;
-- the update display mode
MyUpdateMode : TypeOfUpdate from Aspect is protected;
-- the different contexts for primitives
MyAspectLine3d : AspectLine3d from Graphic3d
is protected;
MyAspectText3d : AspectText3d from Graphic3d
is protected;
MyAspectMarker3d : AspectMarker3d from Graphic3d
is protected;
MyAspectFillArea3d : AspectFillArea3d from Graphic3d
is protected;
-- the displayed structures
MyDisplayedStructure : MapOfStructure from Graphic3d
is protected;
-- the highlighted structures
MyHighlightedStructure : MapOfStructure from Graphic3d
is protected;
-- the pickable structures
MyPickStructure : MapOfStructure from Graphic3d
is protected;
-- the structure identifier generator
MyStructGenId : GenId from Aspect is protected;
MyGraphicDriver : GraphicDriver from Graphic3d is protected;
friends
class Structure from Graphic3d
end StructureManager;
Reference in New Issue View Git Blame Copy Permalink