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

Inheritance diagram for PrsMgr_PresentationManager3d:

[legend]

Public Member Functions
	PrsMgr_PresentationManager3d (const Handle< Graphic3d_StructureManager > &aStructureManager)
	Creates a framework to manage displays and graphic entities with the 3D view aStructureManager. More...

virtual Standard_Boolean	Is3D () const

void	Color (const Handle< PrsMgr_PresentableObject > &aPresentableObject, const Quantity_NameOfColor aColor=Quantity_NOC_YELLOW, const Standard_Integer aMode=0)
	Highlights the graphic object aPresentableObject in <br> the color aColor. aPresentableObject has the display mode aMode; this has the default value of 0, that is, the wireframe display mode. More...

void	BoundBox (const Handle< PrsMgr_PresentableObject > &aPresentableObject, const Standard_Integer aMode=0)
	highlights the boundbox of the presentation More...

void	BeginDraw ()
	initializes the list of Prs to be displayed in transient mode More...

void	AddToImmediateList (const Handle< Prs3d_Presentation > &aPrs)
	stores <aPrs> in a list of structure to be displayed in immediate mode. will be taken in account in EndDraw Method. More...

void	EndDraw (const Handle< V3d_View > &theView, const Standard_Boolean DoubleBuffer=Standard_False)
	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...

void	Connect (const Handle< PrsMgr_PresentableObject > &aPresentableObject, const Handle< PrsMgr_PresentableObject > &anOtherObject, const Standard_Integer aMode=0, const Standard_Integer anOtherMode=0)

void	Transform (const Handle< PrsMgr_PresentableObject > &aPresentableObject, const Handle< Geom_Transformation > &aTransformation, const Standard_Integer aMode=0)
	Sets the transformation aTransformation for the presentable object aPresentableObject. aPresentableObject has the display mode aMode; this has the default value of 0, that is, the wireframe display mode. More...

void	Place (const Handle< PrsMgr_PresentableObject > &aPresentableObject, const Quantity_Length X, const Quantity_Length Y, const Quantity_Length Z, const Standard_Integer aMode=0)
	Sets a position to move the presentable object aPresentableObject to. This position is defined by the lengths along the x, y and z axes: X, Y and Z respectively. aPresentableObject has the display mode aMode; this has the default value of 0, that is, the wireframe display mode. More...

void	Multiply (const Handle< PrsMgr_PresentableObject > &aPresentableObject, const Handle< Geom_Transformation > &aTransformation, const Standard_Integer aMode=0)
	Defines the transformation aTransformation for the presentable object aPresentableObject. aPresentableObject has the display mode aMode; this has the default value of 0, that is, the wireframe display mode. More...

void	Move (const Handle< PrsMgr_PresentableObject > &aPresentableObject, const Quantity_Length X, const Quantity_Length Y, const Quantity_Length Z, const Standard_Integer aMode=0)
	Sets a position to move the presentable object aPresentableObject to. This position is defined by the lengths along the x, y and z axes: X, Y and Z respectively. aPresentableObject has the display mode aMode; 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...

void	SetShadingAspect (const Handle< PrsMgr_PresentableObject > &aPresentableObject, const Quantity_NameOfColor aColor, const Graphic3d_NameOfMaterial aMaterial, const Standard_Integer aMode=0)
	this method will change the color and the aspect of the presentations containg shaded structures. More...

void	SetShadingAspect (const Handle< PrsMgr_PresentableObject > &aPresentableObject, const Handle< Prs3d_ShadingAspect > &aShadingAspect, const Standard_Integer aMode=0)
	this method will change the color and the aspect of the presentations containg shaded structures. More...

Handle_PrsMgr_Presentation3d	CastPresentation (const Handle< PrsMgr_PresentableObject > &aPresentableObject, const Standard_Integer aMode=0) const

Public Member Functions inherited from PrsMgr_PresentationManager
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...

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

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

Additional Inherited Members
Protected Member Functions inherited from PrsMgr_PresentationManager
	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 inherited from PrsMgr_PresentationManager
Standard_Boolean	myImmediateMode

TColStd_ListOfTransient	myImmediateList

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_PresentationManager3d::PrsMgr_PresentationManager3d ( const Handle< Graphic3d_StructureManager > & aStructureManager )

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

Member Function Documentation

void PrsMgr_PresentationManager3d::AddToImmediateList ( const Handle< Prs3d_Presentation > & aPrs )

stores <aPrs> in a list of structure to be displayed
in immediate mode. will be taken in account in EndDraw Method.

void PrsMgr_PresentationManager3d::BeginDraw ( )

virtual

initializes the list of Prs to be displayed in transient mode

Reimplemented from PrsMgr_PresentationManager.

void PrsMgr_PresentationManager3d::BoundBox	(	const Handle< PrsMgr_PresentableObject > &	aPresentableObject,
		const Standard_Integer	aMode = `0`
	)

highlights the boundbox of the presentation

Handle_PrsMgr_Presentation3d PrsMgr_PresentationManager3d::CastPresentation	(	const Handle< PrsMgr_PresentableObject > &	aPresentableObject,
		const Standard_Integer	aMode = `0`
	)		const

void PrsMgr_PresentationManager3d::Color	(	const Handle< PrsMgr_PresentableObject > &	aPresentableObject,
		const Quantity_NameOfColor	aColor = `Quantity_NOC_YELLOW`,
		const Standard_Integer	aMode = `0`
	)

 Highlights the graphic object aPresentableObject in <br>

the color aColor.
aPresentableObject has the display mode aMode;
this has the default value of 0, that is, the wireframe display mode.

void PrsMgr_PresentationManager3d::Connect	(	const Handle< PrsMgr_PresentableObject > &	aPresentableObject,
		const Handle< PrsMgr_PresentableObject > &	anOtherObject,
		const Standard_Integer	aMode = `0`,
		const Standard_Integer	anOtherMode = `0`
	)

void PrsMgr_PresentationManager3d::EndDraw	(	const Handle< V3d_View > &	aView,
		const Standard_Boolean	DoubleBuffer = `Standard_False`
	)

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.

Implements PrsMgr_PresentationManager.

virtual Standard_Boolean PrsMgr_PresentationManager3d::Is3D ( ) const

virtual

Implements PrsMgr_PresentationManager.

void PrsMgr_PresentationManager3d::Move	(	const Handle< PrsMgr_PresentableObject > &	aPresentableObject,
		const Quantity_Length	X,
		const Quantity_Length	Y,
		const Quantity_Length	Z,
		const Standard_Integer	aMode = `0`
	)

Sets a position to move the presentable object
aPresentableObject to. This position is defined by the
lengths along the x, y and z axes: X, Y and Z respectively.
aPresentableObject has the display mode aMode;
this has the default value of 0, that is, the wireframe
display mode.

void PrsMgr_PresentationManager3d::Multiply	(	const Handle< PrsMgr_PresentableObject > &	aPresentableObject,
		const Handle< Geom_Transformation > &	aTransformation,
		const Standard_Integer	aMode = `0`
	)

Defines the transformation aTransformation for the
presentable object aPresentableObject.
aPresentableObject has the display mode aMode;
this has the default value of 0, that is, the wireframe
display mode.

void PrsMgr_PresentationManager3d::Place	(	const Handle< PrsMgr_PresentableObject > &	aPresentableObject,
		const Quantity_Length	X,
		const Quantity_Length	Y,
		const Quantity_Length	Z,
		const Standard_Integer	aMode = `0`
	)

Sets a position to move the presentable object
aPresentableObject to. This position is defined by the
lengths along the x, y and z axes: X, Y and Z respectively.
aPresentableObject has the display mode aMode;
this has the default value of 0, that is, the wireframe display mode.

void PrsMgr_PresentationManager3d::SetShadingAspect	(	const Handle< PrsMgr_PresentableObject > &	aPresentableObject,
		const Quantity_NameOfColor	aColor,
		const Graphic3d_NameOfMaterial	aMaterial,
		const Standard_Integer	aMode = `0`
	)

this method will change the color and the aspect
of the presentations containg shaded structures.

void PrsMgr_PresentationManager3d::SetShadingAspect	(	const Handle< PrsMgr_PresentableObject > &	aPresentableObject,
		const Handle< Prs3d_ShadingAspect > &	aShadingAspect,
		const Standard_Integer	aMode = `0`
	)

this method will change the color and the aspect
of the presentations containg shaded structures.

const Handle_Graphic3d_StructureManager& PrsMgr_PresentationManager3d::StructureManager ( ) const

Returns the structure manager.

void PrsMgr_PresentationManager3d::Transform	(	const Handle< PrsMgr_PresentableObject > &	aPresentableObject,
		const Handle< Geom_Transformation > &	aTransformation,
		const Standard_Integer	aMode = `0`
	)

Sets the transformation aTransformation for the
presentable object aPresentableObject.
aPresentableObject has the display mode aMode;
this has the default value of 0, that is, the wireframe
display mode.

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

PrsMgr_PresentationManager3d.hxx

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation