Open CASCADE Technology  7.3.1.dev
Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes
Graphic3d_Structure Class Reference

This class allows the definition a graphic object. This graphic structure can be displayed, erased, or highlighted. This graphic structure can be connected with another graphic structure. Keywords: Structure, StructureManager, Display, Erase, Highlight, UnHighlight, Visible, Priority, Selectable, Visible, Visual, Connection, Ancestors, Descendants, Transformation. More...

#include <Graphic3d_Structure.hxx>

Inheritance diagram for Graphic3d_Structure:
Inheritance graph
[legend]

Public Member Functions

 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 ()
 
virtual Handle< Graphic3d_StructureCompute (const Handle< Graphic3d_DataStructureManager > &aProjector)
 Returns the new Structure defined for the new visualization. More...
 
virtual Handle< Graphic3d_StructureCompute (const Handle< Graphic3d_DataStructureManager > &theProjector, const Handle< Geom_Transformation > &theTrsf)
 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 > &theProjector, const Handle< Geom_Transformation > &theTrsf, Handle< Graphic3d_Structure > &theStructure)
 Returns the new Structure defined for the new visualization. More...
 
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_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 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_Transientoperator= (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_TransientThis () 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...
 

Static Public Member Functions

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

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

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

Graphic3d_StructureManagermyStructureManager
 
Graphic3d_TypeOfStructure myComputeVisual
 
Handle< Graphic3d_CStructuremyCStructure
 
Graphic3d_IndexedMapOfAddress myAncestors
 
Graphic3d_IndexedMapOfAddress myDescendants
 
Standard_Address myOwner
 
Graphic3d_TypeOfStructure myVisual
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 

Detailed Description

This class allows the definition a graphic object. This graphic structure can be displayed, erased, or highlighted. This graphic structure can be connected with another graphic structure. Keywords: Structure, StructureManager, Display, Erase, Highlight, UnHighlight, Visible, Priority, Selectable, Visible, Visual, Connection, Ancestors, Descendants, Transformation.

Constructor & Destructor Documentation

◆ Graphic3d_Structure() [1/2]

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.

◆ Graphic3d_Structure() [2/2]

Graphic3d_Structure::Graphic3d_Structure ( const Handle< Graphic3d_StructureManager > &  theManager,
const Handle< Graphic3d_Structure > &  thePrs 
)

Creates a shadow link to existing graphic object.

◆ ~Graphic3d_Structure()

Graphic3d_Structure::~Graphic3d_Structure ( )

Suppresses the structure <me>. It will be erased at the next screen update.

Member Function Documentation

◆ AcceptConnection()

static Standard_Boolean Graphic3d_Structure::AcceptConnection ( const Handle< Graphic3d_Structure > &  AStructure1,
const Handle< Graphic3d_Structure > &  AStructure2,
const Graphic3d_TypeOfConnection  AType 
)
static

Returns Standard_True if the connection is possible between <AStructure1> and <AStructure2> without a creation of a cycle.

It's not possible to call the method AStructure1->Connect (AStructure2, TypeOfConnection) if

  • the set of all ancestors of <AStructure1> contains <AStructure1> and if the TypeOfConnection == TOC_DESCENDANT
  • the set of all descendants of <AStructure1> contains <AStructure2> and if the TypeOfConnection == TOC_ANCESTOR

◆ Ancestors()

void Graphic3d_Structure::Ancestors ( Graphic3d_MapOfStructure SG) const

Returns the group of structures to which <me> is connected.

◆ AppendAncestor()

Standard_Boolean Graphic3d_Structure::AppendAncestor ( const Standard_Address  theAncestor)
protected

Appends new ancestor structure.

◆ AppendDescendant()

Standard_Boolean Graphic3d_Structure::AppendDescendant ( const Standard_Address  theDescendant)
protected

Appends new descendant structure.

◆ CalculateBoundBox()

virtual void Graphic3d_Structure::CalculateBoundBox ( )
virtual

Computes axis-aligned bounding box of a structure.

Reimplemented in Prs3d_PresentationShadow.

◆ Clear()

virtual void Graphic3d_Structure::Clear ( const Standard_Boolean  WithDestruction = Standard_True)
virtual

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.

◆ ClipPlanes()

const Handle< Graphic3d_SequenceOfHClipPlane >& Graphic3d_Structure::ClipPlanes ( ) const

Get clip planes slicing the structure on rendering.

Returns
set of clip planes.

◆ Compute() [1/5]

virtual void Graphic3d_Structure::Compute ( )
virtual

Reimplemented in PrsMgr_Prs.

◆ Compute() [2/5]

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

Returns the new Structure defined for the new visualization.

Reimplemented in Prs3d_Presentation, and PrsMgr_Prs.

◆ Compute() [3/5]

virtual Handle< Graphic3d_Structure > Graphic3d_Structure::Compute ( const Handle< Graphic3d_DataStructureManager > &  theProjector,
const Handle< Geom_Transformation > &  theTrsf 
)
virtual

Returns the new Structure defined for the new visualization.

Reimplemented in Prs3d_Presentation, and PrsMgr_Prs.

◆ Compute() [4/5]

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

Returns the new Structure defined for the new visualization.

Reimplemented in Prs3d_Presentation, and PrsMgr_Prs.

◆ Compute() [5/5]

virtual void Graphic3d_Structure::Compute ( const Handle< Graphic3d_DataStructureManager > &  theProjector,
const Handle< Geom_Transformation > &  theTrsf,
Handle< Graphic3d_Structure > &  theStructure 
)
virtual

Returns the new Structure defined for the new visualization.

Reimplemented in Prs3d_Presentation, and PrsMgr_Prs.

◆ ComputeVisual()

Graphic3d_TypeOfStructure Graphic3d_Structure::ComputeVisual ( ) const

◆ Connect()

void Graphic3d_Structure::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;.

◆ ContainsFacet()

Standard_Boolean Graphic3d_Structure::ContainsFacet ( ) const

Returns Standard_True if the structure <me> contains Polygons, Triangles or Quadrangles.

◆ CStructure()

const Handle< Graphic3d_CStructure >& Graphic3d_Structure::CStructure ( ) const
inline

Returns the low-level structure.

◆ Descendants()

void Graphic3d_Structure::Descendants ( Graphic3d_MapOfStructure SG) const

Returns the group of structures connected to <me>.

◆ Disconnect()

void Graphic3d_Structure::Disconnect ( const Handle< Graphic3d_Structure > &  AStructure)

Suppress the connection between <AStructure> and <me>.

◆ DisconnectAll()

void Graphic3d_Structure::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>.

◆ Display()

virtual void Graphic3d_Structure::Display ( )
virtual

Displays the structure <me> in all the views of the visualiser.

◆ DisplayPriority()

Standard_Integer Graphic3d_Structure::DisplayPriority ( ) const

Returns the current display priority for the structure <me>.

◆ Erase()

virtual void Graphic3d_Structure::Erase ( )
virtual

Erases the structure <me> in all the views of the visualiser.

◆ GetZLayer()

Graphic3d_ZLayerId Graphic3d_Structure::GetZLayer ( ) const

Get Z layer ID of displayed structure. The method returns -1 if the structure has no ID (deleted from graphic driver).

◆ GraphicClear()

void Graphic3d_Structure::GraphicClear ( const Standard_Boolean  WithDestruction)

Clears the structure <me>.

◆ GraphicConnect()

void Graphic3d_Structure::GraphicConnect ( const Handle< Graphic3d_Structure > &  ADaughter)

◆ GraphicDisconnect()

void Graphic3d_Structure::GraphicDisconnect ( const Handle< Graphic3d_Structure > &  ADaughter)

◆ GraphicTransform()

void Graphic3d_Structure::GraphicTransform ( const Handle< Geom_Transformation > &  theTrsf)

Internal method which sets new transformation without calling graphic manager callbacks.

◆ Groups()

const Graphic3d_SequenceOfGroup& Graphic3d_Structure::Groups ( ) const

Returns the groups sequence included in the structure <me> (internal storage).

◆ Highlight()

void Graphic3d_Structure::Highlight ( const Handle< Graphic3d_PresentationAttributes > &  theStyle,
const Standard_Boolean  theToUpdateMgr = Standard_True 
)

Highlights the structure in all the views with the given style.

Parameters
theStyle[in] the style (type of highlighting: box/color, color and opacity)
theToUpdateMgr[in] defines whether related computed structures will be highlighted via structure manager or not

◆ HighlightStyle()

const Handle< Graphic3d_PresentationAttributes >& Graphic3d_Structure::HighlightStyle ( ) const

Returns the highlight color for the Highlight method with the highlight method TOHM_COLOR or TOHM_BOUNDBOX.

◆ HLRValidation()

Standard_Boolean Graphic3d_Structure::HLRValidation ( ) const

◆ Identification()

Standard_Integer Graphic3d_Structure::Identification ( ) const

Returns the identification number of the structure <me>.

◆ IsDeleted()

Standard_Boolean Graphic3d_Structure::IsDeleted ( ) const

Returns Standard_True if the structure <me> is deleted. <me> is deleted after the call Remove (me).

◆ IsDisplayed()

virtual Standard_Boolean Graphic3d_Structure::IsDisplayed ( ) const
virtual

Returns the display indicator for the structure <me>.

◆ IsEmpty()

Standard_Boolean Graphic3d_Structure::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.

◆ IsHighlighted()

virtual Standard_Boolean Graphic3d_Structure::IsHighlighted ( ) const
virtual

Returns the highlight indicator for the structure <me>.

◆ IsInfinite()

Standard_Boolean Graphic3d_Structure::IsInfinite ( ) const

Returns Standard_True if the structure <me> is infinite.

◆ IsMutable()

Standard_Boolean Graphic3d_Structure::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.

◆ IsTransformed()

Standard_Boolean Graphic3d_Structure::IsTransformed ( ) const

Returns Standard_True if the structure <me> is transformed. <=> The transformation != Identity.

◆ IsVisible()

Standard_Boolean Graphic3d_Structure::IsVisible ( ) const

Returns the visibility indicator for the structure <me>.

◆ MinMaxValues()

Bnd_Box Graphic3d_Structure::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.

◆ Network()

static void Graphic3d_Structure::Network ( const Handle< Graphic3d_Structure > &  AStructure,
const Graphic3d_TypeOfConnection  AType,
Graphic3d_MapOfStructure ASet 
)
static

Returns <ASet> the group of structures :

  • directly or indirectly connected to <AStructure> if the TypeOfConnection == TOC_DESCENDANT
  • to which <AStructure> is directly or indirectly connected if the TypeOfConnection == TOC_ANCESTOR

◆ NewGroup()

Handle< Graphic3d_Group > Graphic3d_Structure::NewGroup ( )

Append new group to this structure.

◆ NumberOfGroups()

Standard_Integer Graphic3d_Structure::NumberOfGroups ( ) const

Returns the current number of groups in the structure <me>.

◆ Owner()

Standard_Address Graphic3d_Structure::Owner ( ) const

◆ PrintNetwork()

static void Graphic3d_Structure::PrintNetwork ( const Handle< Graphic3d_Structure > &  AStructure,
const Graphic3d_TypeOfConnection  AType 
)
static

Prints informations about the network associated with the structure <AStructure>.

◆ ReCompute() [1/2]

void Graphic3d_Structure::ReCompute ( )

Forces a new construction of the structure <me> if <me> is displayed and TOS_COMPUTED.

◆ ReCompute() [2/2]

void Graphic3d_Structure::ReCompute ( const Handle< Graphic3d_DataStructureManager > &  aProjector)

Forces a new construction of the structure <me> if <me> is displayed in <aProjetor> and TOS_COMPUTED.

◆ Remove() [1/2]

void Graphic3d_Structure::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.

◆ Remove() [2/2]

void Graphic3d_Structure::Remove ( const Standard_Address  APtr,
const Graphic3d_TypeOfConnection  AType 
)

Suppress the adress <APtr> in the list of descendants or in the list of ancestors.

◆ RemoveAncestor()

Standard_Boolean Graphic3d_Structure::RemoveAncestor ( const Standard_Address  theAncestor)
protected

Removes the given ancestor structure.

◆ RemoveDescendant()

Standard_Boolean Graphic3d_Structure::RemoveDescendant ( const Standard_Address  theDescendant)
protected

Removes the given descendant structure.

◆ ResetDisplayPriority()

void Graphic3d_Structure::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.

◆ SetClipPlanes()

void Graphic3d_Structure::SetClipPlanes ( const Handle< Graphic3d_SequenceOfHClipPlane > &  thePlanes)

Changes a sequence of clip planes slicing the structure on rendering.

Parameters
thePlanes[in] the set of clip planes.

◆ SetComputeVisual()

void Graphic3d_Structure::SetComputeVisual ( const Graphic3d_TypeOfStructure  AVisual)

◆ SetDisplayPriority()

void Graphic3d_Structure::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.

◆ SetHLRValidation()

void Graphic3d_Structure::SetHLRValidation ( const Standard_Boolean  AFlag)

◆ SetInfiniteState()

void Graphic3d_Structure::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.

◆ SetIsForHighlight()

void Graphic3d_Structure::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

◆ SetMutable()

void Graphic3d_Structure::SetMutable ( const Standard_Boolean  theIsMutable)

Sets if the structure location has mutable nature (content or location will be changed regularly).

◆ SetOwner()

void Graphic3d_Structure::SetOwner ( const Standard_Address  Owner)

◆ SetTransformation()

void Graphic3d_Structure::SetTransformation ( const Handle< Geom_Transformation > &  theTrsf)

Modifies the current local transformation.

◆ SetTransformPersistence()

void Graphic3d_Structure::SetTransformPersistence ( const Handle< Graphic3d_TransformPers > &  theTrsfPers)

Modifies the current transform persistence (pan, zoom or rotate)

◆ SetVisible()

void Graphic3d_Structure::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.

◆ SetVisual()

virtual void Graphic3d_Structure::SetVisual ( const Graphic3d_TypeOfStructure  AVisual)
virtual

Modifies the visualisation mode for the structure <me>.

◆ SetZLayer()

void Graphic3d_Structure::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.

◆ SetZoomLimit()

void Graphic3d_Structure::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.

◆ Standard_DEPRECATED()

Graphic3d_Structure::Standard_DEPRECATED ( "This method is deprecated - SetTransformation() should be called instead"  ) const &
inline

◆ Transformation()

const Handle< Geom_Transformation >& Graphic3d_Structure::Transformation ( ) const
inline

Return local transformation.

◆ TransformBoundaries()

static void Graphic3d_Structure::TransformBoundaries ( const gp_Trsf theTrsf,
Standard_Real theXMin,
Standard_Real theYMin,
Standard_Real theZMin,
Standard_Real theXMax,
Standard_Real theYMax,
Standard_Real theZMax 
)
staticprotected

Transforms boundaries with <theTrsf> transformation.

◆ TransformPersistence()

const Handle< Graphic3d_TransformPers >& Graphic3d_Structure::TransformPersistence ( ) const
inline
Returns
transform persistence of the presentable object.

◆ Transforms()

static void Graphic3d_Structure::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 
)
static

Transforms theX, theY, theZ with the transformation theTrsf.

◆ UnHighlight()

void Graphic3d_Structure::UnHighlight ( )

Suppresses the highlight for the structure <me> in all the views of the visualiser.

◆ Visual()

Graphic3d_TypeOfStructure Graphic3d_Structure::Visual ( ) const

Returns the visualisation mode for the structure <me>.

Field Documentation

◆ myAncestors

Graphic3d_IndexedMapOfAddress Graphic3d_Structure::myAncestors
protected

◆ myComputeVisual

Graphic3d_TypeOfStructure Graphic3d_Structure::myComputeVisual
protected

◆ myCStructure

Handle< Graphic3d_CStructure > Graphic3d_Structure::myCStructure
protected

◆ myDescendants

Graphic3d_IndexedMapOfAddress Graphic3d_Structure::myDescendants
protected

◆ myOwner

Standard_Address Graphic3d_Structure::myOwner
protected

◆ myStructureManager

Graphic3d_StructureManager* Graphic3d_Structure::myStructureManager
protected

◆ myVisual

Graphic3d_TypeOfStructure Graphic3d_Structure::myVisual
protected

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