Use the Tag Filter to collect 3D nodes that have a specific tag assigned. More...

#include <kanzi/core.ui/graphics3d/tag_filter.hpp>

Inheritance diagram for kanzi::TagFilter:

Public Types
typedef std::vector< kanzi::AbstractPropertyType >	PropertyTypeContainer
	Tag container type. More...

Public Types inherited from kanzi::ObjectSource
enum	ObjectSourceType { Combine, Sort, FrustumCullFilter, ContainsPropertyFilter, ObjectTypeFilter, PropertyIsEqualFilter, TagFilter }
	Enumeration for object source type. More...

Public Types inherited from kanzi::PropertyObject
typedef PropertyStorageContainer::const_iterator	PropertyStorageConstIterator

typedef vector< PropertyStoragePtr >	PropertyStorageContainer

typedef PropertyStorageContainer::iterator	PropertyStorageIterator

typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStorage >	PropertyStoragePtr

typedef PropertyStorageContainer::reverse_iterator	PropertyStorageReverseIterator

Public Member Functions
const PropertyTypeContainer &	getExclusiveTags () const
	Gets the tags of the nodes to exclude from the filter results. More...

const PropertyTypeContainer &	getInclusiveTags () const
	Gets the tags of the nodes to include in the filter results. More...

Public Member Functions inherited from kanzi::FilterObjectSource
bool	isExclusive () const
	Indicates whether or not the filter is exclusive. More...

Public Member Functions inherited from kanzi::ObjectSource
ObjectSourceRuntimeSharedPtr	createRuntime (NodeListSharedPtr nodeList, ObjectSourceSharedPtr filter)
	Runs the filter on a given node. More...

ObjectSourceSharedPtr	getParent ()
	Gets the parent object source. More...

Public Member Functions inherited from kanzi::Resource
virtual unsigned int	getCPUMemoryUsage () const
	Function for getting the memory usage of a resource. More...

const string &	getName () const
	Gets the resource name. More...

const string &	getUrl () const
	Gets the resource URL. More...

bool	isKeepAlive () const
	Tells if the resource has keep alive flag set. More...

void	reload ()

void	reloadFromFile (string_view filePath)

void	reloadFromKzb (KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser)

void	setKeepAlive (bool keepAlive)
	Sets the keep alive flag. More...

void	setUrl (string_view url)
	Sets the resource URL. More...

	~Resource () override
	Destructor. More...

Public Member Functions inherited from kanzi::Object
AppliedStyleEntrySharedPtr	applyObjectStyle (kanzi::StyleSharedPtr style)
	Applies a style to an object. More...

void	applyObjectStyles ()
	Apply all styles for an object node. More...

Domain *	getDomain () const
	Returns the domain the object belongs to. More...

const Metaclass *	getDynamicMetaclass () const override
	Returns the metaclass of the dynamic type of the object. More...

MainLoopScheduler *	getMainLoopScheduler () const
	Returns the MainLoopScheduler instance of the associated Domain. More...

detail::MessageDispatcher *	getMessageDispatcher () const
	Returns the message dispatcher of the object. More...

ResourceManager *	getResourceManager () const
	Returns the resource manager of the object. More...

ScriptingContextSharedPtr	getScriptingContext () const
	Gets the scripting context of the object. More...

	Object (Domain *domain)

void	setScriptingContext (ScriptingContextSharedPtr context)
	Sets the scripting context of the object. More...

void	unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry)

void	unapplyObjectStyles ()
	Unapplies and removes all applied styles. More...

	~Object () override

Public Member Functions inherited from kanzi::MetaObject
bool	isTypeOf (const Metaclass *objectType) const
	Determines if the type of this object is the given type or derived from it. More...

virtual	~MetaObject ()

Public Member Functions inherited from kanzi::PropertyObject
template<typename DataType >
void	addPropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)

template<typename DataType >
void	addPropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)

template<typename DataType >
void	addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, PropertyValuePrecedence precedence, void ownerPointer)

template<typename DataType >
void	addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner owner)

PropertyStorageContainer::iterator	beginPropertyStorage ()
	Returns the begin iterator to the internal property storage container. More...

PropertyStorageContainer::const_iterator	beginPropertyStorage () const
	Returns the begin iterator to the internal property storage container. More...

void	clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)

void	copyLocalValue (const PropertyObject &other, AbstractPropertyType propertyType)
	Copies local value of single property from another object. More...

void	copyLocalValues (const PropertyObject &other)
	Copies all local values from another object. More...

PropertyStorageContainer::iterator	endPropertyStorage ()
	Returns the end iterator to the internal property storage container. More...

PropertyStorageContainer::const_iterator	endPropertyStorage () const
	Returns the end iterator to the internal property storage container. More...

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getAbstractProperty (AbstractPropertyType abstractPropertyType) const

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getAbstractPropertyBase (AbstractPropertyType abstractPropertyType) const

template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalAbstractProperty (AbstractPropertyType abstractPropertyType) const

template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalProperty (const PropertyType< DataType > &propertyType) const
	Evaluates the property value in the same way as the overload above but does not default to the value in property metadata if there are no inputs to the property value. More...

template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalPropertyBase (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property disregarding modifiers, but does not default to the value in property metadata if there are no inputs to the property value. More...

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getProperty (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property type. More...

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getPropertyBase (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property disregarding modifiers. More...

template<typename DataType >
size_t	getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType) const
	Gets number of current notification handlers for given property type. More...

bool	hasBaseValue (AbstractPropertyType propertyType) const
	Evaluates whether there are any inputs into the property value, disregarding modifiers. More...

bool	hasLocalValue (AbstractPropertyType propertyType) const
	Evaluates whether there is a local value set for the property. More...

bool	hasNonClassValue (AbstractPropertyType propertyType) const
	Evaluates whether there is a value of any precedence higher than class default value set for the property. More...

bool	hasValue (AbstractPropertyType propertyType) const
	Evaluates whether there are any inputs into the property value. More...

bool	isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const

virtual void	onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason)
	Virtual function to handle property change notifications. More...

	PropertyObject ()

void	removeKzbProperties (flat_set< AbstractPropertyType > *keepProperties)
	Remove all KZB properties that are not included in a given set. More...

void	removeKzbProperties ()
	Remove all KZB properties. More...

template<typename DataType >
void	removeLocalPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, void ownerPointer)

void	removeLocalValue (AbstractPropertyType propertyType)
	Removes the local value associated with the property. More...

template<typename DataType >
void	removePropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)

template<typename DataType >
void	removePropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)

template<typename DataType >
void	removePropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, void ownerPointer)

template<typename DataType >
void	setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::Traits::ParameterType value)

template<typename DataType >
void	setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Traits::ParameterType value)
	Sets the local value of a property type. More...

void	setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)

void	validatePropertyModifiers (AbstractPropertyType propertyType)

virtual	~PropertyObject ()

Static Public Member Functions
static TagFilterSharedPtr	create (Domain *domain, string_view name, ObjectSourceSharedPtr parentSource, bool isExclusive, const PropertyTypeContainer &inclusiveTags, const PropertyTypeContainer &exclusiveTags)
	Creates a Tag Filter. More...

static TagFilterSharedPtr	create (Domain *domain, string_view name, bool isExclusive, const PropertyTypeContainer &inclusiveTags, const PropertyTypeContainer &exclusiveTags)
	Creates a Tag Filter. More...

static TagFilterSharedPtr	create (Domain *domain, string_view name, const PropertyTypeContainer &inclusiveTags, const PropertyTypeContainer &exclusiveTags)
	Creates a Tag Filter. More...

static TagFilterSharedPtr	loadFromKZB (kanzi::Domain *domain, kanzi::string_view name, kanzi::KzbFile &kzbFile, kanzi::ReadOnlyMemoryFile &file, kanzi::KzbMemoryParser &parser)
	Loads a Tag Filter from a file. More...

Static Public Member Functions inherited from kanzi::ObjectSource
static ObjectSourceSharedPtr	loadFromKZB (Domain *domain, string_view name, KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser)
	Loads an object source from a file. More...

static ObjectSourceSharedPtr	loadParentObjectSource (Domain *domain, KzbMemoryParser &parser)
	Loads the parent object source. More...

Static Public Member Functions inherited from kanzi::Object
static const Metaclass *	getStaticMetaclass ()
	Returns the metaclass of Object class. More...

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Default implementation that returns empty editor info. More...

Static Public Member Functions inherited from kanzi::MetaObject
static const Metaclass *	getStaticMetaclass ()
	Returns the metaclass of Object class. More...

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Default implementation that returns empty editor info. More...

Protected Member Functions
ObjectSourceRuntimeSharedPtr	createRuntimeOverride (NodeListSharedPtr nodeList, ObjectSourceSharedPtr filter) override
	ObjectSource::createRuntimeOverride() implementation. More...

	TagFilter (Domain *domain, string_view name, ObjectSourceSharedPtr parentSource, bool isExclusive, const PropertyTypeContainer &inclusiveTags, const PropertyTypeContainer &exclusiveTags)
	Constructor. More...

Protected Member Functions inherited from kanzi::FilterObjectSource
	FilterObjectSource (Domain *domain, string_view name, ObjectSourceSharedPtr parentSource, bool exclusive)
	Constructor. More...

Protected Member Functions inherited from kanzi::ObjectSource
	ObjectSource (Domain *domain, string_view name, ObjectSourceSharedPtr parentSource)
	Constructor. More...

Protected Member Functions inherited from kanzi::Resource
virtual unsigned int	getCPUMemoryUsageOverride () const

virtual void	reloadFromFileOverride (string_view filePath)

virtual void	reloadFromKzbOverride (KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser)

virtual void	reloadOverride ()

	Resource (Domain *domain, string_view name)
	Constructor. More...

Protected Member Functions inherited from kanzi::Object
void	initialize ()

void	onCopy (const Object &other)

Protected Member Functions inherited from kanzi::MetaObject
void	initialize ()

	MetaObject ()

Protected Member Functions inherited from kanzi::PropertyObject
AbstractPropertyTypeDescriptor::ValueSourceEntry *	acquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
	Acquires a local value source entry that is free for the assignment of a value. More...

AbstractPropertyTypeDescriptor::ModifierStorage *	acquireModifierStorage (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)

AbstractPropertyTypeDescriptor::NotificationStorage *	acquireNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)

PropertyStoragePtr	acquirePropertyStorage (AbstractPropertyTypeDescriptor &descriptor)

void	addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, PropertyValuePrecedence precedence, void ownerPointer)
	Internally adds a property value source. More...

void	addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner owner)
	Internally adds a property value source. More...

AbstractPropertyTypeDescriptor::ValueSourceEntry *	constructLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)

PropertyStoragePtr	constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)

void	copyLocalValue (const AbstractPropertyTypeDescriptor::PropertyStorage &otherPropertyStorage)
	Copy local value from property storage. More...

AbstractPropertyTypeDescriptor::ModifierStorage *	findModifierStorage (AbstractPropertyTypeDescriptor &descriptor)

AbstractPropertyTypeDescriptor::NotificationStorage *	findNotificationStorage (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::PropertyStorage *	findPropertyStorage (AbstractPropertyTypeDescriptor &descriptor) const
	Gets the property storage for given property type descriptor. More...

PropertyStoragePtr	findPropertyStoragePtr (AbstractPropertyTypeDescriptor &descriptor) const
	Gets property storage intrusive pointer which you can use to hold a reference until the end of the operation. More...

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByNameAndDataType (string_view name, PropertyDataType dataType) const
	Finds a property type descriptor by name and data type. More...

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByQualifiedNameAndDataType (string_view qualifiedName, PropertyDataType dataType) const
	Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with qualified names. More...

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType) const
	Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with unqualified names. More...

AbstractPropertyTypeDescriptor::ValueSource *	getClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getNonClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getTopValueSource (AbstractPropertyTypeDescriptor &descriptor) const
	Gets the top-level value source for a given property descriptor. More...

virtual void	notifyPropertyHandlers (PropertyStoragePtr &propertyStorage, PropertyNotificationReason reason)

void	onCopy (const PropertyObject &other)

void	removeLocalValue (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
	Removes a local value from the given property storage. More...

void	removePropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, void owner)
	Removes a property value source. More...

void	validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)

Protected Attributes
PropertyTypeContainer	m_exclusiveTags
	The nodes that have these tags are excluded from the filter results after the inclusive tags have been checked. More...

PropertyTypeContainer	m_inclusiveTags
	The nodes that have these tags are included in the filter results. More...

Protected Attributes inherited from kanzi::FilterObjectSource
bool	m_isExclusive
	Is this filter exclusive. More...

Protected Attributes inherited from kanzi::ObjectSource
ObjectSourceSharedPtr	m_parentObjectSource
	Parent object source. More...

Protected Attributes inherited from kanzi::Object
AppliedStyleContainer	m_appliedStyles
	Listing of applied styles applied to this object. More...

Additional Inherited Members
Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntrySharedPtr >	AppliedStyleContainer
	Applied style container. More...

Detailed Description

Use the Tag Filter to collect 3D nodes that have a specific tag assigned.

Tag Filter collects nodes based on the tags that you include and exclude from the filter.

Since: Kanzi 3.9.0

Member Typedef Documentation

◆ PropertyTypeContainer

typedef std::vector<kanzi::AbstractPropertyType> kanzi::TagFilter::PropertyTypeContainer

Tag container type.

Constructor & Destructor Documentation

◆ TagFilter()

kanzi::TagFilter::TagFilter	(	Domain *	domain,
		string_view	name,
		ObjectSourceSharedPtr	parentSource,
		bool	isExclusive,
		const PropertyTypeContainer &	inclusiveTags,
		const PropertyTypeContainer &	exclusiveTags
	)

inlineexplicitprotected

Constructor.

Parameters

domain	Domain to use.
name	Object source name.
parentSource	The parent object source.
isExclusive	Whether to invert the filter results.
inclusiveTags	Tags of the nodes to include in the filter results.
exclusiveTags	Tags of the nodes to exclude from the filter results.

Member Function Documentation

◆ create() [1/3]

static TagFilterSharedPtr kanzi::TagFilter::create	(	Domain *	domain,
		string_view	name,
		ObjectSourceSharedPtr	parentSource,
		bool	isExclusive,
		const PropertyTypeContainer &	inclusiveTags,
		const PropertyTypeContainer &	exclusiveTags
	)

static

Creates a Tag Filter.

Parameters

domain	Domain to use.
name	Object source name.
parentSource	Parent object source.
isExclusive	Whether to invert the filter results.
inclusiveTags	Tags of the nodes to include in the filter results.
exclusiveTags	Tags of the nodes to exclude from the filter results.

Returns: The created Tag Filter.

◆ create() [2/3]

static TagFilterSharedPtr kanzi::TagFilter::create	(	Domain *	domain,
		string_view	name,
		bool	isExclusive,
		const PropertyTypeContainer &	inclusiveTags,
		const PropertyTypeContainer &	exclusiveTags
	)

inlinestatic

Creates a Tag Filter.

Parent object source is not defined.

Parameters

domain	Domain to use.
name	Object source name.
isExclusive	Whether to invert the filter results.
inclusiveTags	Tags of the nodes to include in the filter results.
exclusiveTags	Tags of the nodes to exclude from the filter results.

Returns: The created Tag Filter.

◆ create() [3/3]

static TagFilterSharedPtr kanzi::TagFilter::create	(	Domain *	domain,
		string_view	name,
		const PropertyTypeContainer &	inclusiveTags,
		const PropertyTypeContainer &	exclusiveTags
	)

inlinestatic

Creates a Tag Filter.

Parent object source is not defined. Filter results are not inverted.

Parameters

domain	Domain to use.
name	Object source name.
inclusiveTags	Tags of the nodes to include in the filter results.
exclusiveTags	Tags of the nodes to exclude from the filter results.

Returns: The created Tag Filter.

◆ loadFromKZB()

static TagFilterSharedPtr kanzi::TagFilter::loadFromKZB	(	kanzi::Domain *	domain,
		kanzi::string_view	name,
		kanzi::KzbFile &	kzbFile,
		kanzi::ReadOnlyMemoryFile &	file,
		kanzi::KzbMemoryParser &	parser
	)

static

Loads a Tag Filter from a file.

Kanzi Engine uses this function internally.

Parameters

domain	Domain to use.
name	Object source name
kzbFile	KZB file context.
file	File to load from.
parser	Parser to use.

Returns: The created Tag Filter.

◆ getInclusiveTags()

const PropertyTypeContainer& kanzi::TagFilter::getInclusiveTags ( ) const

inline

Gets the tags of the nodes to include in the filter results.

Returns: Container of included tags.

◆ getExclusiveTags()

const PropertyTypeContainer& kanzi::TagFilter::getExclusiveTags ( ) const

inline

Gets the tags of the nodes to exclude from the filter results.

Returns: Container of excluded tags.

◆ createRuntimeOverride()

ObjectSourceRuntimeSharedPtr kanzi::TagFilter::createRuntimeOverride	(	NodeListSharedPtr	nodeList,
		ObjectSourceSharedPtr	filter
	)

overrideprotectedvirtual

ObjectSource::createRuntimeOverride() implementation.

Reimplemented from kanzi::ObjectSource.

Member Data Documentation

◆ m_inclusiveTags

PropertyTypeContainer kanzi::TagFilter::m_inclusiveTags

protected

The nodes that have these tags are included in the filter results.

◆ m_exclusiveTags

PropertyTypeContainer kanzi::TagFilter::m_exclusiveTags

protected

The nodes that have these tags are excluded from the filter results after the inclusive tags have been checked.

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

kanzi/core.ui/graphics3d/tag_filter.hpp

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ PropertyTypeContainer

Constructor & Destructor Documentation

◆ TagFilter()

Member Function Documentation

◆ create() [1/3]

◆ create() [2/3]

◆ create() [3/3]

◆ loadFromKZB()

◆ getInclusiveTags()

◆ getExclusiveTags()

◆ createRuntimeOverride()

Member Data Documentation

◆ m_inclusiveTags

◆ m_exclusiveTags