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:

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

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	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_SequenceOfGroup &	Groups () const
	Returns the groups sequence included in the structure <me> (internal storage). More...

Standard_Integer	NumberOfGroups () const
	Returns the current number of groups in the structure <me>. More...

Handle< Graphic3d_Group >	NewGroup ()
	Append new group to this structure. More...

const Quantity_Color &	HighlightColor () 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_AspectLine3d >	Line3dAspect () const
	Returns the values of the current default attributes. More...

Handle< Graphic3d_AspectMarker3d >	Marker3dAspect () 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_AspectText3d >	Text3dAspect () 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_Transient &	operator= (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...

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 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
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 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
Graphic3d_StructureManagerPtr	myStructureManager

Graphic3d_StructureManagerPtr	myFirstStructureManager

Graphic3d_TypeOfStructure	myComputeVisual

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

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

inline

Member Function Documentation

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

void Graphic3d_Structure::Ancestors ( Graphic3d_MapOfStructure & SG ) const

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

Standard_Boolean Graphic3d_Structure::AppendAncestor ( const Standard_Address theAncestor )

protected

Appends new ancestor structure.

Standard_Boolean Graphic3d_Structure::AppendDescendant ( const Standard_Address theDescendant )

protected

Appends new descendant structure.

void Graphic3d_Structure::CalculateBoundBox ( )

Computes axis-aligned bounding box of a structure. Category: Methods to modify the class definition.

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.

Graphic3d_TypeOfComposition Graphic3d_Structure::Composition ( ) const

Returns the type of composition applied to matrices of transformation of <me>.

virtual void Graphic3d_Structure::Compute ( )

virtual

Reimplemented in PrsMgr_Prs.

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.

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

virtual

Returns the new Structure defined for the new visualization.

Reimplemented in Prs3d_Presentation, and PrsMgr_Prs.

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.

virtual void Graphic3d_Structure::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 in Prs3d_Presentation, and PrsMgr_Prs.

Graphic3d_TypeOfStructure Graphic3d_Structure::ComputeVisual ( ) const

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

Standard_Boolean Graphic3d_Structure::ContainsFacet ( ) const

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

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

Returns the low-level structure.

void Graphic3d_Structure::Descendants ( Graphic3d_MapOfStructure & SG ) const

Returns the group of structures connected to <me>.

virtual void Graphic3d_Structure::Destroy ( )

virtual

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

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

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

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

virtual void Graphic3d_Structure::Display ( )

virtual

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

Standard_Integer Graphic3d_Structure::DisplayPriority ( ) const

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

virtual void Graphic3d_Structure::Erase ( )

virtual

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

Handle< Graphic3d_AspectFillArea3d > Graphic3d_Structure::FillArea3dAspect ( ) const

Returns the values of the current default attributes.

const Graphic3d_SequenceOfHClipPlane& Graphic3d_Structure::GetClipPlanes ( ) const

Get clip planes slicing the structure on rendering.

Returns: set of clip planes.

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

void Graphic3d_Structure::GraphicClear ( const Standard_Boolean WithDestruction )

Clears the structure <me>.

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

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

void Graphic3d_Structure::GraphicHighlight ( const Aspect_TypeOfHighlightMethod Method )

Highlights the structure <me>.

void Graphic3d_Structure::GraphicTransform ( const TColStd_Array2OfReal & AMatrix )

void Graphic3d_Structure::GraphicUnHighlight ( )

Suppress the highlight for the structure <me>.

const Graphic3d_SequenceOfGroup& Graphic3d_Structure::Groups ( ) const

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

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

const Quantity_Color& Graphic3d_Structure::HighlightColor ( ) const

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

Standard_Boolean Graphic3d_Structure::HLRValidation ( ) const

Standard_Integer Graphic3d_Structure::Identification ( ) const

Returns the identification number of the structure <me>.

Standard_Boolean Graphic3d_Structure::IsDeleted ( ) const

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

virtual Standard_Boolean Graphic3d_Structure::IsDisplayed ( ) const

virtual

Returns the display indicator for the structure <me>.

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.

virtual Standard_Boolean Graphic3d_Structure::IsHighlighted ( ) const

virtual

Returns the highlight indicator for the structure <me>.

Standard_Boolean Graphic3d_Structure::IsInfinite ( ) const

Returns Standard_True if the structure <me> is infinite.

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.

Standard_Boolean Graphic3d_Structure::IsRotated ( ) const

Returns Standard_True if the structure <me> is rotated. <=> The transformation != Identity, != Scale, != Translation.

Standard_Boolean Graphic3d_Structure::IsTransformed ( ) const

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

Standard_Boolean Graphic3d_Structure::IsVisible ( ) const

Returns the visibility indicator for the structure <me>.

Handle< Graphic3d_AspectLine3d > Graphic3d_Structure::Line3dAspect ( ) const

Returns the values of the current default attributes.

Handle< Graphic3d_AspectMarker3d > Graphic3d_Structure::Marker3dAspect ( ) const

Returns the current group of graphic attributes used for 3d marker primitives.

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.

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

Handle< Graphic3d_Group > Graphic3d_Structure::NewGroup ( )

Append new group to this structure.

Standard_Integer Graphic3d_Structure::NumberOfGroups ( ) const

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

Standard_Address Graphic3d_Structure::Owner ( ) const

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

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

void Graphic3d_Structure::ReCompute ( )

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

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.

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.

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.

Standard_Boolean Graphic3d_Structure::RemoveAncestor ( const Standard_Address theAncestor )

protected

Removes the given ancestor structure.

Standard_Boolean Graphic3d_Structure::RemoveDescendant ( const Standard_Address theDescendant )

protected

Removes the given descendant structure.

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.

void Graphic3d_Structure::SetClipPlanes ( const Graphic3d_SequenceOfHClipPlane & thePlanes )

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

Parameters

thePlanes [in] the set of clip planes.

void Graphic3d_Structure::SetComputeVisual ( const Graphic3d_TypeOfStructure AVisual )

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.

void Graphic3d_Structure::SetHLRValidation ( const Standard_Boolean AFlag )

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.

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

void Graphic3d_Structure::SetMutable ( const Standard_Boolean theIsMutable )

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

void Graphic3d_Structure::SetOwner ( const Standard_Address Owner )

void Graphic3d_Structure::SetPrimitivesAspect ( const Handle< Graphic3d_AspectLine3d > & CTX )

Modifies the default attributes for lines in the structure <me>.

void Graphic3d_Structure::SetPrimitivesAspect ( const Handle< Graphic3d_AspectFillArea3d > & CTX )

Modifies the default attributes for faces in the structure <me>.

void Graphic3d_Structure::SetPrimitivesAspect ( const Handle< Graphic3d_AspectText3d > & CTX )

Modifies the default attributes for text in the structure <me>.

void Graphic3d_Structure::SetPrimitivesAspect ( const Handle< Graphic3d_AspectMarker3d > & CTX )

Modifies the default attributes for markers in the structure <me>.

void Graphic3d_Structure::SetTransform	(	const TColStd_Array2OfReal &	AMatrix,
		const Graphic3d_TypeOfComposition	AType
	)

Modifies the current local modelling transformation in the structure <me>.

It is defined as a 4*4 real matrix.

| 0 0 0 1 |

TypeOfComposition : TOC_REPLACE TOC_POSTCONCATENATE

Then the modified Local Modelling Transformation is composed with the current Global Modelling Transformation to create a new Composite Modelling Transformation.

The compose type specifies the role of the current local modelling transformation (L) in composing the new value for the current local modelling transformation (L'), which is then combined with the current global modelling transforma- tion (G) to calculate the new composite modelling transfor- mation (C).

TOC_REPLACE The transformation matrix (T) replaces the value of current local modelling transformation (L).

L' <- T C <- G x L'

TOC_POSTCONCATENATE The current local modelling transformation (L) is multiplied by the transformation matrix (T):

L' <- T x L C <- G x L'

Category: Methods to manage the structure transformation Warning: Raises TransformError if the matrix is not a 4x4 matrix.

void Graphic3d_Structure::SetTransformPersistence	(	const Graphic3d_TransModeFlags &	AFlag,
		const gp_Pnt &	APoint
	)

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

void Graphic3d_Structure::SetTransformPersistence ( const Graphic3d_TransModeFlags & AFlag )

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.

virtual void Graphic3d_Structure::SetVisual ( const Graphic3d_TypeOfStructure AVisual )

virtual

Modifies the visualisation mode for the structure <me>.

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.

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.

Handle< Graphic3d_AspectText3d > Graphic3d_Structure::Text3dAspect ( ) const

Returns the values of the current default attributes.

void Graphic3d_Structure::Transform ( TColStd_Array2OfReal & AMatrix ) const

Returns the transformation associated with the structure <me>.

static void Graphic3d_Structure::TransformBoundaries	(	const TColStd_Array2OfReal &	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.

Graphic3d_TransModeFlags Graphic3d_Structure::TransformPersistenceMode ( ) const

Get the current modelling transform persistence (pan, zoom or rotate)

gp_Pnt Graphic3d_Structure::TransformPersistencePoint ( ) const

Get the current point of relative modelling transform persistence.

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

static

Transforms <X>, <Y>, <Z> with the transformation <ATrsf>.

static Graphic3d_Vector Graphic3d_Structure::Transforms	(	const TColStd_Array2OfReal &	ATrsf,
		const Graphic3d_Vector &	Coord
	)

static

Transforms <Coord> with the transformation <ATrsf>.

static Graphic3d_Vertex Graphic3d_Structure::Transforms	(	const TColStd_Array2OfReal &	ATrsf,
		const Graphic3d_Vertex &	Coord
	)

static

Transforms <Coord> with the transformation <ATrsf>.

void Graphic3d_Structure::UnHighlight ( )

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

Graphic3d_TypeOfStructure Graphic3d_Structure::Visual ( ) const

Returns the visualisation mode for the structure <me>.

Field Documentation

Graphic3d_TypeOfStructure Graphic3d_Structure::myComputeVisual

protected

Graphic3d_StructureManagerPtr Graphic3d_Structure::myFirstStructureManager

protected

Graphic3d_StructureManagerPtr Graphic3d_Structure::myStructureManager

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

Static Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

| 0 0 0 1 |

Field Documentation