Open CASCADE Technology  7.1.0.beta
Public Member Functions | Protected Member Functions | Protected Attributes

Graphic3d_StructureManager Class Reference

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

#include <Graphic3d_StructureManager.hxx>

Inheritance diagram for Graphic3d_StructureManager:
Inheritance graph
[legend]

Public Member Functions

 Graphic3d_StructureManager (const Handle< Graphic3d_GraphicDriver > &theDriver)
 Initializes the ViewManager. Currently creating of more than 100 viewer instances is not supported and leads to InitializationError and initialization failure. This limitation might be addressed in some future OCCT releases. Warning: Raises InitialisationError if the initialization of the ViewManager failed. More...
 
 ~Graphic3d_StructureManager ()
 Deletes the manager <me>. More...
 
void SetUpdateMode (const Aspect_TypeOfUpdate theType)
 Modifies the screen update mode. More...
 
Aspect_TypeOfUpdate UpdateMode () const
 Returns the screen update mode. More...
 
virtual void Update (const Aspect_TypeOfUpdate theMode=Aspect_TOU_ASAP, const Graphic3d_ZLayerId theLayerId=Graphic3d_ZLayerId_UNKNOWN) const
 Updates screen in function of modifications of the structures and invalidates bounding box of specified ZLayerId. More...
 
virtual void Remove ()
 Deletes and erases the 3D structure manager. More...
 
virtual void Erase ()
 Erases all the structures. More...
 
void DisplayedStructures (Graphic3d_MapOfStructure &SG) const
 Returns the set of structures displayed in visualiser <me>. More...
 
void HighlightedStructures (Graphic3d_MapOfStructure &SG) const
 Returns the set of highlighted structures in a visualiser <me>. More...
 
virtual void ReCompute (const Handle< Graphic3d_Structure > &theStructure)
 Forces a new construction of the structure. if <theStructure> is displayed and TOS_COMPUTED. More...
 
virtual void ReCompute (const Handle< Graphic3d_Structure > &theStructure, const Handle< Graphic3d_DataStructureManager > &theProjector)
 Forces a new construction of the structure. if <theStructure> is displayed in <theProjector> and TOS_COMPUTED. More...
 
virtual void Clear (const Handle< Graphic3d_Structure > &theStructure, const Standard_Boolean theWithDestruction)
 Clears the structure. More...
 
virtual void Connect (const Handle< Graphic3d_Structure > &theMother, const Handle< Graphic3d_Structure > &theDaughter)
 Connects the structures. More...
 
virtual void Disconnect (const Handle< Graphic3d_Structure > &theMother, const Handle< Graphic3d_Structure > &theDaughter)
 Disconnects the structures. More...
 
virtual void Display (const Handle< Graphic3d_Structure > &theStructure)
 Display the structure. More...
 
virtual void Erase (const Handle< Graphic3d_Structure > &theStructure)
 Erases the structure. More...
 
virtual void Highlight (const Handle< Graphic3d_Structure > &theStructure)
 Highlights the structure. More...
 
virtual void SetTransform (const Handle< Graphic3d_Structure > &theStructure, const Handle< Geom_Transformation > &theTrsf)
 Transforms the structure. More...
 
virtual void ChangeDisplayPriority (const Handle< Graphic3d_Structure > &theStructure, const Standard_Integer theOldPriority, const Standard_Integer theNewPriority)
 Changes the display priority of the structure <AStructure>. More...
 
virtual void ChangeZLayer (const Handle< Graphic3d_Structure > &theStructure, const Graphic3d_ZLayerId theLayerId)
 Change Z layer for structure. The Z layer mechanism allows to display structures in higher layers in overlay of structures in lower layers. More...
 
const Handle< Graphic3d_GraphicDriver > & GraphicDriver () const
 Returns the graphic driver of <me>. More...
 
Standard_Integer Identification (Graphic3d_CView *theView)
 Attaches the view to this structure manager and sets its identification number within the manager. More...
 
void UnIdentification (Graphic3d_CView *theView)
 Detach the view from this structure manager and release its identification. More...
 
const Graphic3d_IndexedMapOfViewDefinedViews () const
 Returns the group of views defined in the structure manager. More...
 
Standard_Integer MaxNumOfViews () const
 Returns the theoretical maximum number of definable views in the manager. Warning: It's not possible to accept an infinite number of definable views because each view must have an identification and we have different managers. More...
 
virtual Handle< Graphic3d_StructureIdentification (const Standard_Integer AId) const
 Returns the structure with the identification number <AId>. More...
 
virtual void UnHighlight (const Handle< Graphic3d_Structure > &AStructure)
 Suppress the highlighting on the structure <AStructure>. More...
 
virtual void UnHighlight ()
 Suppresses the highlighting on all the structures in <me>. More...
 
void RecomputeStructures ()
 
void RecomputeStructures (const Graphic3d_MapOfStructure &theStructures)
 Recomputes all structures from theStructures. More...
 
Handle< Graphic3d_ViewAffinityRegisterObject (const Handle< Standard_Transient > &theObject)
 
void UnregisterObject (const Handle< Standard_Transient > &theObject)
 
Handle< Graphic3d_ViewAffinityObjectAffinity (const Handle< Standard_Transient > &theObject) const
 
- Public Member Functions inherited from MMgt_TShared
virtual void Delete () const override
 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_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. 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_Integer NumberOfDisplayedStructures () const
 Returns the number of structures displayed in visualizer <me>. Returns the structure displayed in visualizer <me>. More...
 

Protected Attributes

Aspect_GenId myViewGenId
 
Aspect_TypeOfUpdate myUpdateMode
 
Graphic3d_MapOfStructure myDisplayedStructure
 
Graphic3d_MapOfStructure myHighlightedStructure
 
Graphic3d_MapOfObject myRegisteredObjects
 
Handle< Graphic3d_GraphicDrivermyGraphicDriver
 
Graphic3d_IndexedMapOfView myDefinedViews
 

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

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.

Constructor & Destructor Documentation

Graphic3d_StructureManager::Graphic3d_StructureManager ( const Handle< Graphic3d_GraphicDriver > &  theDriver)

Initializes the ViewManager. Currently creating of more than 100 viewer instances is not supported and leads to InitializationError and initialization failure. This limitation might be addressed in some future OCCT releases. Warning: Raises InitialisationError if the initialization of the ViewManager failed.

Graphic3d_StructureManager::~Graphic3d_StructureManager ( )

Deletes the manager <me>.

Member Function Documentation

virtual void Graphic3d_StructureManager::ChangeDisplayPriority ( const Handle< Graphic3d_Structure > &  theStructure,
const Standard_Integer  theOldPriority,
const Standard_Integer  theNewPriority 
)
virtual

Changes the display priority of the structure <AStructure>.

virtual void Graphic3d_StructureManager::ChangeZLayer ( const Handle< Graphic3d_Structure > &  theStructure,
const Graphic3d_ZLayerId  theLayerId 
)
virtual

Change Z layer for structure. The Z layer mechanism allows to display structures in higher layers in overlay of structures in lower layers.

virtual void Graphic3d_StructureManager::Clear ( const Handle< Graphic3d_Structure > &  theStructure,
const Standard_Boolean  theWithDestruction 
)
virtual

Clears the structure.

virtual void Graphic3d_StructureManager::Connect ( const Handle< Graphic3d_Structure > &  theMother,
const Handle< Graphic3d_Structure > &  theDaughter 
)
virtual

Connects the structures.

const Graphic3d_IndexedMapOfView& Graphic3d_StructureManager::DefinedViews ( ) const

Returns the group of views defined in the structure manager.

virtual void Graphic3d_StructureManager::Disconnect ( const Handle< Graphic3d_Structure > &  theMother,
const Handle< Graphic3d_Structure > &  theDaughter 
)
virtual

Disconnects the structures.

virtual void Graphic3d_StructureManager::Display ( const Handle< Graphic3d_Structure > &  theStructure)
virtual

Display the structure.

void Graphic3d_StructureManager::DisplayedStructures ( Graphic3d_MapOfStructure SG) const

Returns the set of structures displayed in visualiser <me>.

virtual void Graphic3d_StructureManager::Erase ( )
virtual

Erases all the structures.

virtual void Graphic3d_StructureManager::Erase ( const Handle< Graphic3d_Structure > &  theStructure)
virtual

Erases the structure.

const Handle< Graphic3d_GraphicDriver >& Graphic3d_StructureManager::GraphicDriver ( ) const

Returns the graphic driver of <me>.

virtual void Graphic3d_StructureManager::Highlight ( const Handle< Graphic3d_Structure > &  theStructure)
virtual

Highlights the structure.

void Graphic3d_StructureManager::HighlightedStructures ( Graphic3d_MapOfStructure SG) const

Returns the set of highlighted structures in a visualiser <me>.

Standard_Integer Graphic3d_StructureManager::Identification ( Graphic3d_CView theView)

Attaches the view to this structure manager and sets its identification number within the manager.

virtual Handle< Graphic3d_Structure > Graphic3d_StructureManager::Identification ( const Standard_Integer  AId) const
virtual

Returns the structure with the identification number <AId>.

Standard_Integer Graphic3d_StructureManager::MaxNumOfViews ( ) const

Returns the theoretical maximum number of definable views in the manager. Warning: It's not possible to accept an infinite number of definable views because each view must have an identification and we have different managers.

Standard_Integer Graphic3d_StructureManager::NumberOfDisplayedStructures ( ) const
protected

Returns the number of structures displayed in visualizer <me>. Returns the structure displayed in visualizer <me>.

Handle< Graphic3d_ViewAffinity > Graphic3d_StructureManager::ObjectAffinity ( const Handle< Standard_Transient > &  theObject) const
virtual void Graphic3d_StructureManager::ReCompute ( const Handle< Graphic3d_Structure > &  theStructure)
virtual

Forces a new construction of the structure. if <theStructure> is displayed and TOS_COMPUTED.

virtual void Graphic3d_StructureManager::ReCompute ( const Handle< Graphic3d_Structure > &  theStructure,
const Handle< Graphic3d_DataStructureManager > &  theProjector 
)
virtual

Forces a new construction of the structure. if <theStructure> is displayed in <theProjector> and TOS_COMPUTED.

void Graphic3d_StructureManager::RecomputeStructures ( )
void Graphic3d_StructureManager::RecomputeStructures ( const Graphic3d_MapOfStructure theStructures)

Recomputes all structures from theStructures.

Handle< Graphic3d_ViewAffinity > Graphic3d_StructureManager::RegisterObject ( const Handle< Standard_Transient > &  theObject)
virtual void Graphic3d_StructureManager::Remove ( )
virtual

Deletes and erases the 3D structure manager.

virtual void Graphic3d_StructureManager::SetTransform ( const Handle< Graphic3d_Structure > &  theStructure,
const Handle< Geom_Transformation > &  theTrsf 
)
virtual

Transforms the structure.

void Graphic3d_StructureManager::SetUpdateMode ( const Aspect_TypeOfUpdate  theType)
inline

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: Graphic3d_StructureManager::Update()
  • Update one view of the viewer: Graphic3d_View::Update() Use one of the following functions to update the entire display:
  • Redraw all structures in all views: Graphic3d_StructureManager::Redraw()
  • Redraw all structures in one view: Graphic3d_View::Redraw()
virtual void Graphic3d_StructureManager::UnHighlight ( const Handle< Graphic3d_Structure > &  AStructure)
virtual

Suppress the highlighting on the structure <AStructure>.

virtual void Graphic3d_StructureManager::UnHighlight ( )
virtual

Suppresses the highlighting on all the structures in <me>.

void Graphic3d_StructureManager::UnIdentification ( Graphic3d_CView theView)

Detach the view from this structure manager and release its identification.

void Graphic3d_StructureManager::UnregisterObject ( const Handle< Standard_Transient > &  theObject)
virtual void Graphic3d_StructureManager::Update ( const Aspect_TypeOfUpdate  theMode = Aspect_TOU_ASAP,
const Graphic3d_ZLayerId  theLayerId = Graphic3d_ZLayerId_UNKNOWN 
) const
virtual

Updates screen in function of modifications of the structures and invalidates bounding box of specified ZLayerId.

Aspect_TypeOfUpdate Graphic3d_StructureManager::UpdateMode ( ) const
inline

Returns the screen update mode.

TOU_ASAP as soon as possible TOU_WAIT on demand (Update)

Field Documentation

Graphic3d_IndexedMapOfView Graphic3d_StructureManager::myDefinedViews
protected
Graphic3d_MapOfStructure Graphic3d_StructureManager::myDisplayedStructure
protected
Handle< Graphic3d_GraphicDriver > Graphic3d_StructureManager::myGraphicDriver
protected
Graphic3d_MapOfStructure Graphic3d_StructureManager::myHighlightedStructure
protected
Graphic3d_MapOfObject Graphic3d_StructureManager::myRegisteredObjects
protected
Aspect_TypeOfUpdate Graphic3d_StructureManager::myUpdateMode
protected
Aspect_GenId Graphic3d_StructureManager::myViewGenId
protected

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