AIS_AttributeFilter Class Reference

Selects Interactive Objects, which have the desired width or color. The filter questions each Interactive Object in local context to determine whether it has an non-null owner, and if so, whether it has the required color and width attributes. If the object returns true in each case, it is kept. If not, it is rejected. This filter is used only in an open local context. In the Collector viewer, you can only locate Interactive Objects, which answer positively to the filters, which are in position when a local context is open. More...

#include <AIS_AttributeFilter.hxx>

Inheritance diagram for AIS_AttributeFilter:

Public Member Functions
	AIS_AttributeFilter ()
	Constructs an empty attribute filter object. This filter object determines whether selectable interactive objects have a non-null owner.
	AIS_AttributeFilter (const Quantity_NameOfColor aCol)
	Constructs an attribute filter object defined by the color attribute aCol.
	AIS_AttributeFilter (const double aWidth)
	Constructs an attribute filter object defined by the line width attribute aWidth.
bool	HasColor () const
	Indicates that the Interactive Object has the color setting specified by the argument aCol at construction time.
bool	HasWidth () const
	Indicates that the Interactive Object has the width setting specified by the argument aWidth at construction time.
void	SetColor (const Quantity_NameOfColor theCol)
	Sets the color.
void	SetWidth (const double theWidth)
	Sets the line width.
void	UnsetColor ()
	Removes the setting for color from the filter.
void	UnsetWidth ()
	Removes the setting for width from the filter.
bool	IsOk (const occ::handle< SelectMgr_EntityOwner > &anObj) const override
	Indicates that the selected Interactive Object 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. If the Interactive Object returns true when detected by the Local Context selector through the mouse, the object is kept; if not, it is rejected.
Public Member Functions inherited from SelectMgr_Filter
virtual bool	ActsOn (const TopAbs_ShapeEnum aStandardMode) const
	Returns true in an AIS local context, if this filter operates on a type of subshape defined in a filter class inheriting this framework. This function completes IsOk in an AIS local context.
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.

Additional Inherited Members
typedef void	base_type
	Returns a type descriptor about this object.
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.

Detailed Description

Selects Interactive Objects, which have the desired width or color. The filter questions each Interactive Object in local context to determine whether it has an non-null owner, and if so, whether it has the required color and width attributes. If the object returns true in each case, it is kept. If not, it is rejected. This filter is used only in an open local context. In the Collector viewer, you can only locate Interactive Objects, which answer positively to the filters, which are in position when a local context is open.

Constructor & Destructor Documentation

AIS_AttributeFilter() [1/3]

AIS_AttributeFilter::AIS_AttributeFilter

(

)

Constructs an empty attribute filter object. This filter object determines whether selectable interactive objects have a non-null owner.

AIS_AttributeFilter() [2/3]

AIS_AttributeFilter::AIS_AttributeFilter

(

const Quantity_NameOfColor

aCol

)

Constructs an attribute filter object defined by the color attribute aCol.

AIS_AttributeFilter() [3/3]

AIS_AttributeFilter::AIS_AttributeFilter

(

const double

aWidth

)

Constructs an attribute filter object defined by the line width attribute aWidth.

Member Function Documentation

HasColor()

bool AIS_AttributeFilter::HasColor ( ) const

inline

Indicates that the Interactive Object has the color setting specified by the argument aCol at construction time.

HasWidth()

bool AIS_AttributeFilter::HasWidth ( ) const

inline

Indicates that the Interactive Object has the width setting specified by the argument aWidth at construction time.

IsOk()

bool AIS_AttributeFilter::IsOk ( const occ::handle< SelectMgr_EntityOwner > & anObj ) const

overridevirtual

Indicates that the selected Interactive Object 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. If the Interactive Object returns true when detected by the Local Context selector through the mouse, the object is kept; if not, it is rejected.

Implements SelectMgr_Filter.

SetColor()

void AIS_AttributeFilter::SetColor ( const Quantity_NameOfColor theCol )

inline

Sets the color.

SetWidth()

void AIS_AttributeFilter::SetWidth ( const double theWidth )

inline

Sets the line width.

UnsetColor()

void AIS_AttributeFilter::UnsetColor ( )

inline

Removes the setting for color from the filter.

UnsetWidth()

void AIS_AttributeFilter::UnsetWidth ( )

inline

Removes the setting for width from the filter.

---

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

• AIS_AttributeFilter.hxx