This class is parent for all builders using in MeshVS_Mesh. It provides base fields and methods all buildes need. More...
#include <MeshVS_PrsBuilder.hxx>
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) More... | |
| 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) More... | |
| 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 ) More... | |
| Standard_Integer | GetFlags () const |
| Returns flags, assigned with builder during creation. More... | |
| 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. More... | |
| Standard_Integer | GetId () const |
| Returns builder ID. More... | |
| Standard_Integer | GetPriority () const |
| Returns priority; as priority bigger, as soon builder will be called. More... | |
| Handle< MeshVS_DataSource > | GetDataSource () const |
| Returns custom data source or default ( from MeshVS_Mesh ) if custom is NULL. More... | |
| void | SetDataSource (const Handle< MeshVS_DataSource > &newDS) |
| Change custom data source. More... | |
| Handle< MeshVS_Drawer > | GetDrawer () const |
| Returns custom drawer or default ( from MeshVS_Mesh ) if custom is NULL. More... | |
| void | SetDrawer (const Handle< MeshVS_Drawer > &newDr) |
| Change custom drawer. More... | |
| 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. More... | |
| Standard_Boolean | IsExcludingOn () const |
| Read excluding state. More... | |
| void | SetPresentationManager (const Handle< PrsMgr_PresentationManager3d > &thePrsMgr) |
| Set presentation manager for builder. More... | |
| Handle< PrsMgr_PresentationManager3d > | GetPresentationManager () const |
| Get presentation manager of builder. More... | |
 Public Member Functions inherited from MMgt_TShared | |
| virtual void | Delete () const override |
| 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 const opencascade::handle< Standard_Type > & | DynamicType () const |
| Returns a type descriptor about this object. More... | |
| Standard_Boolean | IsInstance (const opencascade::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 opencascade::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... | |
| Standard_Transient * | This () const |
| Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero. More... | |
| Standard_Integer | GetRefCount () const |
| Get the reference counter of this object. More... | |
| void | IncrementRefCounter () const |
| Increments the reference counter of this object. More... | |
| Standard_Integer | DecrementRefCounter () const |
| Decrements the reference counter of this object; returns the decremented value. More... | |
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. More... | |
| Handle< MeshVS_DataSource > | DataSource () const |
| Returns only custom data source. More... | |
| Handle< MeshVS_Drawer > | Drawer () const |
| Returns only custom drawer. More... | |
Protected Attributes | |
| MeshVS_MeshPtr | myParentMesh |
Additional Inherited Members | |
| Public Types inherited from Standard_Transient | |
| typedef void | base_type |
| Returns a type descriptor about this object. More... | |
| Static Public Member Functions inherited from Standard_Transient | |
| static const char * | get_type_name () |
| Returns a type descriptor about this object. More... | |
| static const opencascade::handle< Standard_Type > & | get_type_descriptor () |
| Returns type descriptor of Standard_Transient class. More... | |
Detailed Description
This class is parent for all builders using in MeshVS_Mesh. It provides base fields and methods all buildes need.
Constructor & Destructor Documentation
|
protected |
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.
Member Function Documentation
|
pure virtual |
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)
Implemented in MeshVS_NodalColorPrsBuilder, MeshVS_MeshPrsBuilder, MeshVS_VectorPrsBuilder, MeshVS_ElementalColorPrsBuilder, and MeshVS_TextPrsBuilder.
|
virtual |
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 |
This method is called to build sensitive of custom elements ( they have MeshVS_ET_0D type )
|
protected |
Returns only custom data source.
|
protected |
Returns only custom drawer.
| Handle< MeshVS_DataSource > MeshVS_PrsBuilder::GetDataSource | ( | ) | const |
Returns custom data source or default ( from MeshVS_Mesh ) if custom is NULL.
| Handle< MeshVS_Drawer > MeshVS_PrsBuilder::GetDrawer | ( | ) | const |
Returns custom drawer or default ( from MeshVS_Mesh ) if custom is NULL.
| Standard_Integer MeshVS_PrsBuilder::GetFlags | ( | ) | const |
Returns flags, assigned with builder during creation.
| Standard_Integer MeshVS_PrsBuilder::GetId | ( | ) | const |
Returns builder ID.
| Handle< PrsMgr_PresentationManager3d > MeshVS_PrsBuilder::GetPresentationManager | ( | ) | const |
Get presentation manager of builder.
| Standard_Integer MeshVS_PrsBuilder::GetPriority | ( | ) | const |
Returns priority; as priority bigger, as soon builder will be called.
| Standard_Boolean MeshVS_PrsBuilder::IsExcludingOn | ( | ) | const |
Read excluding state.
| void MeshVS_PrsBuilder::SetDataSource | ( | const Handle< MeshVS_DataSource > & | newDS | ) |
Change custom data source.
| void MeshVS_PrsBuilder::SetDrawer | ( | const Handle< MeshVS_Drawer > & | newDr | ) |
Change custom drawer.
| void MeshVS_PrsBuilder::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.
| void MeshVS_PrsBuilder::SetPresentationManager | ( | const Handle< PrsMgr_PresentationManager3d > & | thePrsMgr | ) |
Set presentation manager for builder.
|
virtual |
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.
Field Documentation
|
protected |
The documentation for this class was generated from the following file:
