Open CASCADE Technology 6.6.0
Public Member Functions | Static 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, Detectable

#include <Graphic3d_StructureManager.hxx>

Inheritance diagram for Graphic3d_StructureManager:
Inheritance graph
[legend]

Public Member Functions

virtual void Destroy ()
 Deletes the manager <me>.

 ~Graphic3d_StructureManager ()
void SetPrimitivesAspect (const Handle< Graphic3d_AspectLine3d > &CTX)
 Modifies the default attributes for lines
in the visualiser.

void SetPrimitivesAspect (const Handle< Graphic3d_AspectFillArea3d > &CTX)
 Modifies the default attributes for faces
in the visualiser.

void SetPrimitivesAspect (const Handle< Graphic3d_AspectText3d > &CTX)
 Modifies the default attributes for text
in the visualiser.

void SetPrimitivesAspect (const Handle< Graphic3d_AspectMarker3d > &CTX)
 Modifies the default attributes for markers
in the visualiser.

void SetUpdateMode (const Aspect_TypeOfUpdate AType)
 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:

virtual void Update () const =0
 Updates screen in function of modifications of
the structures.
Warning: Not necessary if the update mode is TOU_ASAP.

void DisplayedStructures (Graphic3d_MapOfStructure &SG) const
 Returns the set of structures displayed in
visualiser <me>.

void HighlightedStructures (Graphic3d_MapOfStructure &SG) const
 Returns the set of highlighted structures
in a visualiser <me>.

void PickStructures (Graphic3d_MapOfStructure &SG) const
 Returns the set of detectable structures
in a visualiser <me>.

void VisibleStructures (Graphic3d_MapOfStructure &SG) const
 Returns the set of visible structures
in a visualiser <me>.

Handle_Graphic3d_AspectFillArea3d FillArea3dAspect () const
 Returns the values of the current default attributes.

Handle_Graphic3d_AspectLine3d Line3dAspect () const
 Returns the values of the current default attributes.

Handle_Graphic3d_AspectMarker3d Marker3dAspect () const
 Returns the values of the current default attributes.

void MinMaxValues (Standard_Real &XMin, Standard_Real &YMin, Standard_Real &ZMin, Standard_Real &XMax, Standard_Real &YMax, Standard_Real &ZMax) const
 Returns the coordinates of the boundary box of all
structures displayed in the manager <me>.

void PrimitivesAspect (Handle< Graphic3d_AspectLine3d > &CTXL, Handle< Graphic3d_AspectText3d > &CTXT, Handle< Graphic3d_AspectMarker3d > &CTXM, Handle< Graphic3d_AspectFillArea3d > &CTXF) const
 Returns the values of the current default attributes.

Handle_Graphic3d_AspectText3d Text3dAspect () const
 Returns the values of the current default attributes.

Aspect_TypeOfUpdate UpdateMode () const
 Returns the screen update mode.

TOU_ASAP as soon as possible
TOU_WAIT on demand (Update)


virtual void ChangeDisplayPriority (const Handle< Graphic3d_Structure > &AStructure, const Standard_Integer OldPriority, const Standard_Integer NewPriority)=0
 Changes the display priority of the structure <AStructure>.

virtual void ChangeZLayer (const Handle< Graphic3d_Structure > &theStructure, const Standard_Integer theLayerId)=0
 Change Z layer for structure. The z layer mechanism allows
to display structures in higher layers in overlay of structures in
lower layers.

virtual Standard_Integer GetZLayer (const Handle< Graphic3d_Structure > &theStructure) const =0
 Get Z layer ID assigned to structure. If the structure
has no layer ID (deleted from graphic driver), the method returns -1.

virtual Standard_Boolean AddZLayer (Standard_Integer &theLayerId)=0
 Add a new top-level Z layer and get its ID as
<theLayerId> value. The method returns Standard_False if the layer
can not be created. The z layer mechanism allows to display
structures in higher layers in overlay of structures in lower layers.

virtual Standard_Boolean RemoveZLayer (const Standard_Integer theLayerId)=0
 Remove Z layer with ID <theLayerId>. Method returns
Standard_False if the layer can not be removed or doesn't exists.
By default, there is always a default bottom-level layer that can't
be removed.

virtual void GetAllZLayers (TColStd_SequenceOfInteger &theLayerSeq) const =0
 Return all Z layer ids in sequence ordered by level
from lowest layer to highest. The first layer ID in sequence is
the default layer that can't be removed.

virtual void ReCompute (const Handle< Graphic3d_Structure > &AStructure)=0
 Forces a new construction of the structure <AStructure>
if <AStructure> is displayed and TOS_COMPUTED.

virtual void ReCompute (const Handle< Graphic3d_Structure > &AStructure, const Handle< Graphic3d_DataStructureManager > &AProjector)=0
 Forces a new construction of the structure <AStructure>
if <AStructure> is displayed in <AProjector> and TOS_COMPUTED.

virtual void Clear (const Handle< Graphic3d_Structure > &AStructure, const Standard_Boolean WithDestruction)=0
 Clears the structure <AStructure>.

virtual void Connect (const Handle< Graphic3d_Structure > &AMother, const Handle< Graphic3d_Structure > &ADaughter)=0
 Connects the structures <AMother> and <ADaughter>.

virtual void Disconnect (const Handle< Graphic3d_Structure > &AMother, const Handle< Graphic3d_Structure > &ADaughter)=0
 Disconnects the structures <AMother> and <ADaughter>.

virtual void Display (const Handle< Graphic3d_Structure > &AStructure)=0
 Display the structure <AStructure>.

virtual void Erase (const Handle< Graphic3d_Structure > &AStructure)=0
 Erases the structure <AStructure>.

virtual void Highlight (const Handle< Graphic3d_Structure > &AStructure, const Aspect_TypeOfHighlightMethod AMethod)=0
 Highlights the structure <AStructure>.

virtual void SetTransform (const Handle< Graphic3d_Structure > &AStructure, const TColStd_Array2OfReal &ATrsf)=0
 Transforms the structure <AStructure>.

const
Handle_Graphic3d_GraphicDriver & 
GraphicDriver () const
 Returns the graphic driver of <me>.

virtual Standard_Integer Identification () const
 Returns the identification number of the manager.

virtual Handle_Graphic3d_Structure Identification (const Standard_Integer AId) const
 Returns the structure with the identification number <AId>.

virtual void UnHighlight ()=0
 Suppresses the highlighting on all the structures in <me>.

virtual void UnHighlight (const Handle< Graphic3d_Structure > &AStructure)=0
 Suppress the highlighting on the structure <AStructure>.

Static Public Member Functions

static Standard_Integer Limit ()
 Returns maximum number of managers defineable.

static Standard_Integer CurrentId ()
 Returns a current identifier available.

Protected Member Functions

 Graphic3d_StructureManager (const Handle< Graphic3d_GraphicDriver > &theDriver)
 Initialises the ViewManager.
Currently creating of more than 100 viewer instances
is not supported and leads to InitializationError and
initialisation failure.
This limitation might be addressed in some future OCCT releases.
Warning: Raises InitialisationError if the initialisation
of the ViewManager failed.

Standard_Integer NumberOfDisplayedStructures () const
 Returns the number of structures displayed in
visualiser <me>.
//! Returns the structure displayed in visualiser <me>.

Protected Attributes

Standard_Integer MyId
Aspect_TypeOfUpdate MyUpdateMode
Handle_Graphic3d_AspectLine3d MyAspectLine3d
Handle_Graphic3d_AspectText3d MyAspectText3d
Handle_Graphic3d_AspectMarker3d MyAspectMarker3d
Handle_Graphic3d_AspectFillArea3d MyAspectFillArea3d
Graphic3d_MapOfStructure MyDisplayedStructure
Graphic3d_MapOfStructure MyHighlightedStructure
Graphic3d_MapOfStructure MyVisibleStructure
Graphic3d_MapOfStructure MyPickStructure
Aspect_GenId MyStructGenId
Handle_Graphic3d_GraphicDriver MyGraphicDriver

Constructor & Destructor Documentation

Graphic3d_StructureManager::~Graphic3d_StructureManager ( ) [inline]
Graphic3d_StructureManager::Graphic3d_StructureManager ( const Handle< Graphic3d_GraphicDriver > &  theDriver) [protected]

Member Function Documentation

virtual Standard_Boolean Graphic3d_StructureManager::AddZLayer ( Standard_Integer theLayerId) [pure virtual]

Implemented in Visual3d_ViewManager.

virtual void Graphic3d_StructureManager::ChangeDisplayPriority ( const Handle< Graphic3d_Structure > &  AStructure,
const Standard_Integer  OldPriority,
const Standard_Integer  NewPriority 
) [pure virtual]

Implemented in Visual3d_ViewManager.

virtual void Graphic3d_StructureManager::ChangeZLayer ( const Handle< Graphic3d_Structure > &  theStructure,
const Standard_Integer  theLayerId 
) [pure virtual]

Implemented in Visual3d_ViewManager.

virtual void Graphic3d_StructureManager::Clear ( const Handle< Graphic3d_Structure > &  AStructure,
const Standard_Boolean  WithDestruction 
) [pure virtual]

Implemented in Visual3d_ViewManager.

virtual void Graphic3d_StructureManager::Connect ( const Handle< Graphic3d_Structure > &  AMother,
const Handle< Graphic3d_Structure > &  ADaughter 
) [pure virtual]

Implemented in Visual3d_ViewManager.

static Standard_Integer Graphic3d_StructureManager::CurrentId ( ) [static]
virtual void Graphic3d_StructureManager::Destroy ( ) [virtual]

Reimplemented in Visual3d_ViewManager.

virtual void Graphic3d_StructureManager::Disconnect ( const Handle< Graphic3d_Structure > &  AMother,
const Handle< Graphic3d_Structure > &  ADaughter 
) [pure virtual]

Implemented in Visual3d_ViewManager.

virtual void Graphic3d_StructureManager::Display ( const Handle< Graphic3d_Structure > &  AStructure) [pure virtual]

Implemented in Visual3d_ViewManager.

void Graphic3d_StructureManager::DisplayedStructures ( Graphic3d_MapOfStructure SG) const
virtual void Graphic3d_StructureManager::Erase ( const Handle< Graphic3d_Structure > &  AStructure) [pure virtual]

Implemented in Visual3d_ViewManager.

Handle_Graphic3d_AspectFillArea3d Graphic3d_StructureManager::FillArea3dAspect ( ) const
virtual void Graphic3d_StructureManager::GetAllZLayers ( TColStd_SequenceOfInteger theLayerSeq) const [pure virtual]

Implemented in Visual3d_ViewManager.

virtual Standard_Integer Graphic3d_StructureManager::GetZLayer ( const Handle< Graphic3d_Structure > &  theStructure) const [pure virtual]

Implemented in Visual3d_ViewManager.

const Handle_Graphic3d_GraphicDriver& Graphic3d_StructureManager::GraphicDriver ( ) const
virtual void Graphic3d_StructureManager::Highlight ( const Handle< Graphic3d_Structure > &  AStructure,
const Aspect_TypeOfHighlightMethod  AMethod 
) [pure virtual]

Implemented in Visual3d_ViewManager.

void Graphic3d_StructureManager::HighlightedStructures ( Graphic3d_MapOfStructure SG) const
virtual Standard_Integer Graphic3d_StructureManager::Identification ( ) const [virtual]

Reimplemented in Visual3d_ViewManager.

virtual Handle_Graphic3d_Structure Graphic3d_StructureManager::Identification ( const Standard_Integer  AId) const [virtual]

Reimplemented in Visual3d_ViewManager.

static Standard_Integer Graphic3d_StructureManager::Limit ( ) [static]
Handle_Graphic3d_AspectLine3d Graphic3d_StructureManager::Line3dAspect ( ) const
Handle_Graphic3d_AspectMarker3d Graphic3d_StructureManager::Marker3dAspect ( ) const
void Graphic3d_StructureManager::MinMaxValues ( Standard_Real XMin,
Standard_Real YMin,
Standard_Real ZMin,
Standard_Real XMax,
Standard_Real YMax,
Standard_Real ZMax 
) const
Standard_Integer Graphic3d_StructureManager::NumberOfDisplayedStructures ( ) const [protected]
void Graphic3d_StructureManager::PickStructures ( Graphic3d_MapOfStructure SG) const
void Graphic3d_StructureManager::PrimitivesAspect ( Handle< Graphic3d_AspectLine3d > &  CTXL,
Handle< Graphic3d_AspectText3d > &  CTXT,
Handle< Graphic3d_AspectMarker3d > &  CTXM,
Handle< Graphic3d_AspectFillArea3d > &  CTXF 
) const
virtual void Graphic3d_StructureManager::ReCompute ( const Handle< Graphic3d_Structure > &  AStructure) [pure virtual]

Implemented in Visual3d_ViewManager.

virtual void Graphic3d_StructureManager::ReCompute ( const Handle< Graphic3d_Structure > &  AStructure,
const Handle< Graphic3d_DataStructureManager > &  AProjector 
) [pure virtual]

Implemented in Visual3d_ViewManager.

virtual Standard_Boolean Graphic3d_StructureManager::RemoveZLayer ( const Standard_Integer  theLayerId) [pure virtual]

Implemented in Visual3d_ViewManager.

void Graphic3d_StructureManager::SetPrimitivesAspect ( const Handle< Graphic3d_AspectLine3d > &  CTX)
void Graphic3d_StructureManager::SetPrimitivesAspect ( const Handle< Graphic3d_AspectMarker3d > &  CTX)
void Graphic3d_StructureManager::SetPrimitivesAspect ( const Handle< Graphic3d_AspectText3d > &  CTX)
void Graphic3d_StructureManager::SetPrimitivesAspect ( const Handle< Graphic3d_AspectFillArea3d > &  CTX)
virtual void Graphic3d_StructureManager::SetTransform ( const Handle< Graphic3d_Structure > &  AStructure,
const TColStd_Array2OfReal ATrsf 
) [pure virtual]

Implemented in Visual3d_ViewManager.

void Graphic3d_StructureManager::SetUpdateMode ( const Aspect_TypeOfUpdate  AType)
Handle_Graphic3d_AspectText3d Graphic3d_StructureManager::Text3dAspect ( ) const
virtual void Graphic3d_StructureManager::UnHighlight ( const Handle< Graphic3d_Structure > &  AStructure) [pure virtual]

Implemented in Visual3d_ViewManager.

virtual void Graphic3d_StructureManager::UnHighlight ( ) [pure virtual]

Implemented in Visual3d_ViewManager.

virtual void Graphic3d_StructureManager::Update ( ) const [pure virtual]

Implemented in Visual3d_ViewManager.

Aspect_TypeOfUpdate Graphic3d_StructureManager::UpdateMode ( ) const
void Graphic3d_StructureManager::VisibleStructures ( Graphic3d_MapOfStructure SG) const

Field Documentation

Handle_Graphic3d_AspectFillArea3d Graphic3d_StructureManager::MyAspectFillArea3d [protected]
Handle_Graphic3d_AspectLine3d Graphic3d_StructureManager::MyAspectLine3d [protected]
Handle_Graphic3d_AspectMarker3d Graphic3d_StructureManager::MyAspectMarker3d [protected]
Handle_Graphic3d_AspectText3d Graphic3d_StructureManager::MyAspectText3d [protected]
Handle_Graphic3d_GraphicDriver Graphic3d_StructureManager::MyGraphicDriver [protected]

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