Open CASCADE Technology 6.6.0
Public Member Functions | Protected Member Functions | Protected Attributes
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_Boolean Is3D () const =0
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.

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 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.

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.

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.

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_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.

void SetZLayer (const Handle< PrsMgr_PresentableObject > &thePresentableObject, const Standard_Integer theLayerId)
 Set Z layer ID for all presentations of the object.

Standard_Integer GetZLayer (const Handle< PrsMgr_PresentableObject > &thePresentableObject) const
 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.

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_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.

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 void BeginDraw ()
 initializes the list of Prs to be displayed in transient mode

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.

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 void EndDraw (const Handle< V3d_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_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.

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.

Protected Member Functions

 PrsMgr_PresentationManager ()
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.

void RemovePresentation (const Handle< PrsMgr_PresentableObject > &aPresentableObject, const Standard_Integer aMode=0)
 Removes a presentation of the presentable object
aPresentableObject to this framework.
aPresentableObject has the display mode aMode.

Protected Attributes

Standard_Boolean myImmediateMode
TColStd_ListOfTransient myImmediateList

Constructor & Destructor Documentation

PrsMgr_PresentationManager::PrsMgr_PresentationManager ( ) [protected]

Member Function Documentation

void PrsMgr_PresentationManager::Add ( const Handle< PrsMgr_PresentableObject > &  aPresentableObject,
const Standard_Integer  aMode = 0 
)
void PrsMgr_PresentationManager::AddPresentation ( const Handle< PrsMgr_PresentableObject > &  aPresentableObject,
const Standard_Integer  aMode = 0 
) [protected]
virtual void PrsMgr_PresentationManager::BeginDraw ( ) [virtual]

Reimplemented in PrsMgr_PresentationManager3d.

virtual void PrsMgr_PresentationManager::Clear ( const Handle< PrsMgr_PresentableObject > &  aPresentableObject,
const Standard_Integer  aMode = 0 
) [virtual]
void PrsMgr_PresentationManager::Display ( const Handle< PrsMgr_PresentableObject > &  aPresentableObject,
const Standard_Integer  aMode = 0 
)
Standard_Integer PrsMgr_PresentationManager::DisplayPriority ( const Handle< PrsMgr_PresentableObject > &  aPresentableObject,
const Standard_Integer  amode 
) const
virtual void PrsMgr_PresentationManager::EndDraw ( const Handle< V3d_View > &  aView,
const Standard_Boolean  DoubleBuffer = Standard_False 
) [pure virtual]
void PrsMgr_PresentationManager::Erase ( const Handle< PrsMgr_PresentableObject > &  aPresentableObject,
const Standard_Integer  aMode = 0 
)
Standard_Integer PrsMgr_PresentationManager::GetZLayer ( const Handle< PrsMgr_PresentableObject > &  thePresentableObject) const
Standard_Boolean PrsMgr_PresentationManager::HasPresentation ( const Handle< PrsMgr_PresentableObject > &  aPresentableObject,
const Standard_Integer  aMode = 0 
) const
void PrsMgr_PresentationManager::Highlight ( const Handle< PrsMgr_PresentableObject > &  aPresentableObject,
const Standard_Integer  aMode = 0 
)
virtual Standard_Boolean PrsMgr_PresentationManager::Is3D ( ) const [pure virtual]
Standard_Boolean PrsMgr_PresentationManager::IsDisplayed ( const Handle< PrsMgr_PresentableObject > &  aPresentableObject,
const Standard_Integer  aMode = 0 
) const
Standard_Boolean PrsMgr_PresentationManager::IsHighlighted ( const Handle< PrsMgr_PresentableObject > &  aPresentableObject,
const Standard_Integer  aMode = 0 
) const
Standard_Boolean PrsMgr_PresentationManager::IsImmediateModeOn ( ) const
Handle_PrsMgr_Presentation PrsMgr_PresentationManager::Presentation ( const Handle< PrsMgr_PresentableObject > &  aPresentableObject,
const Standard_Integer  aMode = 0 
) const
void PrsMgr_PresentationManager::Remove ( const Handle< PrsMgr_PresentableObject > &  aPresentableObject,
const Standard_Integer  aMode = 0 
)
void PrsMgr_PresentationManager::RemovePresentation ( const Handle< PrsMgr_PresentableObject > &  aPresentableObject,
const Standard_Integer  aMode = 0 
) [protected]
void PrsMgr_PresentationManager::SetDisplayPriority ( const Handle< PrsMgr_PresentableObject > &  aPresentableObject,
const Standard_Integer  amode,
const Standard_Integer  aNewPrior 
) const
void PrsMgr_PresentationManager::SetZLayer ( const Handle< PrsMgr_PresentableObject > &  thePresentableObject,
const Standard_Integer  theLayerId 
)
void PrsMgr_PresentationManager::Unhighlight ( const Handle< PrsMgr_PresentableObject > &  aPresentableObject,
const Standard_Integer  aMode = 0 
)
void PrsMgr_PresentationManager::Update ( const Handle< PrsMgr_PresentableObject > &  aPresentableObject,
const Standard_Integer  aMode = 0 
) const

Field Documentation


The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines