A framework to reject or to accept only objects of <br>

given types and/or signatures.
Objects are stored, and the stored objects - along
with the flag settings - are used to define the filter.
Objects to be filtered are compared with the stored
objects added to the filter, and are accepted or
rejected according to the exclusion flag setting.
More...

#include <AIS_ExclusionFilter.hxx>

Inheritance diagram for AIS_ExclusionFilter:

[legend]

Public Member Functions
	AIS_ExclusionFilter (const Standard_Boolean ExclusionFlagOn=Standard_True)
	Constructs an empty exclusion filter object defined by <br> the flag setting ExclusionFlagOn. By default, the flag is set to true. More...

	AIS_ExclusionFilter (const AIS_KindOfInteractive TypeToExclude, const Standard_Boolean ExclusionFlagOn=Standard_True)
	All the AIS objects of <TypeToExclude> Will be rejected by the IsOk Method. More...

	AIS_ExclusionFilter (const AIS_KindOfInteractive TypeToExclude, const Standard_Integer SignatureInType, const Standard_Boolean ExclusionFlagOn=Standard_True)
	Constructs an exclusion filter object defined by the <br> enumeration value TypeToExclude, the signature SignatureInType, and the flag setting ExclusionFlagOn. By default, the flag is set to true. More...

virtual Standard_Boolean	IsOk (const Handle< SelectMgr_EntityOwner > &anObj) const
	Indicates that the selected Interactive Object <br> passes the filter. The owner, anObj, can be either direct or user. A direct owner is the corresponding construction element, whereas a user is the compound shape of which the entity forms a part. When an object is detected by the mouse - in AIS, this is done through a context selector - its owner is passed to the filter as an argument. If the object returns Standard_True, it is kept; if not, it is rejected. If you are creating a filter class inheriting this framework, and the daughter class is to be used in an AIS local context, you will need to implement the virtual function ActsOn. More...

Standard_Boolean	Add (const AIS_KindOfInteractive TypeToExclude)
	Adds the type TypeToExclude to the list of types. More...

Standard_Boolean	Add (const AIS_KindOfInteractive TypeToExclude, const Standard_Integer SignatureInType)

Standard_Boolean	Remove (const AIS_KindOfInteractive TypeToExclude)

Standard_Boolean	Remove (const AIS_KindOfInteractive TypeToExclude, const Standard_Integer SignatureInType)

void	Clear ()

Standard_Boolean	IsExclusionFlagOn () const

void	SetExclusionFlag (const Standard_Boolean Status)

Standard_Boolean	IsStored (const AIS_KindOfInteractive aType) const

void	ListOfStoredTypes (TColStd_ListOfInteger &TheList) const

void	ListOfSignature (const AIS_KindOfInteractive aType, TColStd_ListOfInteger &TheStoredList) const

Public Member Functions inherited from SelectMgr_Filter
virtual Standard_Boolean	ActsOn (const TopAbs_ShapeEnum aStandardMode) const
	Returns true in an AIS local context, if this filter <br> operates on a type of subshape defined in a filter class inheriting this framework. This function completes IsOk in an AIS local context. 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 void	ShallowDump (Standard_OStream &) const

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

Detailed Description

A framework to reject or to accept only objects of <br>

given types and/or signatures.
Objects are stored, and the stored objects - along
with the flag settings - are used to define the filter.
Objects to be filtered are compared with the stored
objects added to the filter, and are accepted or
rejected according to the exclusion flag setting.

Exclusion flag on
- the function IsOk answers true for all objects,
  except those of the types and signatures stored
  in the filter framework
Exclusion flag off
- the funciton IsOk answers true for all objects
  which have the same type and signature as the stored ones.

Constructor & Destructor Documentation

AIS_ExclusionFilter::AIS_ExclusionFilter ( const Standard_Boolean ExclusionFlagOn = Standard_True )

 Constructs an empty exclusion filter object defined by <br>

the flag setting ExclusionFlagOn.
By default, the flag is set to true.

AIS_ExclusionFilter::AIS_ExclusionFilter	(	const AIS_KindOfInteractive	TypeToExclude,
		const Standard_Boolean	ExclusionFlagOn = `Standard_True`
	)

All the AIS objects of <TypeToExclude>
Will be rejected by the IsOk Method.

AIS_ExclusionFilter::AIS_ExclusionFilter	(	const AIS_KindOfInteractive	TypeToExclude,
		const Standard_Integer	SignatureInType,
		const Standard_Boolean	ExclusionFlagOn = `Standard_True`
	)

 Constructs an exclusion filter object defined by the <br>

enumeration value TypeToExclude, the signature
SignatureInType, and the flag setting ExclusionFlagOn.
By default, the flag is set to true.

Member Function Documentation

Standard_Boolean AIS_ExclusionFilter::Add ( const AIS_KindOfInteractive TypeToExclude )

Adds the type TypeToExclude to the list of types.

Standard_Boolean AIS_ExclusionFilter::Add	(	const AIS_KindOfInteractive	TypeToExclude,
		const Standard_Integer	SignatureInType
	)

void AIS_ExclusionFilter::Clear ( )

Standard_Boolean AIS_ExclusionFilter::IsExclusionFlagOn ( ) const

virtual Standard_Boolean AIS_ExclusionFilter::IsOk ( const Handle< SelectMgr_EntityOwner > & anObj ) const

virtual

 Indicates that the selected Interactive Object <br>

passes the filter. The owner, anObj, can be either
direct or user. A direct owner is the corresponding
construction element, whereas a user is the
compound shape of which the entity forms a part.
When an object is detected by the mouse - in AIS,
this is done through a context selector - its owner
is passed to the filter as an argument.
If the object returns Standard_True, it is kept; if
not, it is rejected.
If you are creating a filter class inheriting this
framework, and the daughter class is to be used in
an AIS local context, you will need to implement the
virtual function ActsOn.

Implements SelectMgr_Filter.

Standard_Boolean AIS_ExclusionFilter::IsStored ( const AIS_KindOfInteractive aType ) const

void AIS_ExclusionFilter::ListOfSignature	(	const AIS_KindOfInteractive	aType,
		TColStd_ListOfInteger &	TheStoredList
	)		const

void AIS_ExclusionFilter::ListOfStoredTypes ( TColStd_ListOfInteger & TheList ) const

Standard_Boolean AIS_ExclusionFilter::Remove ( const AIS_KindOfInteractive TypeToExclude )

Standard_Boolean AIS_ExclusionFilter::Remove	(	const AIS_KindOfInteractive	TypeToExclude,
		const Standard_Integer	SignatureInType
	)

void AIS_ExclusionFilter::SetExclusionFlag ( const Standard_Boolean Status )

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

AIS_ExclusionFilter.hxx

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation