This class allows the definition of a manager to
which the views are associated.
It allows them to be globally manipulated.
It activates the pick.
More...

#include <Visual3d_ViewManager.hxx>

Inheritance diagram for Visual3d_ViewManager:

[legend]

Public Member Functions
	Visual3d_ViewManager (const Handle< Graphic3d_GraphicDriver > &theDriver)
	Creates a 3D visualizer. <br> 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. Category: Methods to modify the class definition More...

void	Activate ()
	Activates all the views of the manager <me>. More...

void	Deactivate ()
	Deactivates all the views of the manager <me>. More...

virtual void	Destroy ()
	Deletes and erases the 3D visualiser <me>. More...

	~Visual3d_ViewManager ()

void	Erase ()
	Erases all of the structures displayed in the visualiser <me>. More...

void	Redraw () const
	Redraws all the displayed structures. More...

void	Remove ()
	Deletes and erases the 3D visualiser <me>. More...

void	Update () const
	Updates screen in function of modifications of <br> the structures. <br> Category: Methods to modify the class definition Warning: Not necessary if the update mode is TOU_ASAP. More...

Handle_Visual3d_HSetOfView	ActivatedView () const
	Returns the group of views activated in the visualiser <me>. More...

void	ConvertCoord (const Handle< Aspect_Window > &AWindow, const Graphic3d_Vertex &AVertex, Standard_Integer &AU, Standard_Integer &AV) const
	Applies the view orientation transformation, the <br> view mapping transformation and view clip, the <br> display transformation to the vertex <AVertex>. <br> Returns the pixel coordinates <AU>, <AV>. <br> Warning: Returns <AU> = <AV> = IntegerLast () if the evaluation is impossible. – Bad Window, Numeric error... More...

Graphic3d_Vertex	ConvertCoord (const Handle< Aspect_Window > &AWindow, const Standard_Integer AU, const Standard_Integer AV) const
	Applies the inverse of the display transformation, the <br> inverse of the view mapping transformation and view clip, <br> the inverse of the view orientation transformation to <br> the pixel coordinates <AU>, <AV>. <br> Returns the world coordinates <AVertex>. <br> Warning: Returns AVertex (X, Y, Z) with X = Y = Z = RealLast () if the evaluation is impossible. – Bad Window, Numeric error... More...

void	ConvertCoordWithProj (const Handle< Aspect_Window > &AWindow, const Standard_Integer AU, const Standard_Integer AV, Graphic3d_Vertex &Point, Graphic3d_Vector &Proj) const
	Applies the inverse of the display transformation, the <br> inverse of the view mapping transformation and view clip, <br> the inverse of the view orientation transformation to <br> the pixel coordinates <AU>, <AV>. <br> Returns the world coordinates <AVertex> and projection ray <AVector>. <br> Warning: Returns AVertex (X, Y, Z) with X = Y = Z = RealLast () and AVector (VX, VY, VZ) with VX = VY = VZ = 0. if the evaluation is impossible. – Bad Window, Numeric error... More...

Handle_Visual3d_HSetOfView	DefinedView () const
	Returns the group of views defined in the visualiser <me>. More...

Standard_Integer	MaxNumOfViews () const
	Returns the theoretical maximum number of <br> definable views in the view manager <me>. <br> Warning: It's not possible to accept an infinite number of definable views because each view must have an identification and we have different view managers. More...

Standard_Integer	Identification (const Handle< Visual3d_View > &AView)
	Returns : a new identification number for a new view in the visualiser. More...

void	UnIdentification (const Standard_Integer aViewId)
	Release a unique ID of the view reserved for the view on its creation. More...

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

Standard_Integer	Identification () const
	Returns the identification number of the visualiser. More...

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

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

Standard_Integer	GetZLayer (const Handle< Graphic3d_Structure > &theStructure) const
	Get Z layer ID assigned for the structure. More...

void	SetZLayerSettings (const Standard_Integer theLayerId, const Graphic3d_ZLayerSettings theSettings)
	Sets the settings for a single Z layer for all managed views. More...

Graphic3d_ZLayerSettings	ZLayerSettings (const Standard_Integer theLayerId)
	Returns the settings of a single Z layer. More...

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

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

void	GetAllZLayers (TColStd_SequenceOfInteger &theLayerSeq) const
	Return all Z layer ids in sequence ordered by overlay level <br> from lowest layer to highest ( foreground ). The first layer ID in sequence is the default layer that can't be removed. More...

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

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

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

void	Display (const Handle< Graphic3d_Structure > &AStructure)
	Display of the structure <AStructure>. More...

void	Erase (const Handle< Graphic3d_Structure > &AStructure)
	Erases the structure <AStructure>. More...

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

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

void	UnHighlight ()
	Suppress the highlighting on all the structures. More...

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

Standard_Boolean	ViewExists (const Handle< Aspect_Window > &AWindow, Graphic3d_CView &TheCView) const
	Returns Standard_True if the view associated to the window <AWindow> exists and is activated. <TheViewId> contains the internal identification of the associated view. More...

const Handle_Visual3d_Layer &	UnderLayer () const
	Returns the underlay of the viewer <me>. More...

const Handle_Visual3d_Layer &	OverLayer () const
	Returns the underlay of the viewer <me>. More...

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

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

Standard_Boolean	Transparency () const
	Returns Standard_True if the transparency is activated in all activated views. Default Standard_False More...

void	SetTransparency (const Standard_Boolean AFlag)
	if <AFlag> is Standard_True then the transparency is managed. Default Standard_False More...

Standard_Boolean	ZBufferAuto () const
	Returns Standard_True if the zbuffer activity is managed automatically. Default Standard_False More...

void	SetZBufferAuto (const Standard_Boolean AFlag)
	if <AFlag> is Standard_True then the zbuffer activity is managed automatically. Default Standard_False More...

Public Member Functions inherited from Graphic3d_StructureManager
	~Graphic3d_StructureManager ()

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

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

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

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

void	SetUpdateMode (const Aspect_TypeOfUpdate AType)
	Modifies the screen update mode. <br> 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: 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...

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

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

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

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

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

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

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

Aspect_TypeOfUpdate	UpdateMode () const
	Returns the screen update mode. <br> TOU_ASAP as soon as possible TOU_WAIT on demand (Update) More...

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

void	RecomputeStructures ()

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

Static Protected Member Functions
static Aspect_GenId &	getZLayerGenId ()
	Returns global instance of z layer ids generator. More...

Additional Inherited Members
Static Public Member Functions inherited from Graphic3d_StructureManager
static Standard_Integer	Limit ()
	Returns maximum number of managers defineable. More...

static Standard_Integer	CurrentId ()
	Returns a current identifier available. More...

Protected Member Functions inherited from Graphic3d_StructureManager
	Graphic3d_StructureManager (const Handle< Graphic3d_GraphicDriver > &theDriver)
	Initialises the ViewManager. <br> 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. More...

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

Protected Attributes inherited from Graphic3d_StructureManager
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	MyPickStructure

Aspect_GenId	MyStructGenId

Handle_Graphic3d_GraphicDriver	MyGraphicDriver

Detailed Description

This class allows the definition of a manager to
which the views are associated.
It allows them to be globally manipulated.
It activates the pick.

Constructor & Destructor Documentation

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

 Creates a 3D visualizer. <br>

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.

Category: Methods to modify the class definition

Visual3d_ViewManager::~Visual3d_ViewManager ( )

inline

Member Function Documentation

void Visual3d_ViewManager::Activate ( )

Activates all the views of the manager <me>.

Handle_Visual3d_HSetOfView Visual3d_ViewManager::ActivatedView ( ) const

Returns the group of views activated in the visualiser <me>.

Standard_Boolean Visual3d_ViewManager::AddZLayer ( Standard_Integer & theLayerId )

virtual

 Add a new top-level Z layer and get its ID as <br>

<theLayerId> value. The method returns Standard_False if the layer
can not be created. The layer mechanism allows to display
structures in higher layers in overlay of structures in lower layers.

void Visual3d_ViewManager::ConvertCoord	(	const Handle< Aspect_Window > &	AWindow,
		const Graphic3d_Vertex &	AVertex,
		Standard_Integer &	AU,
		Standard_Integer &	AV
	)		const

Graphic3d_Vertex Visual3d_ViewManager::ConvertCoord	(	const Handle< Aspect_Window > &	AWindow,
		const Standard_Integer	AU,
		const Standard_Integer	AV
	)		const

void Visual3d_ViewManager::ConvertCoordWithProj	(	const Handle< Aspect_Window > &	AWindow,
		const Standard_Integer	AU,
		const Standard_Integer	AV,
		Graphic3d_Vertex &	Point,
		Graphic3d_Vector &	Proj
	)		const

Standard_Boolean Visual3d_ViewManager::ViewExists	(	const Handle< Aspect_Window > &	AWindow,
		Graphic3d_CView &	TheCView
	)		const

Public Member Functions

Static Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation