Defines a presentation object which can be displayed, highlighted or erased. The presentation object stores the results of the presentation algorithms as defined in the StdPrs classes and the Prs3d classes inheriting Prs3d_Root. This presentation object is used to give display attributes defined at this level to ApplicationInteractiveServices classes at the level above. A presentation object is attached to a given Viewer. More...
#include <Prs3d_Presentation.hxx>
Inheritance diagram for Prs3d_Presentation:
Public Member Functions | |
| Prs3d_Presentation (const Handle< Graphic3d_StructureManager > &theStructManager, const Standard_Boolean theToInit=Standard_True) | |
| Constructs a presentation object if <Init> is false, no color initialization is done. More... | |
| Prs3d_Presentation (const Handle< Graphic3d_StructureManager > &theStructManager, const Handle< Prs3d_Presentation > &thePrs) | |
| Constructs a presentation object. More... | |
| virtual Handle< Graphic3d_Structure > | Compute (const Handle< Graphic3d_DataStructureManager > &aProjector) override |
| Returns the new Structure defined for the new visualization. More... | |
| virtual Handle< Graphic3d_Structure > | Compute (const Handle< Graphic3d_DataStructureManager > &theProjector, const Handle< Geom_Transformation > &theTrsf) override |
| Returns the new Structure defined for the new visualization. More... | |
| virtual void | Compute (const Handle< Graphic3d_DataStructureManager > &aProjector, Handle< Graphic3d_Structure > &aStructure) override |
| Returns the new Structure defined for the new visualization. More... | |
| virtual void | Compute (const Handle< Graphic3d_DataStructureManager > &theProjector, const Handle< Geom_Transformation > &theTrsf, Handle< Graphic3d_Structure > &theStructure) override |
| Returns the new Structure defined for the new visualization. More... | |
| void | Connect (const Handle< Prs3d_Presentation > &aPresentation) |
| void | Remove (const Handle< Prs3d_Presentation > &aPresentation) |
| void | RemoveAll () |
 Public Member Functions inherited from Graphic3d_Structure | |
| Graphic3d_Structure (const Handle< Graphic3d_StructureManager > &theManager) | |
| Creates a graphic object in the manager theManager. It will appear in all the views of the visualiser. The structure is not displayed when it is created. More... | |
| Graphic3d_Structure (const Handle< Graphic3d_StructureManager > &theManager, const Handle< Graphic3d_Structure > &thePrs) | |
| Creates a shadow link to existing graphic object. More... | |
| virtual void | Clear (const Standard_Boolean WithDestruction=Standard_True) |
| if WithDestruction == Standard_True then suppress all the groups of primitives in the structure. and it is mandatory to create a new group in <me>. if WithDestruction == Standard_False then clears all the groups of primitives in the structure. and all the groups are conserved and empty. They will be erased at the next screen update. The structure itself is conserved. The transformation and the attributes of <me> are conserved. The childs of <me> are conserved. More... | |
| ~Graphic3d_Structure () | |
| Suppresses the structure <me>. It will be erased at the next screen update. More... | |
| virtual void | Display () |
| Displays the structure <me> in all the views of the visualiser. More... | |
| Standard_Integer | DisplayPriority () const |
| Returns the current display priority for the structure <me>. More... | |
| virtual void | Erase () |
| Erases the structure <me> in all the views of the visualiser. More... | |
| void | Highlight (const Handle< Graphic3d_PresentationAttributes > &theStyle, const Standard_Boolean theToUpdateMgr=Standard_True) |
| Highlights the structure in all the views with the given style. More... | |
| void | Remove () |
| Suppress the structure <me>. It will be erased at the next screen update. Warning: No more graphic operations in <me> after this call. Category: Methods to modify the class definition. More... | |
| virtual void | CalculateBoundBox () |
| Computes axis-aligned bounding box of a structure. More... | |
| void | SetInfiniteState (const Standard_Boolean theToSet) |
| If <theToSet> is Standard_True then <me> is infinite and the MinMaxValues method method return : theXMin = theYMin = theZMin = RealFirst(). theXMax = theYMax = theZMax = RealLast(). By default, <me> is not infinite but empty. More... | |
| void | SetDisplayPriority (const Standard_Integer Priority) |
| Modifies the order of displaying the structure. Values are between 0 and 10. Structures are drawn according to their display priorities in ascending order. A structure of priority 10 is displayed the last and appears over the others. The default value is 5. Category: Methods to modify the class definition Warning: If <me> is displayed then the SetDisplayPriority method erase <me> and display <me> with the new priority. Raises PriorityDefinitionError if <Priority> is greater than 10 or a negative value. More... | |
| void | ResetDisplayPriority () |
| Reset the current priority of the structure to the previous priority. Category: Methods to modify the class definition Warning: If <me> is displayed then the SetDisplayPriority method erase <me> and display <me> with the previous priority. More... | |
| void | SetZLayer (const Graphic3d_ZLayerId theLayerId) |
| Set Z layer ID for the structure. The Z layer mechanism allows to display structures presented in higher layers in overlay of structures in lower layers by switching off z buffer depth test between layers. More... | |
| Graphic3d_ZLayerId | GetZLayer () const |
| Get Z layer ID of displayed structure. The method returns -1 if the structure has no ID (deleted from graphic driver). More... | |
| void | SetClipPlanes (const Handle< Graphic3d_SequenceOfHClipPlane > &thePlanes) |
| Changes a sequence of clip planes slicing the structure on rendering. More... | |
| const Handle< Graphic3d_SequenceOfHClipPlane > & | ClipPlanes () const |
| Get clip planes slicing the structure on rendering. More... | |
| void | SetVisible (const Standard_Boolean AValue) |
| Modifies the visibility indicator to Standard_True or Standard_False for the structure <me>. The default value at the definition of <me> is Standard_True. More... | |
| virtual void | SetVisual (const Graphic3d_TypeOfStructure AVisual) |
| Modifies the visualisation mode for the structure <me>. More... | |
| void | SetZoomLimit (const Standard_Real LimitInf, const Standard_Real LimitSup) |
| Modifies the minimum and maximum zoom coefficients for the structure <me>. The default value at the definition of <me> is unlimited. Category: Methods to modify the class definition Warning: Raises StructureDefinitionError if <LimitInf> is greater than <LimitSup> or if <LimitInf> or <LimitSup> is a negative value. More... | |
| void | SetIsForHighlight (const Standard_Boolean isForHighlight) |
| marks the structure <me> representing wired structure needed for highlight only so it won't be added to BVH tree. Category: Methods to modify the class definition More... | |
| void | UnHighlight () |
| Suppresses the highlight for the structure <me> in all the views of the visualiser. More... | |
| virtual void | Compute () |
| void | ReCompute () |
| Forces a new construction of the structure <me> if <me> is displayed and TOS_COMPUTED. More... | |
| void | ReCompute (const Handle< Graphic3d_DataStructureManager > &aProjector) |
| Forces a new construction of the structure <me> if <me> is displayed in <aProjetor> and TOS_COMPUTED. More... | |
| Standard_Boolean | ContainsFacet () const |
| Returns Standard_True if the structure <me> contains Polygons, Triangles or Quadrangles. More... | |
| const Graphic3d_SequenceOfGroup & | Groups () const |
| Returns the groups sequence included in the structure <me> (internal storage). More... | |
| Standard_Integer | NumberOfGroups () const |
| Returns the current number of groups in the structure <me>. More... | |
| Handle< Graphic3d_Group > | NewGroup () |
| Append new group to this structure. More... | |
| const Handle< Graphic3d_PresentationAttributes > & | HighlightStyle () const |
| Returns the highlight color for the Highlight method with the highlight method TOHM_COLOR or TOHM_BOUNDBOX. More... | |
| Standard_Boolean | IsDeleted () const |
| Returns Standard_True if the structure <me> is deleted. <me> is deleted after the call Remove (me). More... | |
| virtual Standard_Boolean | IsDisplayed () const |
| Returns the display indicator for the structure <me>. More... | |
| Standard_Boolean | IsEmpty () const |
| Returns Standard_True if the structure <me> is empty. Warning: A structure is empty if : it do not have group or all the groups are empties and it do not have descendant or all the descendants are empties. More... | |
| Standard_Boolean | IsInfinite () const |
| Returns Standard_True if the structure <me> is infinite. More... | |
| virtual Standard_Boolean | IsHighlighted () const |
| Returns the highlight indicator for the structure <me>. More... | |
| Standard_Boolean | IsTransformed () const |
| Returns Standard_True if the structure <me> is transformed. <=> The transformation != Identity. More... | |
| Standard_Boolean | IsVisible () const |
| Returns the visibility indicator for the structure <me>. More... | |
| Bnd_Box | MinMaxValues (const Standard_Boolean theToIgnoreInfiniteFlag=Standard_False) const |
| Returns the coordinates of the boundary box of the structure <me>. If <theToIgnoreInfiniteFlag> is TRUE, the method returns actual graphical boundaries of the Graphic3d_Group components. Otherwise, the method returns boundaries taking into account infinite state of the structure. This approach generally used for application specific fit operation (e.g. fitting the model into screen, not taking into accout infinite helper elements). Warning: If the structure <me> is empty then the empty box is returned, If the structure <me> is infinite then the whole box is returned. More... | |
| Graphic3d_TypeOfStructure | Visual () const |
| Returns the visualisation mode for the structure <me>. More... | |
| void | Ancestors (Graphic3d_MapOfStructure &SG) const |
| Returns the group of structures to which <me> is connected. More... | |
| void | Connect (const Handle< Graphic3d_Structure > &AStructure, const Graphic3d_TypeOfConnection AType, const Standard_Boolean WithCheck=Standard_False) |
| If Atype is TOC_DESCENDANT then add <AStructure> as a child structure of <me>. If Atype is TOC_ANCESTOR then add <AStructure> as a parent structure of <me>. The connection propagates Display, Highlight, Erase, Remove, and stacks the transformations. No connection if the graph of the structures contains a cycle and <WithCheck> is Standard_True;. More... | |
| void | Descendants (Graphic3d_MapOfStructure &SG) const |
| Returns the group of structures connected to <me>. More... | |
| void | Disconnect (const Handle< Graphic3d_Structure > &AStructure) |
| Suppress the connection between <AStructure> and <me>. More... | |
| void | DisconnectAll (const Graphic3d_TypeOfConnection AType) |
| If Atype is TOC_DESCENDANT then suppress all the connections with the child structures of <me>. If Atype is TOC_ANCESTOR then suppress all the connections with the parent structures of <me>. More... | |
| void | SetOwner (const Standard_Address Owner) |
| Standard_Address | Owner () const |
| void | SetHLRValidation (const Standard_Boolean AFlag) |
| Standard_Boolean | HLRValidation () const |
| const Handle< Geom_Transformation > & | Transformation () const |
| Return local transformation. More... | |
| void | SetTransformation (const Handle< Geom_Transformation > &theTrsf) |
| Modifies the current local transformation. More... | |
| Standard_DEPRECATED ("This method is deprecated - SetTransformation() should be called instead") void Transform(const Handle< Geom_Transformation > &theTrsf) | |
| void | SetTransformPersistence (const Handle< Graphic3d_TransformPers > &theTrsfPers) |
| Modifies the current transform persistence (pan, zoom or rotate) More... | |
| const Handle< Graphic3d_TransformPers > & | TransformPersistence () const |
| void | SetMutable (const Standard_Boolean theIsMutable) |
| Sets if the structure location has mutable nature (content or location will be changed regularly). More... | |
| Standard_Boolean | IsMutable () const |
| Returns true if structure has mutable nature (content or location are be changed regularly). Mutable structure will be managed in different way than static onces. More... | |
| Graphic3d_TypeOfStructure | ComputeVisual () const |
| void | GraphicClear (const Standard_Boolean WithDestruction) |
| Clears the structure <me>. More... | |
| void | GraphicConnect (const Handle< Graphic3d_Structure > &ADaughter) |
| void | GraphicDisconnect (const Handle< Graphic3d_Structure > &ADaughter) |
| void | GraphicTransform (const Handle< Geom_Transformation > &theTrsf) |
| Internal method which sets new transformation without calling graphic manager callbacks. More... | |
| Standard_Integer | Identification () const |
| Returns the identification number of the structure <me>. More... | |
| void | Remove (const Standard_Address APtr, const Graphic3d_TypeOfConnection AType) |
| Suppress the adress <APtr> in the list of descendants or in the list of ancestors. More... | |
| void | SetComputeVisual (const Graphic3d_TypeOfStructure AVisual) |
| const Handle< Graphic3d_CStructure > & | CStructure () const |
| Returns the low-level structure. 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 void | Delete () const |
| Memory deallocator for transient classes. 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... | |
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 Graphic3d_Structure | |
| static Standard_Boolean | AcceptConnection (const Handle< Graphic3d_Structure > &AStructure1, const Handle< Graphic3d_Structure > &AStructure2, const Graphic3d_TypeOfConnection AType) |
| Returns Standard_True if the connection is possible between <AStructure1> and <AStructure2> without a creation of a cycle. More... | |
| static void | Network (const Handle< Graphic3d_Structure > &AStructure, const Graphic3d_TypeOfConnection AType, Graphic3d_MapOfStructure &ASet) |
| Returns <ASet> the group of structures : More... | |
| static void | PrintNetwork (const Handle< Graphic3d_Structure > &AStructure, const Graphic3d_TypeOfConnection AType) |
| Prints informations about the network associated with the structure <AStructure>. More... | |
| static void | Transforms (const gp_Trsf &theTrsf, const Standard_Real theX, const Standard_Real theY, const Standard_Real theZ, Standard_Real &theNewX, Standard_Real &theNewY, Standard_Real &theNewZ) |
| Transforms theX, theY, theZ with the transformation theTrsf. 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... | |
| Protected Member Functions inherited from Graphic3d_Structure | |
| Standard_Boolean | AppendDescendant (const Standard_Address theDescendant) |
| Appends new descendant structure. More... | |
| Standard_Boolean | RemoveDescendant (const Standard_Address theDescendant) |
| Removes the given descendant structure. More... | |
| Standard_Boolean | AppendAncestor (const Standard_Address theAncestor) |
| Appends new ancestor structure. More... | |
| Standard_Boolean | RemoveAncestor (const Standard_Address theAncestor) |
| Removes the given ancestor structure. More... | |
| Static Protected Member Functions inherited from Graphic3d_Structure | |
| static void | TransformBoundaries (const gp_Trsf &theTrsf, Standard_Real &theXMin, Standard_Real &theYMin, Standard_Real &theZMin, Standard_Real &theXMax, Standard_Real &theYMax, Standard_Real &theZMax) |
| Transforms boundaries with <theTrsf> transformation. More... | |
| Protected Attributes inherited from Graphic3d_Structure | |
| Graphic3d_StructureManager * | myStructureManager |
| Graphic3d_TypeOfStructure | myComputeVisual |
| Handle< Graphic3d_CStructure > | myCStructure |
| Graphic3d_IndexedMapOfAddress | myAncestors |
| Graphic3d_IndexedMapOfAddress | myDescendants |
| Standard_Address | myOwner |
| Graphic3d_TypeOfStructure | myVisual |
Detailed Description
Defines a presentation object which can be displayed, highlighted or erased. The presentation object stores the results of the presentation algorithms as defined in the StdPrs classes and the Prs3d classes inheriting Prs3d_Root. This presentation object is used to give display attributes defined at this level to ApplicationInteractiveServices classes at the level above. A presentation object is attached to a given Viewer.
Constructor & Destructor Documentation
◆ Prs3d_Presentation() [1/2]
| Prs3d_Presentation::Prs3d_Presentation | ( | const Handle< Graphic3d_StructureManager > & | theStructManager, |
| const Standard_Boolean | theToInit = Standard_True |
||
| ) |
Constructs a presentation object if <Init> is false, no color initialization is done.
◆ Prs3d_Presentation() [2/2]
| Prs3d_Presentation::Prs3d_Presentation | ( | const Handle< Graphic3d_StructureManager > & | theStructManager, |
| const Handle< Prs3d_Presentation > & | thePrs | ||
| ) |
Constructs a presentation object.
Member Function Documentation
◆ Compute() [1/4]
|
overridevirtual |
Returns the new Structure defined for the new visualization.
Reimplemented from Graphic3d_Structure.
Reimplemented in PrsMgr_Prs.
◆ Compute() [2/4]
|
overridevirtual |
Returns the new Structure defined for the new visualization.
Reimplemented from Graphic3d_Structure.
Reimplemented in PrsMgr_Prs.
◆ Compute() [3/4]
|
overridevirtual |
Returns the new Structure defined for the new visualization.
Reimplemented from Graphic3d_Structure.
Reimplemented in PrsMgr_Prs.
◆ Compute() [4/4]
|
overridevirtual |
Returns the new Structure defined for the new visualization.
Reimplemented from Graphic3d_Structure.
Reimplemented in PrsMgr_Prs.
◆ Connect()
| void Prs3d_Presentation::Connect | ( | const Handle< Prs3d_Presentation > & | aPresentation | ) |
◆ Remove()
| void Prs3d_Presentation::Remove | ( | const Handle< Prs3d_Presentation > & | aPresentation | ) |
◆ RemoveAll()
| void Prs3d_Presentation::RemoveAll | ( | ) |
The documentation for this class was generated from the following file:
