OCC Main Page | Visualization | Toolkits | Packages | Class Hierarchy | Data Structures | File List | Data Fields | Globals

Visualization
TKV3d
PrsMgr


PrsMgr_PresentationManager Class Reference

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
.

#include <PrsMgr_PresentationManager.hxx>

Inheritance diagram for PrsMgr_PresentationManager:

Inheritance graph
[legend]

Public Member Functions

virtual Standard_EXPORT Standard_Boolean Is3D () const =0
Standard_EXPORT void Display (const Handle(PrsMgr_PresentableObject)&aPresentableObject, const Standard_Integer aMode=0)
 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.
.
Standard_EXPORT void Erase (const Handle(PrsMgr_PresentableObject)&aPresentableObject, const Standard_Integer aMode=0)
 erases the presentation of the object in the given
Presentation manager with the given mode.

virtual Standard_EXPORT void Clear (const Handle(PrsMgr_PresentableObject)&aPresentableObject, const Standard_Integer aMode=0)
 Clears the presentation of the presentable object
aPresentableObject in this framework with the
display mode aMode.
.
Standard_EXPORT void Highlight (const Handle(PrsMgr_PresentableObject)&aPresentableObject, const Standard_Integer aMode=0)
 Highlights the presentation of the presentable object
aPresentableObject in this framework with the display mode aMode.
.
Standard_EXPORT void Unhighlight (const Handle(PrsMgr_PresentableObject)&aPresentableObject, const Standard_Integer aMode=0)
 Removes highlighting from the presentation of the
presentable object aPresentableObject in this
framework with the display mode aMode.
.
Standard_EXPORT void SetDisplayPriority (const Handle(PrsMgr_PresentableObject)&aPresentableObject, const Standard_Integer amode, const Standard_Integer aNewPrior) const
 Sets the display priority aNewPrior of the
presentable object aPresentableObject in this
framework with the display mode aMode.
.
Standard_EXPORT Standard_Integer DisplayPriority (const Handle(PrsMgr_PresentableObject)&aPresentableObject, const Standard_Integer amode) const
 Returns the display priority of the presentable object
aPresentableObject in this framework with the
display mode aMode.
.
Standard_EXPORT Standard_Boolean IsDisplayed (const Handle(PrsMgr_PresentableObject)&aPresentableObject, const Standard_Integer aMode=0) const
 Returns true if the presentation of the presentable
object aPresentableObject in this framework with the
display mode aMode is displayed.
.
Standard_EXPORT Standard_Boolean IsHighlighted (const Handle(PrsMgr_PresentableObject)&aPresentableObject, const Standard_Integer aMode=0) const
 Returns true if the presentation of the presentable
object aPresentableObject in this framework with the
display mode aMode is highlighted.
.
Standard_EXPORT void Update (const Handle(PrsMgr_PresentableObject)&aPresentableObject, const Standard_Integer aMode=0) const
 Updates the presentation of the presentable object
aPresentableObject in this framework with the display mode aMode.
.
virtual Standard_EXPORT void BeginDraw ()
 initializes the list of Prs to be displayed in transient mode

Standard_EXPORT void Add (const Handle(PrsMgr_PresentableObject)&aPresentableObject, const Standard_Integer aMode=0)
 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.
.
Standard_EXPORT void Remove (const Handle(PrsMgr_PresentableObject)&aPresentableObject, const Standard_Integer aMode=0)
 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.
.
virtual Standard_EXPORT void EndDraw (const Handle(Viewer_View)&aView, const Standard_Boolean DoubleBuffer=Standard_False)=0
 Allows rapid drawing of the view aView by avoiding
an update of the whole background. If DoubleBuffer
is true, the background is drawn.
.
Standard_Boolean IsImmediateModeOn () const
 Returns true if immediate (transient) mode is on.
.
Standard_EXPORT Standard_Boolean HasPresentation (const Handle(PrsMgr_PresentableObject)&aPresentableObject, const Standard_Integer aMode=0) const
 Returns true if there is a presentation of the
presentable object aPresentableObject in this
framework, aPresentableObject having the display mode aMode.
.
Standard_EXPORT Handle_PrsMgr_Presentation Presentation (const Handle(PrsMgr_PresentableObject)&aPresentableObject, const Standard_Integer aMode=0) const
 Returns the presentation Presentation of the
presentable object aPresentableObject in this
framework. aPresentableObject has the display mode aMode.
.
Standard_EXPORT const Handle (Standard_Type)&DynamicType() const

Protected Member Functions

Standard_EXPORT PrsMgr_PresentationManager ()
Standard_EXPORT void AddPresentation (const Handle(PrsMgr_PresentableObject)&aPresentableObject, const Standard_Integer aMode=0)
 Adds a presentation of the presentable object
aPresentableObject to this framework.
aPresentableObject has the display mode aMode.
.

Protected Attributes

Standard_Boolean myImmediateMode
TColStd_ListOfTransient myImmediateList

Private Member Functions

virtual Standard_EXPORT Handle_PrsMgr_Presentation newPresentation (const Handle(PrsMgr_PresentableObject)&aPresentableObject)=0
 Creates a new presentation in the presentation manager.
.

Constructor & Destructor Documentation

Standard_EXPORT PrsMgr_PresentationManager::PrsMgr_PresentationManager  )  [protected]
 


Member Function Documentation

Standard_EXPORT void PrsMgr_PresentationManager::Add const Handle(PrsMgr_PresentableObject)&  aPresentableObject,
const Standard_Integer  aMode = 0
 

Standard_EXPORT void PrsMgr_PresentationManager::AddPresentation const Handle(PrsMgr_PresentableObject)&  aPresentableObject,
const Standard_Integer  aMode = 0
[protected]
 

virtual Standard_EXPORT void PrsMgr_PresentationManager::BeginDraw  )  [virtual]
 

Reimplemented in PrsMgr_PresentationManager2d, and PrsMgr_PresentationManager3d.

virtual Standard_EXPORT void PrsMgr_PresentationManager::Clear const Handle(PrsMgr_PresentableObject)&  aPresentableObject,
const Standard_Integer  aMode = 0
[virtual]
 

Standard_EXPORT void PrsMgr_PresentationManager::Display const Handle(PrsMgr_PresentableObject)&  aPresentableObject,
const Standard_Integer  aMode = 0
 

Standard_EXPORT Standard_Integer PrsMgr_PresentationManager::DisplayPriority const Handle(PrsMgr_PresentableObject)&  aPresentableObject,
const Standard_Integer  amode
const
 

virtual Standard_EXPORT void PrsMgr_PresentationManager::EndDraw const Handle(Viewer_View)&  aView,
const Standard_Boolean  DoubleBuffer = Standard_False
[pure virtual]
 

Implemented in PrsMgr_PresentationManager2d, and PrsMgr_PresentationManager3d.

Standard_EXPORT void PrsMgr_PresentationManager::Erase const Handle(PrsMgr_PresentableObject)&  aPresentableObject,
const Standard_Integer  aMode = 0
 

Standard_EXPORT const PrsMgr_PresentationManager::Handle Standard_Type   )  const
 

Reimplemented in PrsMgr_PresentationManager2d, and PrsMgr_PresentationManager3d.

Standard_EXPORT Standard_Boolean PrsMgr_PresentationManager::HasPresentation const Handle(PrsMgr_PresentableObject)&  aPresentableObject,
const Standard_Integer  aMode = 0
const
 

Standard_EXPORT void PrsMgr_PresentationManager::Highlight const Handle(PrsMgr_PresentableObject)&  aPresentableObject,
const Standard_Integer  aMode = 0
 

virtual Standard_EXPORT Standard_Boolean PrsMgr_PresentationManager::Is3D  )  const [pure virtual]
 

Implemented in PrsMgr_PresentationManager2d, and PrsMgr_PresentationManager3d.

Standard_EXPORT Standard_Boolean PrsMgr_PresentationManager::IsDisplayed const Handle(PrsMgr_PresentableObject)&  aPresentableObject,
const Standard_Integer  aMode = 0
const
 

Standard_EXPORT Standard_Boolean PrsMgr_PresentationManager::IsHighlighted const Handle(PrsMgr_PresentableObject)&  aPresentableObject,
const Standard_Integer  aMode = 0
const
 

Standard_Boolean PrsMgr_PresentationManager::IsImmediateModeOn  )  const [inline]
 

virtual Standard_EXPORT Handle_PrsMgr_Presentation PrsMgr_PresentationManager::newPresentation const Handle(PrsMgr_PresentableObject)&  aPresentableObject  )  [private, pure virtual]
 

Implemented in PrsMgr_PresentationManager2d, and PrsMgr_PresentationManager3d.

Standard_EXPORT Handle_PrsMgr_Presentation PrsMgr_PresentationManager::Presentation const Handle(PrsMgr_PresentableObject)&  aPresentableObject,
const Standard_Integer  aMode = 0
const
 

Standard_EXPORT void PrsMgr_PresentationManager::Remove const Handle(PrsMgr_PresentableObject)&  aPresentableObject,
const Standard_Integer  aMode = 0
 

Standard_EXPORT void PrsMgr_PresentationManager::SetDisplayPriority const Handle(PrsMgr_PresentableObject)&  aPresentableObject,
const Standard_Integer  amode,
const Standard_Integer  aNewPrior
const
 

Standard_EXPORT void PrsMgr_PresentationManager::Unhighlight const Handle(PrsMgr_PresentableObject)&  aPresentableObject,
const Standard_Integer  aMode = 0
 

Standard_EXPORT void PrsMgr_PresentationManager::Update const Handle(PrsMgr_PresentableObject)&  aPresentableObject,
const Standard_Integer  aMode = 0
const
 


Field Documentation

TColStd_ListOfTransient PrsMgr_PresentationManager::myImmediateList [protected]
 

Standard_Boolean PrsMgr_PresentationManager::myImmediateMode [protected]
 


The documentation for this class was generated from the following files:
Generated on Mon Aug 25 13:56:08 2008 for OpenCASCADE by  doxygen 1.4.1