Open CASCADE Technology  6.7.1
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Protected Member Functions | Protected Attributes
PrsMgr_PresentationManager Class Referenceabstract

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

#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.
More...
 
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.
More...
 
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.
More...
 
void SetVisibility (const Handle< PrsMgr_PresentableObject > &thePresentableObject, const Standard_Integer theMode, const Standard_Boolean theValue)
 Sets the visibility of presentable object.
More...
 
void Highlight (const Handle< PrsMgr_PresentableObject > &aPresentableObject, const Standard_Integer aMode=0)
 
 Highlights the presentation of the presentable object <br>

aPresentableObject in this framework with the display mode aMode.
More...

 
void Unhighlight (const Handle< PrsMgr_PresentableObject > &aPresentableObject, const Standard_Integer aMode=0)
 
 Removes highlighting from the presentation of the <br>

presentable object aPresentableObject in this
framework with the display mode aMode.
More...

 
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.
More...
 
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.
More...
 
void SetZLayer (const Handle< PrsMgr_PresentableObject > &thePresentableObject, const Standard_Integer theLayerId)
 Set Z layer ID for all presentations of the object.
More...
 
Standard_Integer GetZLayer (const Handle< PrsMgr_PresentableObject > &thePresentableObject) const
 
 Get Z layer ID assigned to all presentations of the object. <br>

Method returns -1 value if object has no presentations and is
impossible to get layer index.
More...

 
Standard_Boolean IsDisplayed (const Handle< PrsMgr_PresentableObject > &aPresentableObject, const Standard_Integer aMode=0) const
 
 Returns true if the presentation of the presentable <br>

object aPresentableObject in this framework with the
display mode aMode is displayed.
More...

 
Standard_Boolean IsHighlighted (const Handle< PrsMgr_PresentableObject > &aPresentableObject, const Standard_Integer aMode=0) const
 
 Returns true if the presentation of the presentable <br>

object aPresentableObject in this framework with the
display mode aMode is highlighted.
More...

 
void Update (const Handle< PrsMgr_PresentableObject > &aPresentableObject, const Standard_Integer aMode=0) const
 
 Updates the presentation of the presentable object <br>

aPresentableObject in this framework with the display mode aMode.
More...

 
virtual void BeginDraw ()
 initializes the list of Prs to be displayed in transient mode
More...
 
void Add (const Handle< PrsMgr_PresentableObject > &aPresentableObject, const Standard_Integer aMode=0)
 
 Performs an iteration of the transient objects to look <br>

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

 
void Remove (const Handle< PrsMgr_PresentableObject > &aPresentableObject, const Standard_Integer aMode=0)
 
 Performs an iteration of the transient objects to look <br>

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

 
virtual void EndDraw (const Handle< V3d_View > &aView, const Standard_Boolean DoubleBuffer=Standard_False)=0
 
  Allows rapid drawing of the view aView by avoiding <br>

an update of the whole background. If DoubleBuffer
is true, the background is drawn.
More...

 
Standard_Boolean IsImmediateModeOn () const
 Returns true if immediate (transient) mode is on.
More...
 
Standard_Boolean HasPresentation (const Handle< PrsMgr_PresentableObject > &aPresentableObject, const Standard_Integer aMode=0) const
 
 Returns true if there is a presentation of the <br>

presentable object aPresentableObject in this
framework, aPresentableObject having the display mode aMode.
More...

 
Handle_PrsMgr_Presentation Presentation (const Handle< PrsMgr_PresentableObject > &aPresentableObject, const Standard_Integer aMode=0) const
 
 Returns the presentation Presentation of the <br>

presentable object aPresentableObject in this
framework. aPresentableObject has the display mode aMode.
More...

 
- Public Member Functions inherited from MMgt_TShared
virtual void Delete () const
 Memory deallocator for transient classes. More...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transient & operator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual void ShallowDump (Standard_OStream &) const
 
virtual const
Handle_Standard_Type & 		DynamicType () const
 Returns a type information object about this object. More...
 
Standard_Boolean IsInstance (const Handle_Standard_Type &theType) const
 Returns a true value if this is an instance of Type. More...
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName. More...
 
Standard_Boolean IsKind (const Handle_Standard_Type &theType) const
 Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...
 
Standard_Boolean IsKind (const Standard_CString theTypeName) const
 Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...
 
virtual Handle_Standard_Transient This () const
 Returns a Handle which references this object. Must never be called to objects created in stack. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 

Protected Member Functions

 PrsMgr_PresentationManager ()
 
void AddPresentation (const Handle< PrsMgr_PresentableObject > &aPresentableObject, const Standard_Integer aMode=0)
 
 Adds a presentation of the presentable object <br>

aPresentableObject to this framework.
aPresentableObject has the display mode aMode.
More...

 
void RemovePresentation (const Handle< PrsMgr_PresentableObject > &aPresentableObject, const Standard_Integer aMode=0)
 
 Removes a presentation of the presentable object <br>

aPresentableObject to this framework.
aPresentableObject has the display mode aMode.
More...

 

Protected Attributes

Standard_Boolean myImmediateMode
 
TColStd_ListOfTransient myImmediateList
 

Detailed Description

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

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 
) 

 Performs an iteration of the transient objects to look <br>

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 PrsMgr_PresentationManager::AddPresentation ( const Handle< PrsMgr_PresentableObject > &  aPresentableObject,
const Standard_Integer  aMode = 0 
)
protected 

 Adds a presentation of the presentable object <br>

aPresentableObject to this framework.
aPresentableObject has the display mode aMode.

virtual void PrsMgr_PresentationManager::BeginDraw ( )
virtual

initializes the list of Prs to be displayed in transient mode

Reimplemented in PrsMgr_PresentationManager3d.

virtual void PrsMgr_PresentationManager::Clear ( const Handle< PrsMgr_PresentableObject > &  aPresentableObject,
const Standard_Integer  aMode = 0 
)
virtual

Clears the presentation of the presentable object
aPresentableObject in this framework with the
display mode aMode.

void PrsMgr_PresentationManager::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_Integer PrsMgr_PresentationManager::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.

virtual void PrsMgr_PresentationManager::EndDraw ( const Handle< V3d_View > &  aView,
const Standard_Boolean  DoubleBuffer = Standard_False 
)
pure virtual 

  Allows rapid drawing of the view aView by avoiding <br>

an update of the whole background. If DoubleBuffer
is true, the background is drawn.

Implemented in PrsMgr_PresentationManager3d.

void PrsMgr_PresentationManager::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.

Standard_Integer PrsMgr_PresentationManager::GetZLayer ( const Handle< PrsMgr_PresentableObject > &  thePresentableObject) const 

 Get Z layer ID assigned to all presentations of the object. <br>

Method returns -1 value if object has no presentations and is
impossible to get layer index.

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

 Returns true if there is a presentation of the <br>

presentable object aPresentableObject in this
framework, aPresentableObject having the display mode aMode.

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

 Highlights the presentation of the presentable object <br>

aPresentableObject in this framework with the display mode aMode.

virtual Standard_Boolean PrsMgr_PresentationManager::Is3D ( ) const
pure virtual

Implemented in PrsMgr_PresentationManager3d.

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

 Returns true if the presentation of the presentable <br>

object aPresentableObject in this framework with the
display mode aMode is displayed.

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

 Returns true if the presentation of the presentable <br>

object aPresentableObject in this framework with the
display mode aMode is highlighted.

Standard_Boolean PrsMgr_PresentationManager::IsImmediateModeOn ( ) const

Returns true if immediate (transient) mode is on.

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

 Returns the presentation Presentation of the <br>

presentable object aPresentableObject in this
framework. aPresentableObject has the display mode aMode.

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

 Performs an iteration of the transient objects to look <br>

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.

void PrsMgr_PresentationManager::RemovePresentation ( const Handle< PrsMgr_PresentableObject > &  aPresentableObject,
const Standard_Integer  aMode = 0 
)
protected 

 Removes a presentation of the presentable object <br>

aPresentableObject to this framework.
aPresentableObject has the display mode aMode.

void PrsMgr_PresentationManager::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.

void PrsMgr_PresentationManager::SetVisibility ( const Handle< PrsMgr_PresentableObject > &  thePresentableObject,
const Standard_Integer  theMode,
const Standard_Boolean  theValue 
)

Sets the visibility of presentable object.

void PrsMgr_PresentationManager::SetZLayer ( const Handle< PrsMgr_PresentableObject > &  thePresentableObject,
const Standard_Integer  theLayerId 
)

Set Z layer ID for all presentations of the object.

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

 Removes highlighting from the presentation of the <br>

presentable object aPresentableObject in this
framework with the display mode aMode.

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

 Updates the presentation of the presentable object <br>

aPresentableObject in this framework with the display mode aMode.

Field Documentation

TColStd_ListOfTransient PrsMgr_PresentationManager::myImmediateList
protected
Standard_Boolean PrsMgr_PresentationManager::myImmediateMode
protected
The documentation for this class was generated from the following file:
Generated on Tue Apr 29 2014 15:38:25 for Open CASCADE Technology by   doxygen 1.8.5