 |
Open CASCADE Technology Reference Manual 8.0.1
|
|
Open CASCADE Technology Reference Manual 8.0.1
|
This class provides methods to create text data presentation. It store map of texts assigned with nodes or elements. More...
#include <MeshVS_TextPrsBuilder.hxx>
Public Member Functions | |
| MeshVS_TextPrsBuilder (const occ::handle< MeshVS_Mesh > &Parent, const double Height, const Quantity_Color &Color, const MeshVS_DisplayModeFlags &Flags=MeshVS_DMF_TextDataPrs, const occ::handle< MeshVS_DataSource > &DS=nullptr, const int Id=-1, const MeshVS_BuilderPriority &Priority=MeshVS_BP_Text) | |
| void | Build (const occ::handle< Prs3d_Presentation > &Prs, const TColStd_PackedMapOfInteger &IDs, TColStd_PackedMapOfInteger &IDsToExclude, const bool IsElement, const int theDisplayMode) const override |
| Builds presentation of text data. | |
| const NCollection_DataMap< int, TCollection_AsciiString > & | GetTexts (const bool IsElement) const |
| Returns map of text assigned with nodes ( IsElement = False ) or elements ( IsElement = True ). | |
| void | SetTexts (const bool IsElement, const NCollection_DataMap< int, TCollection_AsciiString > &Map) |
| Sets map of text assigned with nodes or elements. | |
| bool | HasTexts (const bool IsElement) const |
| Returns True if map isn't empty. | |
| bool | GetText (const bool IsElement, const int ID, TCollection_AsciiString &Text) const |
| Returns text assigned with single node or element. | |
| void | SetText (const bool IsElement, const int ID, const TCollection_AsciiString &Text) |
| Sets text assigned with single node or element. | |
| Public Member Functions inherited from MeshVS_PrsBuilder | |
| virtual void | CustomBuild (const occ::handle< Prs3d_Presentation > &Prs, const TColStd_PackedMapOfInteger &IDs, TColStd_PackedMapOfInteger &IDsToExclude, const int 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 occ::handle< Select3D_SensitiveEntity > | CustomSensitiveEntity (const occ::handle< SelectMgr_EntityOwner > &Owner, const int SelectMode) const |
| This method is called to build sensitive of custom elements ( they have MeshVS_ET_0D type ). | |
| int | GetFlags () const |
| Returns flags, assigned with builder during creation. | |
| virtual bool | TestFlags (const int 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 true only if display mode is appropriate for this builder. | |
| int | GetId () const |
| Returns builder ID. | |
| int | GetPriority () const |
| Returns priority; as priority bigger, as soon builder will be called. | |
| occ::handle< MeshVS_DataSource > | GetDataSource () const |
| Returns custom data source or default ( from MeshVS_Mesh ) if custom is NULL. | |
| void | SetDataSource (const occ::handle< MeshVS_DataSource > &newDS) |
| Change custom data source. | |
| occ::handle< MeshVS_Drawer > | GetDrawer () const |
| Returns custom drawer or default ( from MeshVS_Mesh ) if custom is NULL. | |
| void | SetDrawer (const occ::handle< MeshVS_Drawer > &newDr) |
| Change custom drawer. | |
| void | SetExcluding (const bool state) |
| Set excluding state. If it is true, the nodes or elements, processed by current builder will be noted and next builder won't process its. | |
| bool | IsExcludingOn () const |
| Read excluding state. | |
| void | SetPresentationManager (const occ::handle< PrsMgr_PresentationManager > &thePrsMgr) |
| Set presentation manager for builder. | |
| occ::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 ()=default |
| Destructor must be virtual. | |
| virtual const opencascade::handle< Standard_Type > & | DynamicType () const |
| Returns a type descriptor about this object. | |
| bool | IsInstance (const opencascade::handle< Standard_Type > &theType) const |
| Returns a true value if this is an instance of Type. | |
| bool | IsInstance (const char *const theTypeName) const |
| Returns a true value if this is an instance of TypeName. | |
| bool | 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. | |
| bool | IsKind (const char *const 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. | |
| int | GetRefCount () const noexcept |
| Get the reference counter of this object. | |
| void | IncrementRefCounter () noexcept |
| Increments the reference counter of this object. Uses relaxed memory ordering since incrementing only requires atomicity, not synchronization with other memory operations. | |
| int | DecrementRefCounter () noexcept |
| Decrements the reference counter of this object; returns the decremented value. Uses release ordering for the decrement to ensure all writes to the object are visible before the count reaches zero. An acquire fence is added only when the count reaches zero, ensuring proper synchronization before deletion. This is more efficient than using acq_rel for every decrement. | |
| virtual void | Delete () const |
| Memory deallocator for transient classes. | |
Additional Inherited Members | |
| typedef void | base_type |
| Returns a type descriptor about this object. | |
| 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 occ::handle< MeshVS_Mesh > &Parent, const MeshVS_DisplayModeFlags &Flags, const occ::handle< MeshVS_DataSource > &DS, const int 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. | |
| occ::handle< MeshVS_DataSource > | DataSource () const |
| Returns only custom data source. | |
| occ::handle< MeshVS_Drawer > | Drawer () const |
| Returns only custom drawer. | |
| Protected Attributes inherited from MeshVS_PrsBuilder | |
| MeshVS_MeshPtr | myParentMesh |
This class provides methods to create text data presentation. It store map of texts assigned with nodes or elements.
| MeshVS_TextPrsBuilder::MeshVS_TextPrsBuilder | ( | const occ::handle< MeshVS_Mesh > & | Parent, |
| const double | Height, | ||
| const Quantity_Color & | Color, | ||
| const MeshVS_DisplayModeFlags & | Flags = MeshVS_DMF_TextDataPrs, | ||
| const occ::handle< MeshVS_DataSource > & | DS = nullptr, | ||
| const int | Id = -1, | ||
| const MeshVS_BuilderPriority & | Priority = MeshVS_BP_Text ) |
|
overridevirtual |
Builds presentation of text data.
Implements MeshVS_PrsBuilder.
| bool MeshVS_TextPrsBuilder::GetText | ( | const bool | IsElement, |
| const int | ID, | ||
| TCollection_AsciiString & | Text ) const |
Returns text assigned with single node or element.
| const NCollection_DataMap< int, TCollection_AsciiString > & MeshVS_TextPrsBuilder::GetTexts | ( | const bool | IsElement | ) | const |
Returns map of text assigned with nodes ( IsElement = False ) or elements ( IsElement = True ).
| bool MeshVS_TextPrsBuilder::HasTexts | ( | const bool | IsElement | ) | const |
Returns True if map isn't empty.
| void MeshVS_TextPrsBuilder::SetText | ( | const bool | IsElement, |
| const int | ID, | ||
| const TCollection_AsciiString & | Text ) |
Sets text assigned with single node or element.
| void MeshVS_TextPrsBuilder::SetTexts | ( | const bool | IsElement, |
| const NCollection_DataMap< int, TCollection_AsciiString > & | Map ) |
Sets map of text assigned with nodes or elements.
1.17.0