Open CASCADE Technology  6.9.0
Public Member Functions

Prs3d_Presentation Class Reference

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:
Inheritance graph
[legend]

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)
 Returns the new Structure defined for the new visualization. More...
 
virtual Handle
< Graphic3d_Structure
Compute (const Handle< Graphic3d_DataStructureManager > &aProjector, const TColStd_Array2OfReal &AMatrix)
 Returns the new Structure defined for the new visualization. More...
 
virtual void Compute (const Handle< Graphic3d_DataStructureManager > &aProjector, Handle< Graphic3d_Structure > &aStructure)
 Returns the new Structure defined for the new visualization. More...
 
virtual void Compute (const Handle< Graphic3d_DataStructureManager > &aProjector, const TColStd_Array2OfReal &AMatrix, Handle< Graphic3d_Structure > &aStructure)
 Returns the new Structure defined for the new visualization. More...
 
void SetShadingAspect (const Handle< Prs3d_ShadingAspect > &aShadingAspect)
 
void Transform (const Handle< Geom_Transformation > &aTransformation)
 
void Place (const Quantity_Length X, const Quantity_Length Y, const Quantity_Length Z)
 
void Multiply (const Handle< Geom_Transformation > &aTransformation)
 
void Move (const Quantity_Length X, const Quantity_Length Y, const Quantity_Length Z)
 
Handle< Geom_TransformationTransformation () const
 
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. Warning: The default values AspectLine, AspectFillArea, AspectText and AspectMarker are NOT applied to the structure. 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...
 
virtual void Destroy ()
 Suppresses the structure <me>. It will be erased at the next screen update. More...
 
 ~Graphic3d_Structure ()
 
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 Aspect_TypeOfHighlightMethod theMethod, const Quantity_Color &theColor, const Standard_Boolean theToUpdateMgr=Standard_True)
 Highlights the structure <me> in all the views of the visualiser, using the following methods: TOHM_COLOR = drawn in the highlight color TOHM_BOUNDBOX = enclosed by the boundary box. 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...
 
void CalculateBoundBox ()
 Computes axis-aligned bounding box of a structure. Category: Methods to modify the class definition. 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 Graphic3d_SequenceOfHClipPlane &thePlanes)
 Changes a sequence of clip planes slicing the structure on rendering. More...
 
const
Graphic3d_SequenceOfHClipPlane
GetClipPlanes () const
 Get clip planes slicing the structure on rendering. More...
 
void SetPrimitivesAspect (const Handle< Graphic3d_AspectLine3d > &CTX)
 Modifies the default attributes for lines in the structure <me>. More...
 
void SetPrimitivesAspect (const Handle< Graphic3d_AspectFillArea3d > &CTX)
 Modifies the default attributes for faces in the structure <me>. More...
 
void SetPrimitivesAspect (const Handle< Graphic3d_AspectText3d > &CTX)
 Modifies the default attributes for text in the structure <me>. More...
 
void SetPrimitivesAspect (const Handle< Graphic3d_AspectMarker3d > &CTX)
 Modifies the default attributes for markers in the structure <me>. 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...
 
Handle
< Graphic3d_AspectFillArea3d
FillArea3dAspect () const
 Returns the values of the current default attributes. More...
 
const Graphic3d_SequenceOfGroupGroups () 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_GroupNewGroup ()
 Append new group to this structure. More...
 
const Quantity_ColorHighlightColor () 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 IsRotated () const
 Returns Standard_True if the structure <me> is rotated. <=> The transformation != Identity, != Scale, != Translation. 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...
 
Handle< Graphic3d_AspectLine3dLine3dAspect () const
 Returns the values of the current default attributes. More...
 
Handle< Graphic3d_AspectMarker3dMarker3dAspect () const
 Returns the current group of graphic attributes used for 3d marker primitives. 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...
 
void PrimitivesAspect (Handle< Graphic3d_AspectLine3d > &CTXL, Handle< Graphic3d_AspectText3d > &CTXT, Handle< Graphic3d_AspectMarker3d > &CTXM, Handle< Graphic3d_AspectFillArea3d > &CTXF) const
 Returns the current values of the default attributes. More...
 
Handle< Graphic3d_AspectText3dText3dAspect () const
 Returns the values of the current default attributes. 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
 
Graphic3d_TypeOfComposition Composition () const
 Returns the type of composition applied to matrices of transformation of <me>. More...
 
void SetTransform (const TColStd_Array2OfReal &AMatrix, const Graphic3d_TypeOfComposition AType)
 Modifies the current local modelling transformation in the structure <me>. More...
 
void Transform (TColStd_Array2OfReal &AMatrix) const
 Returns the transformation associated with the structure <me>. More...
 
void SetTransformPersistence (const Graphic3d_TransModeFlags &AFlag, const gp_Pnt &APoint)
 Modifies the current modelling transform persistence (pan, zoom or rotate) More...
 
void SetTransformPersistence (const Graphic3d_TransModeFlags &AFlag)
 
Graphic3d_TransModeFlags TransformPersistenceMode () const
 Get the current modelling transform persistence (pan, zoom or rotate) More...
 
gp_Pnt TransformPersistencePoint () const
 Get the current point of relative modelling transform persistence. More...
 
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 GraphicHighlight (const Aspect_TypeOfHighlightMethod Method)
 Highlights the structure <me>. More...
 
void GraphicTransform (const TColStd_Array2OfReal &AMatrix)
 
void GraphicUnHighlight ()
 Suppress the highlight for the structure <me>. 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 MMgt_TShared
virtual void Delete () const
 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_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual const
Handle_Standard_Type & 
DynamicType () const
 Returns a type information object about this object. More...
 
Standard_Boolean IsInstance (const 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 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...
 
virtual Handle_Standard_Transient This () const
 Returns a Handle which references this object. Must never be called to objects created in stack. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 

Additional Inherited Members

- 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 TColStd_Array2OfReal &ATrsf, const Standard_Real X, const Standard_Real Y, const Standard_Real Z, Standard_Real &NewX, Standard_Real &NewY, Standard_Real &NewZ)
 Transforms <X>, <Y>, <Z> with the transformation <ATrsf>. More...
 
static Graphic3d_Vector Transforms (const TColStd_Array2OfReal &ATrsf, const Graphic3d_Vector &Coord)
 Transforms <Coord> with the transformation <ATrsf>. More...
 
static Graphic3d_Vertex Transforms (const TColStd_Array2OfReal &ATrsf, const Graphic3d_Vertex &Coord)
 Transforms <Coord> with the transformation <ATrsf>. 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 TColStd_Array2OfReal &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_StructureManagerPtr myStructureManager
 
Graphic3d_StructureManagerPtr myFirstStructureManager
 
Graphic3d_TypeOfStructure myComputeVisual
 

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::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::Prs3d_Presentation ( const Handle< Graphic3d_StructureManager > &  theStructManager,
const Handle< Prs3d_Presentation > &  thePrs 
)

Constructs a presentation object.

Member Function Documentation

virtual Handle< Graphic3d_Structure > Prs3d_Presentation::Compute ( const Handle< Graphic3d_DataStructureManager > &  aProjector)
virtual

Returns the new Structure defined for the new visualization.

Reimplemented from Graphic3d_Structure.

Reimplemented in PrsMgr_Prs.

virtual Handle< Graphic3d_Structure > Prs3d_Presentation::Compute ( const Handle< Graphic3d_DataStructureManager > &  aProjector,
const TColStd_Array2OfReal AMatrix 
)
virtual

Returns the new Structure defined for the new visualization.

Reimplemented from Graphic3d_Structure.

Reimplemented in PrsMgr_Prs.

virtual void Prs3d_Presentation::Compute ( const Handle< Graphic3d_DataStructureManager > &  aProjector,
Handle< Graphic3d_Structure > &  aStructure 
)
virtual

Returns the new Structure defined for the new visualization.

Reimplemented from Graphic3d_Structure.

Reimplemented in PrsMgr_Prs.

virtual void Prs3d_Presentation::Compute ( const Handle< Graphic3d_DataStructureManager > &  aProjector,
const TColStd_Array2OfReal AMatrix,
Handle< Graphic3d_Structure > &  aStructure 
)
virtual

Returns the new Structure defined for the new visualization.

Reimplemented from Graphic3d_Structure.

Reimplemented in PrsMgr_Prs.

void Prs3d_Presentation::Connect ( const Handle< Prs3d_Presentation > &  aPresentation)
void Prs3d_Presentation::Move ( const Quantity_Length  X,
const Quantity_Length  Y,
const Quantity_Length  Z 
)
void Prs3d_Presentation::Multiply ( const Handle< Geom_Transformation > &  aTransformation)
void Prs3d_Presentation::Place ( const Quantity_Length  X,
const Quantity_Length  Y,
const Quantity_Length  Z 
)
void Prs3d_Presentation::Remove ( const Handle< Prs3d_Presentation > &  aPresentation)
void Prs3d_Presentation::RemoveAll ( )
void Prs3d_Presentation::SetShadingAspect ( const Handle< Prs3d_ShadingAspect > &  aShadingAspect)
void Prs3d_Presentation::Transform ( const Handle< Geom_Transformation > &  aTransformation)
Handle< Geom_Transformation > Prs3d_Presentation::Transformation ( ) const

The documentation for this class was generated from the following file: