Provide tool for management of ClippingPlane section of document. Provide tool to store, retrieve, remove and modify clipping planes. Each clipping plane consists of gp_Pln and its name. More...

#include <XCAFDoc_ClippingPlaneTool.hxx>

Inheritance diagram for XCAFDoc_ClippingPlaneTool:

[legend]

Public Member Functions
	XCAFDoc_ClippingPlaneTool ()

TDF_Label	BaseLabel () const
	returns the label under which ClippingPlanes are stored

Standard_Boolean	IsClippingPlane (const TDF_Label &theLabel) const
	Returns True if label belongs to a ClippingPlane table and is a ClippingPlane definition.

Standard_Boolean	GetClippingPlane (const TDF_Label &theLabel, gp_Pln &thePlane, TCollection_ExtendedString &theName, Standard_Boolean &theCapping) const
	Returns ClippingPlane defined by label lab Returns False if the label is not in ClippingPlane table or does not define a ClippingPlane.

Standard_Boolean	GetClippingPlane (const TDF_Label &theLabel, gp_Pln &thePlane, Handle< TCollection_HAsciiString > &theName, Standard_Boolean &theCapping) const
	Returns ClippingPlane defined by label lab Returns False if the label is not in ClippingPlane table or does not define a ClippingPlane.

TDF_Label	AddClippingPlane (const gp_Pln &thePlane, const TCollection_ExtendedString &theName, const Standard_Boolean theCapping) const
	Adds a clipping plane definition to a ClippingPlane table and returns its label (returns existing label if the same clipping plane is already defined)

TDF_Label	AddClippingPlane (const gp_Pln &thePlane, const Handle< TCollection_HAsciiString > &theName, const Standard_Boolean theCapping) const
	Adds a clipping plane definition to a ClippingPlane table and returns its label (returns existing label if the same clipping plane is already defined)

TDF_Label	AddClippingPlane (const gp_Pln &thePlane, const TCollection_ExtendedString &theName) const
	Adds a clipping plane definition to a ClippingPlane table and returns its label (returns existing label if the same clipping plane is already defined)

TDF_Label	AddClippingPlane (const gp_Pln &thePlane, const Handle< TCollection_HAsciiString > &theName) const
	Adds a clipping plane definition to a ClippingPlane table and returns its label (returns existing label if the same clipping plane is already defined)

Standard_Boolean	RemoveClippingPlane (const TDF_Label &theLabel) const
	Removes clipping plane from the ClippingPlane table Return false and do nothing if clipping plane is referenced in at least one View.

void	GetClippingPlanes (TDF_LabelSequence &Labels) const
	Returns a sequence of clipping planes currently stored in the ClippingPlane table.

void	UpdateClippingPlane (const TDF_Label &theLabelL, const gp_Pln &thePlane, const TCollection_ExtendedString &theName) const
	Sets new value of plane and name to the given clipping plane label or do nothing, if the given label is not a clipping plane label.

void	SetCapping (const TDF_Label &theClippingPlaneL, const Standard_Boolean theCapping)
	Set new value of capping for given clipping plane label.

Standard_Boolean	GetCapping (const TDF_Label &theClippingPlaneL) const
	Get capping value for given clipping plane label Return capping value.

Standard_Boolean	GetCapping (const TDF_Label &theClippingPlaneL, Standard_Boolean &theCapping) const
	Get capping value for given clipping plane label Return true if Label is valid abd capping is exist.

const Standard_GUID &	ID () const override
	Returns the ID of the attribute.

Public Member Functions inherited from TDataStd_GenericEmpty
void	Restore (const Handle< TDF_Attribute > &) override
	Restores the backuped contents from <anAttribute> into this one. It is used when aborting a transaction.

void	Paste (const Handle< TDF_Attribute > &, const Handle< TDF_RelocationTable > &) const override
	This method is different from the "Copy" one, because it is used when copying an attribute from a source structure into a target structure. This method may paste the contents of <me> into <intoAttribute>.

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

Public Member Functions inherited from TDF_Attribute
virtual void	SetID (const Standard_GUID &)
	Sets specific ID of the attribute (supports several attributes of one type at the same label feature).

virtual void	SetID ()
	Sets default ID defined in nested class (to be used for attributes having User ID feature).

const TDF_Label	Label () const
	Returns the label to which the attribute is attached. If the label is not included in a DF, the label is null. See Label. Warning If the label is not included in a data framework, it is null. This function should not be redefined inline.

Standard_Integer	Transaction () const
	Returns the transaction index in which the attribute has been created or modified.

Standard_Integer	UntilTransaction () const
	Returns the upper transaction index until which the attribute is/was valid. This number may vary. A removed attribute validity range is reduced to its transaction index.

Standard_Boolean	IsValid () const
	Returns true if the attribute is valid; i.e. not a backuped or removed one.

Standard_Boolean	IsNew () const
	Returns true if the attribute has no backup.

Standard_Boolean	IsForgotten () const
	Returns true if the attribute forgotten status is set.

Standard_Boolean	IsAttribute (const Standard_GUID &anID) const
	Returns true if it exists an associated attribute of <me> with <anID> as ID.

Standard_Boolean	FindAttribute (const Standard_GUID &anID, Handle< TDF_Attribute > &anAttribute) const
	Finds an associated attribute of <me>, according to <anID>. the returned <anAttribute> is a valid one. The method returns True if found, False otherwise. A removed attribute cannot be found using this method.

template<class T >
Standard_Boolean	FindAttribute (const Standard_GUID &theID, Handle< T > &theAttr) const
	Safe variant for arbitrary type of argument.

void	AddAttribute (const Handle< TDF_Attribute > &other) const
	Adds an Attribute <other> to the label of <me>.Raises if there is already one of the same GUID fhan <other>.

Standard_Boolean	ForgetAttribute (const Standard_GUID &aguid) const
	Forgets the Attribute of GUID <aguid> associated to the label of <me>. Be careful that if <me> is the attribute of <guid>, <me> will have a null label after this call. If the attribute doesn't exist returns False. Otherwise returns True.

void	ForgetAllAttributes (const Standard_Boolean clearChildren=Standard_True) const
	Forgets all the attributes attached to the label of <me>. Does it on the sub-labels if <clearChildren> is set to true. Of course, this method is compatible with Transaction & Delta mechanisms. Be careful that if <me> will have a null label after this call.

virtual void	AfterAddition ()
	Something to do after adding an Attribute to a label.

virtual void	BeforeRemoval ()
	Something to do before removing an Attribute from a label.

virtual void	BeforeForget ()
	Something to do before forgetting an Attribute to a label.

virtual void	AfterResume ()
	Something to do after resuming an Attribute from a label.

virtual Standard_Boolean	AfterRetrieval (const Standard_Boolean forceIt=Standard_False)
	Something to do AFTER creation of an attribute by persistent-transient translation. The returned status says if AfterUndo has been performed (true) or if this callback must be called once again further (false). If <forceIt> is set to true, the method MUST perform and return true. Does nothing by default and returns true.

virtual Standard_Boolean	BeforeUndo (const Handle< TDF_AttributeDelta > &anAttDelta, const Standard_Boolean forceIt=Standard_False)
	Something to do before applying <anAttDelta>. The returned status says if AfterUndo has been performed (true) or if this callback must be called once again further (false). If <forceIt> is set to true, the method MUST perform and return true. Does nothing by default and returns true.

virtual Standard_Boolean	AfterUndo (const Handle< TDF_AttributeDelta > &anAttDelta, const Standard_Boolean forceIt=Standard_False)
	Something to do after applying <anAttDelta>. The returned status says if AfterUndo has been performed (true) or if this callback must be called once again further (false). If <forceIt> is set to true, the method MUST perform and return true. Does nothing by default and returns true.

virtual void	BeforeCommitTransaction ()
	A callback. By default does nothing. It is called by TDF_Data::CommitTransaction() method.

void	Backup ()
	Backups the attribute. The backuped attribute is flagged "Backuped" and not "Valid".

Standard_Boolean	IsBackuped () const
	Returns true if the attribute backup status is set. This status is set/unset by the Backup() method.

virtual Handle< TDF_Attribute >	BackupCopy () const
	Copies the attribute contents into a new other attribute. It is used by Backup().

virtual Handle< TDF_DeltaOnAddition >	DeltaOnAddition () const
	Makes an AttributeDelta because <me> appeared. The only known use of a redefinition of this method is to return a null handle (no delta).

virtual Handle< TDF_DeltaOnForget >	DeltaOnForget () const
	Makes an AttributeDelta because <me> has been forgotten.

virtual Handle< TDF_DeltaOnResume >	DeltaOnResume () const
	Makes an AttributeDelta because <me> has been resumed.

virtual Handle< TDF_DeltaOnModification >	DeltaOnModification (const Handle< TDF_Attribute > &anOldAttribute) const
	Makes a DeltaOnModification between <me> and.

virtual void	DeltaOnModification (const Handle< TDF_DeltaOnModification > &aDelta)
	Applies a DeltaOnModification to <me>.

virtual Handle< TDF_DeltaOnRemoval >	DeltaOnRemoval () const
	Makes a DeltaOnRemoval on <me> because <me> has disappeared from the DS.

virtual Handle< TDF_Attribute >	NewEmpty () const =0
	Returns an new empty attribute from the good end type. It is used by the copy algorithm.

virtual void	References (const Handle< TDF_DataSet > &aDataSet) const
	Adds the first level referenced attributes and labels to <aDataSet>.

virtual Standard_OStream &	Dump (Standard_OStream &anOS) const
	Dumps the minimum information about <me> on <aStream>.

Standard_OStream &	operator<< (Standard_OStream &anOS) const

virtual void	ExtendedDump (Standard_OStream &anOS, const TDF_IDFilter &aFilter, TDF_AttributeIndexedMap &aMap) const
	Dumps the attribute content on <aStream>, using <aMap> like this: if an attribute is not in the map, first put add it to the map and then dump it. Use the map rank instead of dumping each attribute field.

void	Forget (const Standard_Integer aTransaction)
	Forgets the attribute. <aTransaction> is the current transaction in which the forget is done. A forgotten attribute is also flagged not "Valid".

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 ()
	Destructor must be virtual.

virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.

Standard_Boolean	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.

Standard_Boolean	IsInstance (const Standard_CString theTypeName) const
	Returns a true value if this is an instance of TypeName.

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.

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.

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.

Standard_Integer	GetRefCount () const noexcept
	Get the reference counter of this object.

void	IncrementRefCounter () noexcept
	Increments the reference counter of this object.

Standard_Integer	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value.

virtual void	Delete () const
	Memory deallocator for transient classes.

Static Public Member Functions
static Handle< XCAFDoc_ClippingPlaneTool >	Set (const TDF_Label &theLabel)
	Creates (if not exist) ClippingPlaneTool.

static const Standard_GUID &	GetID ()

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.

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

Protected Member Functions inherited from TDF_Attribute
	TDF_Attribute ()
	Initializes fields.

Detailed Description

Provide tool for management of ClippingPlane section of document. Provide tool to store, retrieve, remove and modify clipping planes. Each clipping plane consists of gp_Pln and its name.

Constructor & Destructor Documentation

◆ XCAFDoc_ClippingPlaneTool()

XCAFDoc_ClippingPlaneTool::XCAFDoc_ClippingPlaneTool ( )

Member Function Documentation

◆ AddClippingPlane() [1/4]

TDF_Label XCAFDoc_ClippingPlaneTool::AddClippingPlane	(	const gp_Pln &	thePlane,
		const Handle< TCollection_HAsciiString > &	theName ) const

Adds a clipping plane definition to a ClippingPlane table and returns its label (returns existing label if the same clipping plane is already defined)

◆ AddClippingPlane() [2/4]

TDF_Label XCAFDoc_ClippingPlaneTool::AddClippingPlane	(	const gp_Pln &	thePlane,
		const Handle< TCollection_HAsciiString > &	theName,
		const Standard_Boolean	theCapping ) const

Adds a clipping plane definition to a ClippingPlane table and returns its label (returns existing label if the same clipping plane is already defined)

◆ AddClippingPlane() [3/4]

TDF_Label XCAFDoc_ClippingPlaneTool::AddClippingPlane	(	const gp_Pln &	thePlane,
		const TCollection_ExtendedString &	theName ) const

Adds a clipping plane definition to a ClippingPlane table and returns its label (returns existing label if the same clipping plane is already defined)

◆ AddClippingPlane() [4/4]

TDF_Label XCAFDoc_ClippingPlaneTool::AddClippingPlane	(	const gp_Pln &	thePlane,
		const TCollection_ExtendedString &	theName,
		const Standard_Boolean	theCapping ) const

Adds a clipping plane definition to a ClippingPlane table and returns its label (returns existing label if the same clipping plane is already defined)

◆ BaseLabel()

TDF_Label XCAFDoc_ClippingPlaneTool::BaseLabel ( ) const

returns the label under which ClippingPlanes are stored

◆ GetCapping() [1/2]

Standard_Boolean XCAFDoc_ClippingPlaneTool::GetCapping ( const TDF_Label & theClippingPlaneL ) const

Get capping value for given clipping plane label Return capping value.

◆ GetCapping() [2/2]

Standard_Boolean XCAFDoc_ClippingPlaneTool::GetCapping	(	const TDF_Label &	theClippingPlaneL,
		Standard_Boolean &	theCapping ) const

Get capping value for given clipping plane label Return true if Label is valid abd capping is exist.

◆ GetClippingPlane() [1/2]

Standard_Boolean XCAFDoc_ClippingPlaneTool::GetClippingPlane	(	const TDF_Label &	theLabel,
		gp_Pln &	thePlane,
		Handle< TCollection_HAsciiString > &	theName,
		Standard_Boolean &	theCapping ) const

Returns ClippingPlane defined by label lab Returns False if the label is not in ClippingPlane table or does not define a ClippingPlane.

◆ GetClippingPlane() [2/2]

Standard_Boolean XCAFDoc_ClippingPlaneTool::GetClippingPlane	(	const TDF_Label &	theLabel,
		gp_Pln &	thePlane,
		TCollection_ExtendedString &	theName,
		Standard_Boolean &	theCapping ) const

Returns ClippingPlane defined by label lab Returns False if the label is not in ClippingPlane table or does not define a ClippingPlane.

◆ GetClippingPlanes()

void XCAFDoc_ClippingPlaneTool::GetClippingPlanes ( TDF_LabelSequence & Labels ) const

Returns a sequence of clipping planes currently stored in the ClippingPlane table.

◆ GetID()

static const Standard_GUID & XCAFDoc_ClippingPlaneTool::GetID ( )

static

◆ ID()

const Standard_GUID & XCAFDoc_ClippingPlaneTool::ID ( ) const

overridevirtual

Returns the ID of the attribute.

Implements TDF_Attribute.

◆ IsClippingPlane()

Standard_Boolean XCAFDoc_ClippingPlaneTool::IsClippingPlane ( const TDF_Label & theLabel ) const

Returns True if label belongs to a ClippingPlane table and is a ClippingPlane definition.

◆ RemoveClippingPlane()

Standard_Boolean XCAFDoc_ClippingPlaneTool::RemoveClippingPlane ( const TDF_Label & theLabel ) const

Removes clipping plane from the ClippingPlane table Return false and do nothing if clipping plane is referenced in at least one View.

◆ Set()

static Handle< XCAFDoc_ClippingPlaneTool > XCAFDoc_ClippingPlaneTool::Set ( const TDF_Label & theLabel )

static

Creates (if not exist) ClippingPlaneTool.

◆ SetCapping()

void XCAFDoc_ClippingPlaneTool::SetCapping	(	const TDF_Label &	theClippingPlaneL,
		const Standard_Boolean	theCapping )

Set new value of capping for given clipping plane label.

◆ UpdateClippingPlane()

void XCAFDoc_ClippingPlaneTool::UpdateClippingPlane	(	const TDF_Label &	theLabelL,
		const gp_Pln &	thePlane,
		const TCollection_ExtendedString &	theName ) const

Sets new value of plane and name to the given clipping plane label or do nothing, if the given label is not a clipping plane label.

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

XCAFDoc_ClippingPlaneTool.hxx

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ XCAFDoc_ClippingPlaneTool()

Member Function Documentation

◆ AddClippingPlane() [1/4]

◆ AddClippingPlane() [2/4]

◆ AddClippingPlane() [3/4]

◆ AddClippingPlane() [4/4]

◆ BaseLabel()

◆ GetCapping() [1/2]

◆ GetCapping() [2/2]

◆ GetClippingPlane() [1/2]

◆ GetClippingPlane() [2/2]

◆ GetClippingPlanes()

◆ GetID()

◆ ID()

◆ IsClippingPlane()

◆ RemoveClippingPlane()

◆ Set()

◆ SetCapping()

◆ UpdateClippingPlane()