Open CASCADE Technology  7.3.1.dev
Public Member Functions | Protected Member Functions | Protected Attributes
PrsMgr_PresentationManager Class Reference

A framework to manage 3D displays, graphic entities and their updates. Used in the AIS package (Application Interactive Services), to enable the advanced user to define the default display mode of a new interactive object which extends the list of signatures and types. Definition of new display types is handled by calling the presentation algorithms provided by the StdPrs package. More...

#include <PrsMgr_PresentationManager.hxx>

Inheritance diagram for PrsMgr_PresentationManager:
Inheritance graph
[legend]

Public Member Functions

 PrsMgr_PresentationManager (const Handle< Graphic3d_StructureManager > &theStructureManager)
 Creates a framework to manage displays and graphic entities with the 3D view theStructureManager. More...
 
void Display (const Handle< PrsMgr_PresentableObject > &thePrsObject, const Standard_Integer theMode=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 > &thePrsObject, const Standard_Integer theMode=0)
 erases the presentation of the object in the given Presentation manager with the given mode. If is -1, then erases all presentations of the object. More...
 
virtual void Clear (const Handle< PrsMgr_PresentableObject > &thePrsObject, const Standard_Integer theMode=0)
 Clears the presentation of the presentable object thePrsObject in this framework with the display mode theMode. More...
 
void SetVisibility (const Handle< PrsMgr_PresentableObject > &thePrsObject, const Standard_Integer theMode, const Standard_Boolean theValue)
 Sets the visibility of presentable object. More...
 
void Unhighlight (const Handle< PrsMgr_PresentableObject > &thePrsObject)
 Removes highlighting from the presentation of the presentable object. More...
 
void Unhighlight (const Handle< PrsMgr_PresentableObject > &thePrsObject, const Standard_Integer theMode)
 
void SetDisplayPriority (const Handle< PrsMgr_PresentableObject > &thePrsObject, const Standard_Integer theMode, const Standard_Integer theNewPrior) const
 Sets the display priority theNewPrior of the presentable object thePrsObject in this framework with the display mode theMode. More...
 
Standard_Integer DisplayPriority (const Handle< PrsMgr_PresentableObject > &thePrsObject, const Standard_Integer theMode) const
 Returns the display priority of the presentable object thePrsObject in this framework with the display mode theMode. More...
 
void SetZLayer (const Handle< PrsMgr_PresentableObject > &thePrsObject, const Graphic3d_ZLayerId theLayerId)
 Set Z layer ID for all presentations of the object. More...
 
Graphic3d_ZLayerId GetZLayer (const Handle< PrsMgr_PresentableObject > &thePrsObject) 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. More...
 
Standard_Boolean IsDisplayed (const Handle< PrsMgr_PresentableObject > &thePrsObject, const Standard_Integer theMode=0) const
 
Standard_Boolean IsHighlighted (const Handle< PrsMgr_PresentableObject > &thePrsObject, const Standard_Integer theMode=0) const
 Returns true if the presentation of the presentable object thePrsObject in this framework with the display mode theMode is highlighted. More...
 
void Update (const Handle< PrsMgr_PresentableObject > &thePrsObject, const Standard_Integer theMode=0) const
 Updates the presentation of the presentable object thePrsObject in this framework with the display mode theMode. More...
 
void BeginImmediateDraw ()
 Resets the transient list of presentations previously displayed in immediate mode and begins accumulation of new list by following AddToImmediateList()/Color()/Highlight() calls. More...
 
void ClearImmediateDraw ()
 Resets the transient list of presentations previously displayed in immediate mode. More...
 
void AddToImmediateList (const Handle< Prs3d_Presentation > &thePrs)
 Stores thePrs in the transient list of presentations to be displayed in immediate mode. Will be taken in account in EndImmediateDraw method. More...
 
void EndImmediateDraw (const Handle< V3d_Viewer > &theViewer)
 Allows rapid drawing of the each view in theViewer by avoiding an update of the whole background. More...
 
void RedrawImmediate (const Handle< V3d_Viewer > &theViewer)
 Clears and redisplays immediate structures of the viewer taking into account its affinity. More...
 
Standard_Boolean IsImmediateModeOn () const
 Returns true if Presentation Manager is accumulating transient list of presentations to be displayed in immediate mode. More...
 
void Color (const Handle< PrsMgr_PresentableObject > &thePrsObject, const Handle< Prs3d_Drawer > &theStyle, const Standard_Integer theMode=0, const Handle< PrsMgr_PresentableObject > &theSelObj=NULL, const Graphic3d_ZLayerId theImmediateStructLayerId=Graphic3d_ZLayerId_Topmost)
 Highlights the graphic object thePrsObject in the color theColor. thePrsObject has the display mode theMode; this has the default value of 0, that is, the wireframe display mode. More...
 
void Connect (const Handle< PrsMgr_PresentableObject > &thePrsObject, const Handle< PrsMgr_PresentableObject > &theOtherObject, const Standard_Integer theMode=0, const Standard_Integer theOtherMode=0)
 
void Transform (const Handle< PrsMgr_PresentableObject > &thePrsObject, const Handle< Geom_Transformation > &theTransformation, const Standard_Integer theMode=0)
 Sets the transformation theTransformation for the presentable object thePrsObject. thePrsObject has the display mode theMode; this has the default value of 0, that is, the wireframe display mode. More...
 
const Handle< Graphic3d_StructureManager > & StructureManager () const
 Returns the structure manager. More...
 
Standard_Boolean HasPresentation (const Handle< PrsMgr_PresentableObject > &thePrsObject, const Standard_Integer theMode=0) const
 Returns true if there is a presentation of the presentable object thePrsObject in this framework, thePrsObject having the display mode theMode. More...
 
Handle< PrsMgr_PresentationPresentation (const Handle< PrsMgr_PresentableObject > &thePrsObject, const Standard_Integer theMode=0, const Standard_Boolean theToCreate=Standard_False, const Handle< PrsMgr_PresentableObject > &theSelObj=NULL) const
 Returns the presentation Presentation of the presentable object thePrsObject in this framework. When theToCreate is true - automatically creates presentation for specified mode when not exist. Optional argument theSelObj specifies parent decomposed object to inherit its view affinity. More...
 
void UpdateHighlightTrsf (const Handle< V3d_Viewer > &theViewer, const Handle< PrsMgr_PresentableObject > &theObj, const Standard_Integer theMode=0, const Handle< PrsMgr_PresentableObject > &theSelObj=NULL)
 Allows to apply location transformation to shadow highlight presentation immediately. More...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual void Delete () const
 Memory deallocator for transient classes. More...
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object. More...
 
Standard_Boolean IsInstance (const opencascade::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 opencascade::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...
 
Standard_TransientThis () const
 Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 
void IncrementRefCounter () const
 Increments the reference counter of this object. More...
 
Standard_Integer DecrementRefCounter () const
 Decrements the reference counter of this object; returns the decremented value. More...
 

Protected Member Functions

Standard_Boolean RemovePresentation (const Handle< PrsMgr_PresentableObject > &thePrsObject, const Standard_Integer theMode=0)
 Removes a presentation of the presentable object thePrsObject to this framework. thePrsObject has the display mode theMode. More...
 

Protected Attributes

Handle< Graphic3d_StructureManagermyStructureManager
 
Standard_Integer myImmediateModeOn
 
PrsMgr_ListOfPresentations myImmediateList
 
PrsMgr_ListOfPresentations myViewDependentImmediateList
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 
- Static Public Member Functions inherited from Standard_Transient
static const char * get_type_name ()
 Returns a type descriptor about this object. More...
 
static const opencascade::handle< Standard_Type > & get_type_descriptor ()
 Returns type descriptor of Standard_Transient class. More...
 

Detailed Description

A framework to manage 3D displays, graphic entities and their updates. Used in the AIS package (Application Interactive Services), to enable the advanced user to define the default display mode of a new interactive object which extends the list of signatures and types. Definition of new display types is handled by calling the presentation algorithms provided by the StdPrs package.

Constructor & Destructor Documentation

◆ PrsMgr_PresentationManager()

PrsMgr_PresentationManager::PrsMgr_PresentationManager ( const Handle< Graphic3d_StructureManager > &  theStructureManager)

Creates a framework to manage displays and graphic entities with the 3D view theStructureManager.

Member Function Documentation

◆ AddToImmediateList()

void PrsMgr_PresentationManager::AddToImmediateList ( const Handle< Prs3d_Presentation > &  thePrs)

Stores thePrs in the transient list of presentations to be displayed in immediate mode. Will be taken in account in EndImmediateDraw method.

◆ BeginImmediateDraw()

void PrsMgr_PresentationManager::BeginImmediateDraw ( )

Resets the transient list of presentations previously displayed in immediate mode and begins accumulation of new list by following AddToImmediateList()/Color()/Highlight() calls.

◆ Clear()

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

Clears the presentation of the presentable object thePrsObject in this framework with the display mode theMode.

◆ ClearImmediateDraw()

void PrsMgr_PresentationManager::ClearImmediateDraw ( )

Resets the transient list of presentations previously displayed in immediate mode.

◆ Color()

void PrsMgr_PresentationManager::Color ( const Handle< PrsMgr_PresentableObject > &  thePrsObject,
const Handle< Prs3d_Drawer > &  theStyle,
const Standard_Integer  theMode = 0,
const Handle< PrsMgr_PresentableObject > &  theSelObj = NULL,
const Graphic3d_ZLayerId  theImmediateStructLayerId = Graphic3d_ZLayerId_Topmost 
)

Highlights the graphic object thePrsObject in the color theColor. thePrsObject has the display mode theMode; this has the default value of 0, that is, the wireframe display mode.

◆ Connect()

void PrsMgr_PresentationManager::Connect ( const Handle< PrsMgr_PresentableObject > &  thePrsObject,
const Handle< PrsMgr_PresentableObject > &  theOtherObject,
const Standard_Integer  theMode = 0,
const Standard_Integer  theOtherMode = 0 
)

◆ Display()

void PrsMgr_PresentationManager::Display ( const Handle< PrsMgr_PresentableObject > &  thePrsObject,
const Standard_Integer  theMode = 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.

◆ DisplayPriority()

Standard_Integer PrsMgr_PresentationManager::DisplayPriority ( const Handle< PrsMgr_PresentableObject > &  thePrsObject,
const Standard_Integer  theMode 
) const

Returns the display priority of the presentable object thePrsObject in this framework with the display mode theMode.

◆ EndImmediateDraw()

void PrsMgr_PresentationManager::EndImmediateDraw ( const Handle< V3d_Viewer > &  theViewer)

Allows rapid drawing of the each view in theViewer by avoiding an update of the whole background.

◆ Erase()

void PrsMgr_PresentationManager::Erase ( const Handle< PrsMgr_PresentableObject > &  thePrsObject,
const Standard_Integer  theMode = 0 
)

erases the presentation of the object in the given Presentation manager with the given mode. If is -1, then erases all presentations of the object.

◆ GetZLayer()

Graphic3d_ZLayerId PrsMgr_PresentationManager::GetZLayer ( const Handle< PrsMgr_PresentableObject > &  thePrsObject) 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.

◆ HasPresentation()

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

Returns true if there is a presentation of the presentable object thePrsObject in this framework, thePrsObject having the display mode theMode.

◆ IsDisplayed()

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

◆ IsHighlighted()

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

Returns true if the presentation of the presentable object thePrsObject in this framework with the display mode theMode is highlighted.

◆ IsImmediateModeOn()

Standard_Boolean PrsMgr_PresentationManager::IsImmediateModeOn ( ) const
inline

Returns true if Presentation Manager is accumulating transient list of presentations to be displayed in immediate mode.

◆ Presentation()

Handle< PrsMgr_Presentation > PrsMgr_PresentationManager::Presentation ( const Handle< PrsMgr_PresentableObject > &  thePrsObject,
const Standard_Integer  theMode = 0,
const Standard_Boolean  theToCreate = Standard_False,
const Handle< PrsMgr_PresentableObject > &  theSelObj = NULL 
) const

Returns the presentation Presentation of the presentable object thePrsObject in this framework. When theToCreate is true - automatically creates presentation for specified mode when not exist. Optional argument theSelObj specifies parent decomposed object to inherit its view affinity.

◆ RedrawImmediate()

void PrsMgr_PresentationManager::RedrawImmediate ( const Handle< V3d_Viewer > &  theViewer)

Clears and redisplays immediate structures of the viewer taking into account its affinity.

◆ RemovePresentation()

Standard_Boolean PrsMgr_PresentationManager::RemovePresentation ( const Handle< PrsMgr_PresentableObject > &  thePrsObject,
const Standard_Integer  theMode = 0 
)
protected

Removes a presentation of the presentable object thePrsObject to this framework. thePrsObject has the display mode theMode.

◆ SetDisplayPriority()

void PrsMgr_PresentationManager::SetDisplayPriority ( const Handle< PrsMgr_PresentableObject > &  thePrsObject,
const Standard_Integer  theMode,
const Standard_Integer  theNewPrior 
) const

Sets the display priority theNewPrior of the presentable object thePrsObject in this framework with the display mode theMode.

◆ SetVisibility()

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

Sets the visibility of presentable object.

◆ SetZLayer()

void PrsMgr_PresentationManager::SetZLayer ( const Handle< PrsMgr_PresentableObject > &  thePrsObject,
const Graphic3d_ZLayerId  theLayerId 
)

Set Z layer ID for all presentations of the object.

◆ StructureManager()

const Handle< Graphic3d_StructureManager >& PrsMgr_PresentationManager::StructureManager ( ) const
inline

Returns the structure manager.

◆ Transform()

void PrsMgr_PresentationManager::Transform ( const Handle< PrsMgr_PresentableObject > &  thePrsObject,
const Handle< Geom_Transformation > &  theTransformation,
const Standard_Integer  theMode = 0 
)

Sets the transformation theTransformation for the presentable object thePrsObject. thePrsObject has the display mode theMode; this has the default value of 0, that is, the wireframe display mode.

◆ Unhighlight() [1/2]

void PrsMgr_PresentationManager::Unhighlight ( const Handle< PrsMgr_PresentableObject > &  thePrsObject)

Removes highlighting from the presentation of the presentable object.

◆ Unhighlight() [2/2]

void PrsMgr_PresentationManager::Unhighlight ( const Handle< PrsMgr_PresentableObject > &  thePrsObject,
const Standard_Integer  theMode 
)
inline
Deprecated:
("Deprecated method Unhighlight() - argument theMode will be ignored")

◆ Update()

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

Updates the presentation of the presentable object thePrsObject in this framework with the display mode theMode.

◆ UpdateHighlightTrsf()

void PrsMgr_PresentationManager::UpdateHighlightTrsf ( const Handle< V3d_Viewer > &  theViewer,
const Handle< PrsMgr_PresentableObject > &  theObj,
const Standard_Integer  theMode = 0,
const Handle< PrsMgr_PresentableObject > &  theSelObj = NULL 
)

Allows to apply location transformation to shadow highlight presentation immediately.

Parameters
theObjdefines the base object, it local transformation will be applied to corresponding highlight structure
theModedefines display mode of the base object
theSelObjdefines the object produced after decomposition of the base object for local selection

Field Documentation

◆ myImmediateList

PrsMgr_ListOfPresentations PrsMgr_PresentationManager::myImmediateList
protected

◆ myImmediateModeOn

Standard_Integer PrsMgr_PresentationManager::myImmediateModeOn
protected

◆ myStructureManager

Handle< Graphic3d_StructureManager > PrsMgr_PresentationManager::myStructureManager
protected

◆ myViewDependentImmediateList

PrsMgr_ListOfPresentations PrsMgr_PresentationManager::myViewDependentImmediateList
protected

The documentation for this class was generated from the following file: