Open CASCADE Technology 6.6.0
Public Member Functions | Protected Member Functions | Protected Attributes
MeshVS_PrsBuilder Class Reference

This class is parent for all builders using in MeshVS_Mesh.
It provides base fields and methods all buildes need.

#include <MeshVS_PrsBuilder.hxx>

Inheritance diagram for MeshVS_PrsBuilder:
Inheritance graph
[legend]

Public Member Functions

virtual void Build (const Handle< Prs3d_Presentation > &Prs, const TColStd_PackedMapOfInteger &IDs, TColStd_PackedMapOfInteger &IDsToExclude, const Standard_Boolean IsElement, const Standard_Integer DisplayMode) const =0
 Builds presentation of certain type of data.
Prs is presentation object which this method constructs.
IDs is set of numeric identificators forming object appearance.
IDsToExclude is set of IDs to exclude from processing. If some entity
has been excluded, it is not processed by other builders.
IsElement indicates, IDs is identificators of nodes or elements.
DisplayMode is numeric constant describing display mode (see MeshVS_DisplayModeFlags.hxx)

virtual void CustomBuild (const Handle< Prs3d_Presentation > &Prs, const TColStd_PackedMapOfInteger &IDs, TColStd_PackedMapOfInteger &IDsToExclude, const Standard_Integer DisplayMode) const
 This method is called to build presentation of custom elements (they have MeshVS_ET_0D type).
IDs is set of numeric identificators of elements for custom building.
IDsToExclude is set of IDs to exclude from processing. If some entity
has been excluded, it is not processed by other builders.
DisplayMode is numeric constant describing display mode (see MeshVS_DisplayModeFlags.hxx)

virtual
Handle_SelectBasics_SensitiveEntity 
CustomSensitiveEntity (const Handle< SelectBasics_EntityOwner > &Owner, const Standard_Integer SelectMode) const
 This method is called to build sensitive of custom elements ( they have MeshVS_ET_0D type )

Standard_Integer GetFlags () const
 Returns flags, assigned with builder during creation

virtual Standard_Boolean TestFlags (const Standard_Integer DisplayMode) const
 Test whether display mode has flags assigned with this builder.
This method has default implementation and can be redefined for advance behavior
Returns Standard_True only if display mode is appropriate for this builder

Standard_Integer GetId () const
 Returns builder ID

Standard_Integer GetPriority () const
 Returns priority; as priority bigger, as soon builder will be called.

Handle_MeshVS_DataSource GetDataSource () const
 Returns custom data source or default ( from MeshVS_Mesh ) if custom is NULL

void SetDataSource (const Handle< MeshVS_DataSource > &newDS)
 Change custom data source

Handle_MeshVS_Drawer GetDrawer () const
 Returns custom drawer or default ( from MeshVS_Mesh ) if custom is NULL

void SetDrawer (const Handle< MeshVS_Drawer > &newDr)
 Change custom drawer

void SetExcluding (const Standard_Boolean state)
 Set excluding state. If it is Standard_True, the nodes or elements, processed by current builder
will be noted and next builder won't process its.

Standard_Boolean IsExcludingOn () const
 Read excluding state

void SetPresentationManager (const Handle< PrsMgr_PresentationManager3d > &thePrsMgr)
 Set presentation manager for builder

Handle_PrsMgr_PresentationManager3d GetPresentationManager () const
 Get presentation manager of builder

Protected Member Functions

 MeshVS_PrsBuilder (const Handle< MeshVS_Mesh > &Parent, const MeshVS_DisplayModeFlags &Flags, const Handle< MeshVS_DataSource > &DS, const Standard_Integer Id, const MeshVS_BuilderPriority &Priority=MeshVS_BP_Default)
 Constructor
Parent is pointer to MeshVS_Mesh object
Flags is set of display modes corresponding to this builder
DS is data source object, from which builder will pick geometry and topological information
Id is numeric identificator of builder. You must set it to positive integer, but if
you set it to -1, constructor will select the smallest integer, not occupied by other builders
Priority is numerical priority constant. As priority bigger, as sooner builder starts during
presentation construction

Handle_MeshVS_DataSource DataSource () const
 Returns only custom data source

Handle_MeshVS_Drawer Drawer () const
 Returns only custom drawer

Protected Attributes

MeshVS_MeshPtr myParentMesh

Constructor & Destructor Documentation

MeshVS_PrsBuilder::MeshVS_PrsBuilder ( const Handle< MeshVS_Mesh > &  Parent,
const MeshVS_DisplayModeFlags Flags,
const Handle< MeshVS_DataSource > &  DS,
const Standard_Integer  Id,
const MeshVS_BuilderPriority Priority = MeshVS_BP_Default 
) [protected]

Member Function Documentation

virtual void MeshVS_PrsBuilder::Build ( const Handle< Prs3d_Presentation > &  Prs,
const TColStd_PackedMapOfInteger IDs,
TColStd_PackedMapOfInteger IDsToExclude,
const Standard_Boolean  IsElement,
const Standard_Integer  DisplayMode 
) const [pure virtual]
virtual void MeshVS_PrsBuilder::CustomBuild ( const Handle< Prs3d_Presentation > &  Prs,
const TColStd_PackedMapOfInteger IDs,
TColStd_PackedMapOfInteger IDsToExclude,
const Standard_Integer  DisplayMode 
) const [virtual]
virtual Handle_SelectBasics_SensitiveEntity MeshVS_PrsBuilder::CustomSensitiveEntity ( const Handle< SelectBasics_EntityOwner > &  Owner,
const Standard_Integer  SelectMode 
) const [virtual]
Handle_MeshVS_DataSource MeshVS_PrsBuilder::DataSource ( ) const [protected]
Handle_MeshVS_Drawer MeshVS_PrsBuilder::Drawer ( ) const [protected]
Handle_MeshVS_DataSource MeshVS_PrsBuilder::GetDataSource ( ) const
Handle_MeshVS_Drawer MeshVS_PrsBuilder::GetDrawer ( ) const
Standard_Integer MeshVS_PrsBuilder::GetFlags ( ) const
Standard_Integer MeshVS_PrsBuilder::GetId ( ) const
Handle_PrsMgr_PresentationManager3d MeshVS_PrsBuilder::GetPresentationManager ( ) const
Standard_Integer MeshVS_PrsBuilder::GetPriority ( ) const
Standard_Boolean MeshVS_PrsBuilder::IsExcludingOn ( ) const
void MeshVS_PrsBuilder::SetDataSource ( const Handle< MeshVS_DataSource > &  newDS)
void MeshVS_PrsBuilder::SetDrawer ( const Handle< MeshVS_Drawer > &  newDr)
void MeshVS_PrsBuilder::SetExcluding ( const Standard_Boolean  state)
void MeshVS_PrsBuilder::SetPresentationManager ( const Handle< PrsMgr_PresentationManager3d > &  thePrsMgr)
virtual Standard_Boolean MeshVS_PrsBuilder::TestFlags ( const Standard_Integer  DisplayMode) const [virtual]

Field Documentation


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