OCC Main Page | Visualization | Toolkits | Packages | Class Hierarchy | Data Structures | File List | Data Fields | Globals

Visualization
TKMeshVS
MeshVS


MeshVS_Mesh Class Reference

the main class provides interface to create mesh presentation as a whole

#include <MeshVS_Mesh.hxx>

Inheritance diagram for MeshVS_Mesh:

Inheritance graph
[legend]

Public Member Functions

Standard_EXPORT MeshVS_Mesh (const Standard_Boolean theIsAllowOverlapped=Standard_False)
 Constructor.
theIsAllowOverlapped is Standard_True, if it is allowed to draw edges overlapped with beams
Its value is stored in drawer
.
virtual Standard_EXPORT void Destroy ()
 ~MeshVS_Mesh ()
virtual Standard_EXPORT void Compute (const Handle(PrsMgr_PresentationManager3d)&PM, const Handle(Prs3d_Presentation)&Prs, const Standard_Integer DisplayMode)
 Computes presentation using builders added to sequence. Each builder computes
own part of mesh presentation according to its type.
.
virtual Standard_EXPORT void ComputeSelection (const Handle(SelectMgr_Selection)&Sel, const Standard_Integer SelectMode)
 Computes selection according to SelectMode
.
virtual Standard_EXPORT void HilightSelected (const Handle(PrsMgr_PresentationManager3d)&PM, const SelectMgr_SequenceOfOwner &Owners)
 Draw selected owners presentation
.
virtual Standard_EXPORT void HilightOwnerWithColor (const Handle(PrsMgr_PresentationManager3d)&PM, const Quantity_NameOfColor Color, const Handle(SelectMgr_EntityOwner)&Owner)
 Draw hilighted owner presentation
.
virtual Standard_EXPORT void ClearSelected ()
 Clears internal selection presentation
.
Standard_EXPORT Standard_Integer GetBuildersCount () const
 How many builders there are in sequence
.
Standard_EXPORT Handle_MeshVS_PrsBuilder GetBuilder (const Standard_Integer Index) const
 Returns builder by its index in sequence
.
Standard_EXPORT Handle_MeshVS_PrsBuilder GetBuilderById (const Standard_Integer Id) const
 Returns builder by its ID
.
Standard_EXPORT Standard_Integer GetFreeId () const
 Returns the smallest positive ID, not occupied by any builder.
This method using when builder is created with ID = -1
.
Standard_EXPORT void AddBuilder (const Handle(MeshVS_PrsBuilder)&Builder, const Standard_Boolean TreatAsHilighter=Standard_False)
 Adds builder to tale of sequence.
PrsBuilder is builder to be added
If TreatAsHilighter is true, MeshVS_Mesh will use this builder to create
presentation of hilighted and selected owners.
Only one builder can be hilighter, so that if you call this method with
TreatAsHilighter = Standard_True some times, only last builder will be hilighter
WARNING: As minimum one builder must be added as hilighter, otherwise selection cannot be computed
.
Standard_EXPORT void SetHilighter (const Handle(MeshVS_PrsBuilder)&Builder)
 Changes hilighter ( see above )
.
Standard_EXPORT Standard_Boolean SetHilighter (const Standard_Integer Index)
 Sets builder with sequence index "Index" as hilighter
.
Standard_EXPORT Standard_Boolean SetHilighterById (const Standard_Integer Id)
 Sets builder with identificator "Id" as hilighter
.
Standard_EXPORT Handle_MeshVS_PrsBuilder GetHilighter () const
 Returns hilighter
.
Standard_EXPORT void RemoveBuilder (const Standard_Integer Index)
 Removes builder from sequence. If it is hilighter, hilighter will be NULL
( Don't remember to set it to other after!!! )
.
Standard_EXPORT void RemoveBuilderById (const Standard_Integer Id)
 Removes builder with identificator Id
.
Standard_EXPORT Handle_MeshVS_PrsBuilder FindBuilder (const Standard_CString TypeString) const
 Finds builder by its type the string represents
.
Standard_EXPORT const MeshVS_DataMapOfIntegerOwnerGetOwnerMaps (const Standard_Boolean IsElement)
 Returns map of owners.
.
Standard_EXPORT Handle_MeshVS_DataSource GetDataSource () const
 Returns default builders' data source
.
Standard_EXPORT void SetDataSource (const Handle(MeshVS_DataSource)&aDataSource)
 Sets default builders' data source
.
Standard_EXPORT Handle_MeshVS_Drawer GetDrawer () const
 Returns default builders' drawer
.
Standard_EXPORT void SetDrawer (const Handle(MeshVS_Drawer)&aDrawer)
 Sets default builders' drawer
.
Standard_EXPORT Standard_Boolean IsHiddenElem (const Standard_Integer ID) const
 Returns True if specified element is hidden
By default no elements are hidden
.
Standard_EXPORT Standard_Boolean IsHiddenNode (const Standard_Integer ID) const
 Returns True if specified node is hidden.
By default all nodes are hidden
.
Standard_EXPORT Standard_Boolean IsSelectableElem (const Standard_Integer ID) const
 Returns True if specified element is not hidden
.
Standard_EXPORT Standard_Boolean IsSelectableNode (const Standard_Integer ID) const
 Returns True if specified node is specified as selectable.
.
Standard_EXPORT const Handle_TColStd_HPackedMapOfInteger & GetHiddenNodes () const
 Returns map of hidden nodes (may be null handle)
.
Standard_EXPORT void SetHiddenNodes (const Handle(TColStd_HPackedMapOfInteger)&Ids)
 Sets map of hidden nodes, which shall not be displayed individually.
If nodes shared by some elements shall not be drawn,
they should be included into that map
.
Standard_EXPORT const Handle_TColStd_HPackedMapOfInteger & GetHiddenElems () const
 Returns map of hidden elements (may be null handle)
.
Standard_EXPORT void SetHiddenElems (const Handle(TColStd_HPackedMapOfInteger)&Ids)
 Sets map of hidden elements
.
Standard_EXPORT const Handle_TColStd_HPackedMapOfInteger & GetSelectableNodes () const
 Returns map of selectable elements (may be null handle)
.
Standard_EXPORT void SetSelectableNodes (const Handle(TColStd_HPackedMapOfInteger)&Ids)
 Sets map of selectable nodes.
.
Standard_EXPORT void UpdateSelectableNodes ()
 Automatically computes selectable nodes; the node is considered
as being selectable if it is either not hidden, or is hidden
but referred by at least one non-hidden element.
Thus all nodes that are visible (either individually, or as ends or
corners of elements) are selectable by default.
.
Standard_EXPORT MeshVS_MeshSelectionMethod GetMeshSelMethod () const
 Returns set mesh selection method (see MeshVS.cdl)
.
Standard_EXPORT void SetMeshSelMethod (const MeshVS_MeshSelectionMethod M)
 Sets mesh selection method (see MeshVS.cdl)
.
virtual Standard_EXPORT Standard_Boolean IsWholeMeshOwner (const Handle(SelectMgr_EntityOwner)&theOwner) const
 Returns True if the given owner represents a whole mesh.
.
Standard_EXPORT const Handle (Standard_Type)&DynamicType() const

Protected Attributes

MeshVS_DataMapOfIntegerOwner myNodeOwners
MeshVS_DataMapOfIntegerOwner myElementOwners
MeshVS_DataMapOfIntegerOwner my0DOwners
MeshVS_DataMapOfIntegerOwner myLinkOwners
MeshVS_DataMapOfIntegerOwner myFaceOwners
MeshVS_DataMapOfIntegerOwner myVolumeOwners
MeshVS_DataMapOfIntegerOwner myGroupOwners
MeshVS_DataMapOfIntegerOwner myMeshOwners
Handle_MeshVS_Drawer myCurrentDrawer
Handle_MeshVS_Drawer mySelectionDrawer
Handle_MeshVS_Drawer myHilightDrawer
Handle_SelectMgr_EntityOwner myWholeMeshOwner

Private Attributes

MeshVS_SequenceOfPrsBuilder myBuilders
Handle_MeshVS_PrsBuilder myHilighter
Handle_TColStd_HPackedMapOfInteger myHiddenElements
Handle_TColStd_HPackedMapOfInteger myHiddenNodes
Handle_TColStd_HPackedMapOfInteger mySelectableNodes
Handle_MeshVS_DataSource myDataSource
MeshVS_MeshSelectionMethod mySelectionMethod

Constructor & Destructor Documentation

Standard_EXPORT MeshVS_Mesh::MeshVS_Mesh const Standard_Boolean  theIsAllowOverlapped = Standard_False  ) 
 

MeshVS_Mesh::~MeshVS_Mesh  )  [inline]
 


Member Function Documentation

Standard_EXPORT void MeshVS_Mesh::AddBuilder const Handle(MeshVS_PrsBuilder)&  Builder,
const Standard_Boolean  TreatAsHilighter = Standard_False
 

virtual Standard_EXPORT void MeshVS_Mesh::ClearSelected  )  [virtual]
 

Reimplemented from SelectMgr_SelectableObject.

virtual Standard_EXPORT void MeshVS_Mesh::Compute const Handle(PrsMgr_PresentationManager3d)&  PM,
const Handle(Prs3d_Presentation)&  Prs,
const Standard_Integer  DisplayMode
[virtual]
 

Reimplemented from PrsMgr_PresentableObject.

virtual Standard_EXPORT void MeshVS_Mesh::ComputeSelection const Handle(SelectMgr_Selection)&  Sel,
const Standard_Integer  SelectMode
[virtual]
 

Implements SelectMgr_SelectableObject.

virtual Standard_EXPORT void MeshVS_Mesh::Destroy  )  [virtual]
 

Standard_EXPORT Handle_MeshVS_PrsBuilder MeshVS_Mesh::FindBuilder const Standard_CString  TypeString  )  const
 

Standard_EXPORT Handle_MeshVS_PrsBuilder MeshVS_Mesh::GetBuilder const Standard_Integer  Index  )  const
 

Standard_EXPORT Handle_MeshVS_PrsBuilder MeshVS_Mesh::GetBuilderById const Standard_Integer  Id  )  const
 

Standard_EXPORT Standard_Integer MeshVS_Mesh::GetBuildersCount  )  const
 

Standard_EXPORT Handle_MeshVS_DataSource MeshVS_Mesh::GetDataSource  )  const
 

Standard_EXPORT Handle_MeshVS_Drawer MeshVS_Mesh::GetDrawer  )  const
 

Standard_EXPORT Standard_Integer MeshVS_Mesh::GetFreeId  )  const
 

Standard_EXPORT const Handle_TColStd_HPackedMapOfInteger& MeshVS_Mesh::GetHiddenElems  )  const
 

Standard_EXPORT const Handle_TColStd_HPackedMapOfInteger& MeshVS_Mesh::GetHiddenNodes  )  const
 

Standard_EXPORT Handle_MeshVS_PrsBuilder MeshVS_Mesh::GetHilighter  )  const
 

Standard_EXPORT MeshVS_MeshSelectionMethod MeshVS_Mesh::GetMeshSelMethod  )  const
 

Standard_EXPORT const MeshVS_DataMapOfIntegerOwner& MeshVS_Mesh::GetOwnerMaps const Standard_Boolean  IsElement  ) 
 

Standard_EXPORT const Handle_TColStd_HPackedMapOfInteger& MeshVS_Mesh::GetSelectableNodes  )  const
 

Standard_EXPORT const MeshVS_Mesh::Handle Standard_Type   )  const
 

Reimplemented from AIS_InteractiveObject.

virtual Standard_EXPORT void MeshVS_Mesh::HilightOwnerWithColor const Handle(PrsMgr_PresentationManager3d)&  PM,
const Quantity_NameOfColor  Color,
const Handle(SelectMgr_EntityOwner)&  Owner
[virtual]
 

Reimplemented from SelectMgr_SelectableObject.

virtual Standard_EXPORT void MeshVS_Mesh::HilightSelected const Handle(PrsMgr_PresentationManager3d)&  PM,
const SelectMgr_SequenceOfOwner Owners
[virtual]
 

Reimplemented from SelectMgr_SelectableObject.

Standard_EXPORT Standard_Boolean MeshVS_Mesh::IsHiddenElem const Standard_Integer  ID  )  const
 

Standard_EXPORT Standard_Boolean MeshVS_Mesh::IsHiddenNode const Standard_Integer  ID  )  const
 

Standard_EXPORT Standard_Boolean MeshVS_Mesh::IsSelectableElem const Standard_Integer  ID  )  const
 

Standard_EXPORT Standard_Boolean MeshVS_Mesh::IsSelectableNode const Standard_Integer  ID  )  const
 

virtual Standard_EXPORT Standard_Boolean MeshVS_Mesh::IsWholeMeshOwner const Handle(SelectMgr_EntityOwner)&  theOwner  )  const [virtual]
 

Standard_EXPORT void MeshVS_Mesh::RemoveBuilder const Standard_Integer  Index  ) 
 

Standard_EXPORT void MeshVS_Mesh::RemoveBuilderById const Standard_Integer  Id  ) 
 

Standard_EXPORT void MeshVS_Mesh::SetDataSource const Handle(MeshVS_DataSource)&  aDataSource  ) 
 

Standard_EXPORT void MeshVS_Mesh::SetDrawer const Handle(MeshVS_Drawer)&  aDrawer  ) 
 

Standard_EXPORT void MeshVS_Mesh::SetHiddenElems const Handle(TColStd_HPackedMapOfInteger)&  Ids  ) 
 

Standard_EXPORT void MeshVS_Mesh::SetHiddenNodes const Handle(TColStd_HPackedMapOfInteger)&  Ids  ) 
 

Standard_EXPORT Standard_Boolean MeshVS_Mesh::SetHilighter const Standard_Integer  Index  ) 
 

Standard_EXPORT void MeshVS_Mesh::SetHilighter const Handle(MeshVS_PrsBuilder)&  Builder  ) 
 

Standard_EXPORT Standard_Boolean MeshVS_Mesh::SetHilighterById const Standard_Integer  Id  ) 
 

Standard_EXPORT void MeshVS_Mesh::SetMeshSelMethod const MeshVS_MeshSelectionMethod  M  ) 
 

Standard_EXPORT void MeshVS_Mesh::SetSelectableNodes const Handle(TColStd_HPackedMapOfInteger)&  Ids  ) 
 

Standard_EXPORT void MeshVS_Mesh::UpdateSelectableNodes  ) 
 


Field Documentation

MeshVS_DataMapOfIntegerOwner MeshVS_Mesh::my0DOwners [protected]
 

MeshVS_SequenceOfPrsBuilder MeshVS_Mesh::myBuilders [private]
 

Handle_MeshVS_Drawer MeshVS_Mesh::myCurrentDrawer [protected]
 

Handle_MeshVS_DataSource MeshVS_Mesh::myDataSource [private]
 

MeshVS_DataMapOfIntegerOwner MeshVS_Mesh::myElementOwners [protected]
 

MeshVS_DataMapOfIntegerOwner MeshVS_Mesh::myFaceOwners [protected]
 

MeshVS_DataMapOfIntegerOwner MeshVS_Mesh::myGroupOwners [protected]
 

Handle_TColStd_HPackedMapOfInteger MeshVS_Mesh::myHiddenElements [private]
 

Handle_TColStd_HPackedMapOfInteger MeshVS_Mesh::myHiddenNodes [private]
 

Handle_MeshVS_Drawer MeshVS_Mesh::myHilightDrawer [protected]
 

Handle_MeshVS_PrsBuilder MeshVS_Mesh::myHilighter [private]
 

MeshVS_DataMapOfIntegerOwner MeshVS_Mesh::myLinkOwners [protected]
 

MeshVS_DataMapOfIntegerOwner MeshVS_Mesh::myMeshOwners [protected]
 

MeshVS_DataMapOfIntegerOwner MeshVS_Mesh::myNodeOwners [protected]
 

Handle_TColStd_HPackedMapOfInteger MeshVS_Mesh::mySelectableNodes [private]
 

Handle_MeshVS_Drawer MeshVS_Mesh::mySelectionDrawer [protected]
 

MeshVS_MeshSelectionMethod MeshVS_Mesh::mySelectionMethod [private]
 

MeshVS_DataMapOfIntegerOwner MeshVS_Mesh::myVolumeOwners [protected]
 

Handle_SelectMgr_EntityOwner MeshVS_Mesh::myWholeMeshOwner [protected]
 


The documentation for this class was generated from the following file:
Generated on Mon Aug 25 13:55:50 2008 for OpenCASCADE by  doxygen 1.4.1