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. More...

#include <Graphic3d_Structure.hxx>

Inheritance diagram for Graphic3d_Structure:

[legend]

Public Member Functions
	Graphic3d_Structure (const occ::handle< Graphic3d_StructureManager > &theManager, const occ::handle< Graphic3d_Structure > &theLinkPrs=occ::handle< Graphic3d_Structure >())
	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.

virtual void	Clear (const bool WithDestruction=true)
	if WithDestruction == true then suppress all the groups of primitives in the structure. and it is mandatory to create a new group in <me>. if WithDestruction == 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.

	~Graphic3d_Structure () override
	Suppresses the structure <me>. It will be erased at the next screen update.

virtual void	Display ()
	Displays the structure <me> in all the views of the visualiser.

Graphic3d_DisplayPriority	DisplayPriority () const
	Returns the current display priority for this structure.

void	SetDisplayPriority (const Graphic3d_DisplayPriority thePriority)
	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. Warning: If structure is displayed then the SetDisplayPriority method erases it and displays with the new priority. Raises Graphic3d_PriorityDefinitionError if Priority is greater than 10 or a negative value.

instead of integer number to	SetDisplayPriority ()") void SetDisplayPriority( const int thePriority)

void	ResetDisplayPriority ()
	Reset the current priority of the structure to the previous priority. Warning: If structure is displayed then the SetDisplayPriority() method erases it and displays with the previous priority.

virtual void	Erase ()
	Erases this structure in all the views of the visualiser.

void	Highlight (const occ::handle< Graphic3d_PresentationAttributes > &theStyle, const bool theToUpdateMgr=true)
	Highlights the structure in all the views with the given style.

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.

virtual void	CalculateBoundBox ()
	Computes axis-aligned bounding box of a structure.

void	SetInfiniteState (const bool theToSet)
	Sets infinite flag. When TRUE, the MinMaxValues method returns: theXMin = theYMin = theZMin = RealFirst(). theXMax = theYMax = theZMax = RealLast(). By default, structure is created not infinite but empty.

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.

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).

void	SetClipPlanes (const occ::handle< Graphic3d_SequenceOfHClipPlane > &thePlanes)
	Changes a sequence of clip planes slicing the structure on rendering.

const occ::handle< Graphic3d_SequenceOfHClipPlane > &	ClipPlanes () const
	Get clip planes slicing the structure on rendering.

void	SetVisible (const bool AValue)
	Modifies the visibility indicator to true or false for the structure <me>. The default value at the definition of <me> is true.

virtual void	SetVisual (const Graphic3d_TypeOfStructure AVisual)
	Modifies the visualisation mode for the structure <me>.

void	SetZoomLimit (const double LimitInf, const double 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.

void	SetIsForHighlight (const bool isForHighlight)
	Marks the structure <me> representing wired structure needed for highlight only so it won't be added to BVH tree.

void	UnHighlight ()
	Suppresses the highlight for the structure <me> in all the views of the visualiser.

virtual void	Compute ()

virtual void	computeHLR (const occ::handle< Graphic3d_Camera > &theProjector, occ::handle< Graphic3d_Structure > &theStructure)
	Returns the new Structure defined for the new visualization.

virtual void	RecomputeTransformation (const occ::handle< Graphic3d_Camera > &theProjector)
	Calculates structure transformation for specific camera position.

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

void	ReCompute (const occ::handle< Graphic3d_DataStructureManager > &aProjector)
	Forces a new construction of the structure <me> if <me> is displayed in <aProjetor> and TOS_COMPUTED.

const NCollection_Sequence< occ::handle< Graphic3d_Group > > &	Groups () const
	Returns the groups sequence included in this structure.

int	NumberOfGroups () const
	Returns the current number of groups in this structure.

occ::handle< Graphic3d_Group >	NewGroup ()
	Append new group to this structure.

occ::handle< Graphic3d_Group >	CurrentGroup ()
	Returns the last created group or creates new one if list is empty.

const occ::handle< Graphic3d_PresentationAttributes > &	HighlightStyle () const
	Returns the highlight attributes.

bool	IsDeleted () const
	Returns TRUE if this structure is deleted (after Remove() call).

virtual bool	IsDisplayed () const
	Returns the display indicator for this structure.

bool	IsEmpty () const
	Returns 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.

bool	IsInfinite () const
	Returns true if the structure <me> is infinite.

virtual bool	IsHighlighted () const
	Returns the highlight indicator for this structure.

bool	IsTransformed () const
	Returns TRUE if the structure is transformed.

bool	IsVisible () const
	Returns the visibility indicator for this structure.

Bnd_Box	MinMaxValues (const bool theToIgnoreInfiniteFlag=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 account 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.

Graphic3d_TypeOfStructure	Visual () const
	Returns the visualisation mode for the structure <me>.

void	Ancestors (NCollection_Map< occ::handle< Graphic3d_Structure > > &SG) const
	Returns the group of structures to which <me> is connected.

void	Connect (Graphic3d_Structure *theStructure, Graphic3d_TypeOfConnection theType, bool theWithCheck=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 true;.

void	Connect (const occ::handle< Graphic3d_Structure > &thePrs)

void	Descendants (NCollection_Map< occ::handle< Graphic3d_Structure > > &SG) const
	Returns the group of structures connected to <me>.

void	Disconnect (Graphic3d_Structure *theStructure)
	Suppress the connection between <AStructure> and <me>.

void	Remove (const occ::handle< Graphic3d_Structure > &thePrs)

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>.

void	RemoveAll ()

void	SetOwner (void *const theOwner)

void *	Owner () const

void	SetHLRValidation (const bool theFlag)

bool	HLRValidation () const
	Hidden parts stored in this structure are valid if: 1) the owner is defined. 2) they are not invalid.

const occ::handle< TopLoc_Datum3D > &	Transformation () const
	Return local transformation.

void	SetTransformation (const occ::handle< TopLoc_Datum3D > &theTrsf)
	Modifies the current local transformation.

void	SetTransformPersistence (const occ::handle< Graphic3d_TransformPers > &theTrsfPers)
	Modifies the current transform persistence (pan, zoom or rotate)

const occ::handle< Graphic3d_TransformPers > &	TransformPersistence () const

void	SetMutable (const bool theIsMutable)
	Sets if the structure location has mutable nature (content or location will be changed regularly).

bool	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 ones.

Graphic3d_TypeOfStructure	ComputeVisual () const

void	GraphicClear (const bool WithDestruction)
	Clears the structure <me>.

void	GraphicConnect (const occ::handle< Graphic3d_Structure > &theDaughter)

void	GraphicDisconnect (const occ::handle< Graphic3d_Structure > &theDaughter)

void	GraphicTransform (const occ::handle< TopLoc_Datum3D > &theTrsf)
	Internal method which sets new transformation without calling graphic manager callbacks.

int	Identification () const
	Returns the identification number of this structure.

void	Remove (Graphic3d_Structure *thePtr, const Graphic3d_TypeOfConnection theType)
	Suppress the structure in the list of descendants or in the list of ancestors.

void	SetComputeVisual (const Graphic3d_TypeOfStructure theVisual)

const occ::handle< Graphic3d_CStructure > &	CStructure () const
	Returns the low-level structure.

virtual void	DumpJson (Standard_OStream &theOStream, int theDepth=-1) const
	Dumps the content of me into the stream.

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.

Static Public Member Functions
static bool	AcceptConnection (Graphic3d_Structure theStructure1, Graphic3d_Structure theStructure2, Graphic3d_TypeOfConnection theType)
	Returns true if the connection is possible between <AStructure1> and <AStructure2> without a creation of a cycle.

static void	Network (Graphic3d_Structure theStructure, const Graphic3d_TypeOfConnection theType, NCollection_Map< Graphic3d_Structure > &theSet)
	Returns <ASet> the group of structures :

static void	PrintNetwork (const occ::handle< Graphic3d_Structure > &AStructure, const Graphic3d_TypeOfConnection AType)
	Prints information about the network associated with the structure <AStructure>.

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
bool	AppendDescendant (Graphic3d_Structure *theDescendant)
	Appends new descendant structure.

bool	RemoveDescendant (Graphic3d_Structure *theDescendant)
	Removes the given descendant structure.

bool	AppendAncestor (Graphic3d_Structure *theAncestor)
	Appends new ancestor structure.

bool	RemoveAncestor (Graphic3d_Structure *theAncestor)
	Removes the given ancestor structure.

void	clear (const bool WithDestruction)
	Clears all the groups of primitives in the structure.

void	erase ()
	Erases this structure in all the views of the visualiser.

Protected Attributes
Graphic3d_StructureManager *	myStructureManager

occ::handle< Graphic3d_CStructure >	myCStructure

NCollection_IndexedMap< Graphic3d_Structure * >	myAncestors

NCollection_IndexedMap< Graphic3d_Structure * >	myDescendants

void *	myOwner

Graphic3d_TypeOfStructure	myVisual

Graphic3d_TypeOfStructure	myComputeVisual

Additional Inherited Members
Public Types inherited from Standard_Transient
typedef void	base_type
	Returns a type descriptor about this object.

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.

Constructor & Destructor Documentation

◆ Graphic3d_Structure()

Graphic3d_Structure::Graphic3d_Structure	(	const occ::handle< Graphic3d_StructureManager > &	theManager,
		const occ::handle< Graphic3d_Structure > &	theLinkPrs = occ::handle< Graphic3d_Structure >() )

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.

Parameters

theManager	structure manager holding this structure
theLinkPrs	another structure for creating a shadow (linked) structure

◆ ~Graphic3d_Structure()

Graphic3d_Structure::~Graphic3d_Structure ( )

override

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

Member Function Documentation

◆ AcceptConnection()

static bool Graphic3d_Structure::AcceptConnection	(	Graphic3d_Structure *	theStructure1,
		Graphic3d_Structure *	theStructure2,
		Graphic3d_TypeOfConnection	theType )

static

Returns 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 ( NCollection_Map< occ::handle< Graphic3d_Structure > > & SG ) const

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

◆ AppendAncestor()

bool Graphic3d_Structure::AppendAncestor ( Graphic3d_Structure * theAncestor )

protected

Appends new ancestor structure.

◆ AppendDescendant()

bool Graphic3d_Structure::AppendDescendant ( Graphic3d_Structure * 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()

void Graphic3d_Structure::clear ( const bool WithDestruction )

protected

Clears all the groups of primitives in the structure.

◆ Clear()

virtual void Graphic3d_Structure::Clear ( const bool WithDestruction = true )

inlinevirtual

if WithDestruction == true then suppress all the groups of primitives in the structure. and it is mandatory to create a new group in <me>. if WithDestruction == 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.

Reimplemented in PrsMgr_Presentation.

◆ ClipPlanes()

const occ::handle< Graphic3d_SequenceOfHClipPlane > & Graphic3d_Structure::ClipPlanes ( ) const

inline

Get clip planes slicing the structure on rendering.

Returns: set of clip planes.

◆ Compute()

virtual void Graphic3d_Structure::Compute ( )

inlinevirtual

Reimplemented in PrsMgr_Presentation.

◆ computeHLR()

virtual void Graphic3d_Structure::computeHLR	(	const occ::handle< Graphic3d_Camera > &	theProjector,
		occ::handle< Graphic3d_Structure > &	theStructure )

inlinevirtual

Returns the new Structure defined for the new visualization.

Reimplemented in PrsMgr_Presentation.

◆ ComputeVisual()

Graphic3d_TypeOfStructure Graphic3d_Structure::ComputeVisual ( ) const

inline

◆ Connect() [1/2]

void Graphic3d_Structure::Connect ( const occ::handle< Graphic3d_Structure > & thePrs )

inline

Deprecated: ("Deprecated short-cut")

◆ Connect() [2/2]

void Graphic3d_Structure::Connect	(	Graphic3d_Structure *	theStructure,
		Graphic3d_TypeOfConnection	theType,
		bool	theWithCheck = 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 true;.

◆ CStructure()

const occ::handle< Graphic3d_CStructure > & Graphic3d_Structure::CStructure ( ) const

inline

Returns the low-level structure.

◆ CurrentGroup()

occ::handle< Graphic3d_Group > Graphic3d_Structure::CurrentGroup ( )

inline

Returns the last created group or creates new one if list is empty.

◆ Descendants()

void Graphic3d_Structure::Descendants ( NCollection_Map< occ::handle< Graphic3d_Structure > > & SG ) const

Returns the group of structures connected to <me>.

◆ Disconnect()

void Graphic3d_Structure::Disconnect ( Graphic3d_Structure * theStructure )

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.

Reimplemented in PrsMgr_Presentation.

◆ DisplayPriority()

Graphic3d_DisplayPriority Graphic3d_Structure::DisplayPriority ( ) const

inline

Returns the current display priority for this structure.

◆ DumpJson()

virtual void Graphic3d_Structure::DumpJson	(	Standard_OStream &	theOStream,
		int	theDepth = -1 ) const

virtual

Dumps the content of me into the stream.

Reimplemented in Prs3d_PresentationShadow, and PrsMgr_Presentation.

◆ Erase()

virtual void Graphic3d_Structure::Erase ( )

inlinevirtual

Erases this structure in all the views of the visualiser.

Reimplemented in PrsMgr_Presentation.

◆ erase()

void Graphic3d_Structure::erase ( )

protected

Erases this structure in all the views of the visualiser.

◆ GetZLayer()

Graphic3d_ZLayerId Graphic3d_Structure::GetZLayer ( ) const

inline

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 bool WithDestruction )

Clears the structure <me>.

◆ GraphicConnect()

void Graphic3d_Structure::GraphicConnect ( const occ::handle< Graphic3d_Structure > & theDaughter )

inline

◆ GraphicDisconnect()

void Graphic3d_Structure::GraphicDisconnect ( const occ::handle< Graphic3d_Structure > & theDaughter )

inline

◆ GraphicTransform()

void Graphic3d_Structure::GraphicTransform ( const occ::handle< TopLoc_Datum3D > & theTrsf )

inline

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

◆ Groups()

const NCollection_Sequence< occ::handle< Graphic3d_Group > > & Graphic3d_Structure::Groups ( ) const

inline

Returns the groups sequence included in this structure.

◆ Highlight()

void Graphic3d_Structure::Highlight	(	const occ::handle< Graphic3d_PresentationAttributes > &	theStyle,
		const bool	theToUpdateMgr = true )

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

Parameters

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

◆ HighlightStyle()

const occ::handle< Graphic3d_PresentationAttributes > & Graphic3d_Structure::HighlightStyle ( ) const

inline

Returns the highlight attributes.

◆ HLRValidation()

bool Graphic3d_Structure::HLRValidation ( ) const

inline

Hidden parts stored in this structure are valid if: 1) the owner is defined. 2) they are not invalid.

◆ Identification()

int Graphic3d_Structure::Identification ( ) const

inline

Returns the identification number of this structure.

◆ IsDeleted()

bool Graphic3d_Structure::IsDeleted ( ) const

inline

Returns TRUE if this structure is deleted (after Remove() call).

◆ IsDisplayed()

virtual bool Graphic3d_Structure::IsDisplayed ( ) const

inlinevirtual

Returns the display indicator for this structure.

Reimplemented in PrsMgr_Presentation.

◆ IsEmpty()

bool Graphic3d_Structure::IsEmpty ( ) const

Returns 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 bool Graphic3d_Structure::IsHighlighted ( ) const

inlinevirtual

Returns the highlight indicator for this structure.

◆ IsInfinite()

bool Graphic3d_Structure::IsInfinite ( ) const

inline

Returns true if the structure <me> is infinite.

◆ IsMutable()

bool Graphic3d_Structure::IsMutable ( ) const

inline

Returns true if structure has mutable nature (content or location are be changed regularly). Mutable structure will be managed in different way than static ones.

◆ IsTransformed()

bool Graphic3d_Structure::IsTransformed ( ) const

inline

Returns TRUE if the structure is transformed.

◆ IsVisible()

bool Graphic3d_Structure::IsVisible ( ) const

inline

Returns the visibility indicator for this structure.

◆ MinMaxValues()

Bnd_Box Graphic3d_Structure::MinMaxValues ( const bool theToIgnoreInfiniteFlag = 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 account 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	(	Graphic3d_Structure *	theStructure,
		const Graphic3d_TypeOfConnection	theType,
		NCollection_Map< Graphic3d_Structure * > &	theSet )

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()

occ::handle< Graphic3d_Group > Graphic3d_Structure::NewGroup ( )

Append new group to this structure.

◆ NumberOfGroups()

int Graphic3d_Structure::NumberOfGroups ( ) const

inline

Returns the current number of groups in this structure.

◆ Owner()

void * Graphic3d_Structure::Owner ( ) const

inline

◆ PrintNetwork()

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

static

Prints information 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 occ::handle< Graphic3d_DataStructureManager > & aProjector )

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

◆ RecomputeTransformation()

virtual void Graphic3d_Structure::RecomputeTransformation ( const occ::handle< Graphic3d_Camera > & theProjector )

inlinevirtual

Calculates structure transformation for specific camera position.

Reimplemented in PrsMgr_Presentation.

◆ Remove() [1/3]

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/3]

void Graphic3d_Structure::Remove ( const occ::handle< Graphic3d_Structure > & thePrs )

inline

Deprecated: ("Deprecated alias for Disconnect()")

◆ Remove() [3/3]

void Graphic3d_Structure::Remove	(	Graphic3d_Structure *	thePtr,
		const Graphic3d_TypeOfConnection	theType )

Suppress the structure in the list of descendants or in the list of ancestors.

◆ RemoveAll()

void Graphic3d_Structure::RemoveAll ( )

inline

Deprecated: ("Deprecated alias for DisconnectAll()")

◆ RemoveAncestor()

bool Graphic3d_Structure::RemoveAncestor ( Graphic3d_Structure * theAncestor )

protected

Removes the given ancestor structure.

◆ RemoveDescendant()

bool Graphic3d_Structure::RemoveDescendant ( Graphic3d_Structure * theDescendant )

protected

Removes the given descendant structure.

◆ ResetDisplayPriority()

void Graphic3d_Structure::ResetDisplayPriority ( )

Reset the current priority of the structure to the previous priority. Warning: If structure is displayed then the SetDisplayPriority() method erases it and displays with the previous priority.

◆ SetClipPlanes()

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

inline

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

Parameters

[in] thePlanes the set of clip planes.

◆ SetComputeVisual()

void Graphic3d_Structure::SetComputeVisual ( const Graphic3d_TypeOfStructure theVisual )

inline

◆ SetDisplayPriority() [1/2]

instead of integer number to Graphic3d_Structure::SetDisplayPriority ( ) const

inline

Deprecated: ("Deprecated since OCCT7.7, Graphic3d_DisplayPriority should be passed "

◆ SetDisplayPriority() [2/2]

void Graphic3d_Structure::SetDisplayPriority ( const Graphic3d_DisplayPriority thePriority )

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. Warning: If structure is displayed then the SetDisplayPriority method erases it and displays with the new priority. Raises Graphic3d_PriorityDefinitionError if Priority is greater than 10 or a negative value.

◆ SetHLRValidation()

void Graphic3d_Structure::SetHLRValidation ( const bool theFlag )

inline

◆ SetInfiniteState()

void Graphic3d_Structure::SetInfiniteState ( const bool theToSet )

inline

Sets infinite flag. When TRUE, the MinMaxValues method returns: theXMin = theYMin = theZMin = RealFirst(). theXMax = theYMax = theZMax = RealLast(). By default, structure is created not infinite but empty.

◆ SetIsForHighlight()

void Graphic3d_Structure::SetIsForHighlight ( const bool isForHighlight )

inline

Marks the structure <me> representing wired structure needed for highlight only so it won't be added to BVH tree.

◆ SetMutable()

void Graphic3d_Structure::SetMutable ( const bool theIsMutable )

inline

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

◆ SetOwner()

void Graphic3d_Structure::SetOwner ( void *const theOwner )

inline

◆ SetTransformation()

void Graphic3d_Structure::SetTransformation ( const occ::handle< TopLoc_Datum3D > & theTrsf )

Modifies the current local transformation.

◆ SetTransformPersistence()

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

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

◆ SetVisible()

void Graphic3d_Structure::SetVisible ( const bool AValue )

Modifies the visibility indicator to true or false for the structure <me>. The default value at the definition of <me> is 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 double	LimitInf,
		const double	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.

◆ Transformation()

const occ::handle< TopLoc_Datum3D > & Graphic3d_Structure::Transformation ( ) const

inline

Return local transformation.

◆ TransformPersistence()

const occ::handle< Graphic3d_TransformPers > & Graphic3d_Structure::TransformPersistence ( ) const

inline

Returns: transform persistence of the presentable object.

◆ 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

inline

Returns the visualisation mode for the structure <me>.

Field Documentation

◆ myAncestors

NCollection_IndexedMap<Graphic3d_Structure*> Graphic3d_Structure::myAncestors

protected

◆ myComputeVisual

Graphic3d_TypeOfStructure Graphic3d_Structure::myComputeVisual

protected

◆ myCStructure

occ::handle<Graphic3d_CStructure> Graphic3d_Structure::myCStructure

protected

◆ myDescendants

NCollection_IndexedMap<Graphic3d_Structure*> Graphic3d_Structure::myDescendants

protected

◆ myOwner

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

Graphic3d_Structure.hxx

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Graphic3d_Structure()

◆ ~Graphic3d_Structure()

Member Function Documentation

◆ AcceptConnection()

◆ Ancestors()

◆ AppendAncestor()

◆ AppendDescendant()

◆ CalculateBoundBox()

◆ clear()

◆ Clear()

◆ ClipPlanes()

◆ Compute()

◆ computeHLR()

◆ ComputeVisual()

◆ Connect() [1/2]

◆ Connect() [2/2]

◆ CStructure()

◆ CurrentGroup()

◆ Descendants()

◆ Disconnect()

◆ DisconnectAll()

◆ Display()

◆ DisplayPriority()

◆ DumpJson()

◆ Erase()

◆ erase()

◆ GetZLayer()

◆ GraphicClear()

◆ GraphicConnect()

◆ GraphicDisconnect()

◆ GraphicTransform()

◆ Groups()

◆ Highlight()

◆ HighlightStyle()

◆ HLRValidation()

◆ Identification()

◆ IsDeleted()

◆ IsDisplayed()

◆ IsEmpty()

◆ IsHighlighted()

◆ IsInfinite()

◆ IsMutable()

◆ IsTransformed()

◆ IsVisible()

◆ MinMaxValues()

◆ Network()

◆ NewGroup()

◆ NumberOfGroups()

◆ Owner()

◆ PrintNetwork()

◆ ReCompute() [1/2]

◆ ReCompute() [2/2]

◆ RecomputeTransformation()

◆ Remove() [1/3]

◆ Remove() [2/3]

◆ Remove() [3/3]

◆ RemoveAll()

◆ RemoveAncestor()

◆ RemoveDescendant()

◆ ResetDisplayPriority()

◆ SetClipPlanes()

◆ SetComputeVisual()

◆ SetDisplayPriority() [1/2]

◆ SetDisplayPriority() [2/2]

◆ SetHLRValidation()

◆ SetInfiniteState()

◆ SetIsForHighlight()

◆ SetMutable()

◆ SetOwner()

◆ SetTransformation()

◆ SetTransformPersistence()

◆ SetVisible()

◆ SetVisual()