This class provides methods to create text data presentation. It store map of texts assigned with nodes or elements. More...
#include <MeshVS_TextPrsBuilder.hxx>
Inheritance diagram for MeshVS_TextPrsBuilder:
Public Member Functions | |
| MeshVS_TextPrsBuilder (const Handle< MeshVS_Mesh > &Parent, const Standard_Real Height, const Quantity_Color &Color, const MeshVS_DisplayModeFlags &Flags=MeshVS_DMF_TextDataPrs, const Handle< MeshVS_DataSource > &DS=0, const Standard_Integer Id=-1, const MeshVS_BuilderPriority &Priority=MeshVS_BP_Text) | |
| virtual void | Build (const Handle< Prs3d_Presentation > &Prs, const TColStd_PackedMapOfInteger &IDs, TColStd_PackedMapOfInteger &IDsToExclude, const Standard_Boolean IsElement, const Standard_Integer theDisplayMode) const override |
| Builds presentation of text data. | |
| const MeshVS_DataMapOfIntegerAsciiString & | GetTexts (const Standard_Boolean IsElement) const |
| Returns map of text assigned with nodes ( IsElement = False ) or elements ( IsElement = True ) | |
| void | SetTexts (const Standard_Boolean IsElement, const MeshVS_DataMapOfIntegerAsciiString &Map) |
| Sets map of text assigned with nodes or elements. | |
| Standard_Boolean | HasTexts (const Standard_Boolean IsElement) const |
| Returns True if map isn't empty. | |
| Standard_Boolean | GetText (const Standard_Boolean IsElement, const Standard_Integer ID, TCollection_AsciiString &Text) const |
| Returns text assigned with single node or element. | |
| void | SetText (const Standard_Boolean IsElement, const Standard_Integer ID, const TCollection_AsciiString &Text) |
| Sets text assigned with single node or element. | |
 Public Member Functions inherited from MeshVS_PrsBuilder | |
| 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< Select3D_SensitiveEntity > | CustomSensitiveEntity (const Handle< SelectMgr_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_PresentationManager > &thePrsMgr) |
| Set presentation manager for builder. | |
| Handle< PrsMgr_PresentationManager > | GetPresentationManager () const |
| Get presentation manager of builder. | |
| Public Member Functions inherited from Standard_Transient | |
| Standard_Transient () | |
| Empty constructor. | |
| Standard_Transient (const Standard_Transient &) | |
| Copy constructor – does nothing. | |
| Standard_Transient & | operator= (const Standard_Transient &) |
| Assignment operator, needed to avoid copying reference counter. | |
| virtual | ~Standard_Transient () |
| Destructor must be virtual. | |
| virtual const opencascade::handle< Standard_Type > & | DynamicType () const |
| Returns a type descriptor about this object. | |
| Standard_Boolean | IsInstance (const opencascade::handle< Standard_Type > &theType) const |
| Returns a true value if this is an instance of Type. | |
| Standard_Boolean | IsInstance (const Standard_CString theTypeName) const |
| Returns a true value if this is an instance of TypeName. | |
| 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. | |
| 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. | |
| 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. | |
| Standard_Integer | GetRefCount () const noexcept |
| Get the reference counter of this object. | |
| void | IncrementRefCounter () noexcept |
| Increments the reference counter of this object. | |
| Standard_Integer | DecrementRefCounter () noexcept |
| Decrements the reference counter of this object; returns the decremented value. | |
| virtual void | Delete () const |
| Memory deallocator for transient classes. | |
Additional Inherited Members | |
| Public Types inherited from Standard_Transient | |
| typedef void | base_type |
| Returns a type descriptor about this object. | |
| Static Public Member Functions inherited from Standard_Transient | |
| static constexpr const char * | get_type_name () |
| Returns a type descriptor about this object. | |
| static const opencascade::handle< Standard_Type > & | get_type_descriptor () |
| Returns type descriptor of Standard_Transient class. | |
| Protected Member Functions inherited from 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) | |
| 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 inherited from MeshVS_PrsBuilder | |
| MeshVS_MeshPtr | myParentMesh |
Detailed Description
This class provides methods to create text data presentation. It store map of texts assigned with nodes or elements.
Constructor & Destructor Documentation
◆ MeshVS_TextPrsBuilder()
| MeshVS_TextPrsBuilder::MeshVS_TextPrsBuilder | ( | const Handle< MeshVS_Mesh > & | Parent, |
| const Standard_Real | Height, | ||
| const Quantity_Color & | Color, | ||
| const MeshVS_DisplayModeFlags & | Flags = MeshVS_DMF_TextDataPrs, |
||
| const Handle< MeshVS_DataSource > & | DS = 0, |
||
| const Standard_Integer | Id = -1, |
||
| const MeshVS_BuilderPriority & | Priority = MeshVS_BP_Text |
||
| ) |
Member Function Documentation
◆ Build()
|
overridevirtual |
Builds presentation of text data.
Implements MeshVS_PrsBuilder.
◆ GetText()
| Standard_Boolean MeshVS_TextPrsBuilder::GetText | ( | const Standard_Boolean | IsElement, |
| const Standard_Integer | ID, | ||
| TCollection_AsciiString & | Text | ||
| ) | const |
Returns text assigned with single node or element.
◆ GetTexts()
| const MeshVS_DataMapOfIntegerAsciiString & MeshVS_TextPrsBuilder::GetTexts | ( | const Standard_Boolean | IsElement | ) | const |
Returns map of text assigned with nodes ( IsElement = False ) or elements ( IsElement = True )
◆ HasTexts()
| Standard_Boolean MeshVS_TextPrsBuilder::HasTexts | ( | const Standard_Boolean | IsElement | ) | const |
Returns True if map isn't empty.
◆ SetText()
| void MeshVS_TextPrsBuilder::SetText | ( | const Standard_Boolean | IsElement, |
| const Standard_Integer | ID, | ||
| const TCollection_AsciiString & | Text | ||
| ) |
Sets text assigned with single node or element.
◆ SetTexts()
| void MeshVS_TextPrsBuilder::SetTexts | ( | const Standard_Boolean | IsElement, |
| const MeshVS_DataMapOfIntegerAsciiString & | Map | ||
| ) |
Sets map of text assigned with nodes or elements.
The documentation for this class was generated from the following file:
