API reference
API reference
Select your platform
No SDKs available
No versions available

TagSetFilter Class

Extends MonoBehaviour
Leverages TagSets to fill the IGameObjectFilter role of determining whether a GameObject should be included in or excluded from a certain operation - for example, whether an Interactor<TInteractor, TInteractable> should be allowed to interact with an Interactable<TInteractor, TInteractable>.
TagSetFilter supports both "require tags" and "exclude tags". "Require tags" are tags which must all be present on a GameObject's TagSet in order for the GameObject to not be excluded by Filter(GameObject). Similarly, "exclude tags" are tags which, if any appear in a GameObject's TagSet, that GameObject will be excluded by Filter(GameObject).

Protected Methods

Start ()
Signature
virtual void Oculus.Interaction.TagSetFilter.Start()
Returns
void

Methods

AddExcludeTag ( tag )
Adds a new string to the excluded tag set.
Signature
void Oculus.Interaction.TagSetFilter.AddExcludeTag(string tag)
Parameters
tag: string  The string to be added as a new tag in the excluded set
Returns
void
AddRequireTag ( tag )
Adds a new string to the required tag set.
Signature
void Oculus.Interaction.TagSetFilter.AddRequireTag(string tag)
Parameters
tag: string  The string to be added as a new tag in the required set
Returns
void
ContainsExcludeTag ( tag )
Checks whether the excluded tag set contains the specified tag .
Signature
bool Oculus.Interaction.TagSetFilter.ContainsExcludeTag(string tag)
Parameters
tag: string  The string to check for within the excluded tag set
Returns
bool  True if the excluded set contains tag , false otherwise
ContainsRequireTag ( tag )
Checks whether the required tag set contains the specified tag .
Signature
bool Oculus.Interaction.TagSetFilter.ContainsRequireTag(string tag)
Parameters
tag: string  The string to check for within the required tag set
Returns
bool  True if the required set contains tag , false otherwise
Filter ( gameObject )
Checks whether a GameObject should be excluded ("filtered out") based on the presence or absence of tags in a TagSet on the GameObject.
Signature
bool Oculus.Interaction.TagSetFilter.Filter(GameObject gameObject)
Parameters
gameObject: GameObject  The GameObject to check for tags.
Returns
bool  True if the GameObject should be included, false if it should be excluded ("filtered out").
InjectOptionalExcludeTags ( excludeTags )
Sets the list of "exclude tags" in a dynamically instantiated TagSetFilter.
This method exists to support Interaction SDK's dependency injection pattern and is not needed for typical Unity Editor-based usage.
Signature
void Oculus.Interaction.TagSetFilter.InjectOptionalExcludeTags(string[] excludeTags)
Parameters
excludeTags: string []
Returns
void
InjectOptionalRequireTags ( requireTags )
Sets the list of "require tags" in a dynamically instantiated TagSetFilter.
This method exists to support Interaction SDK's dependency injection pattern and is not needed for typical Unity Editor-based usage.
Signature
void Oculus.Interaction.TagSetFilter.InjectOptionalRequireTags(string[] requireTags)
Parameters
requireTags: string []
Returns
void
RemoveExcludeTag ( tag )
Removes a string from the excluded tag set.
Signature
void Oculus.Interaction.TagSetFilter.RemoveExcludeTag(string tag)
Parameters
tag: string  The string to be removed as a tag from the excluded set
Returns
void
RemoveRequireTag ( tag )
Removes a string from the required tag set.
Signature
void Oculus.Interaction.TagSetFilter.RemoveRequireTag(string tag)
Parameters
tag: string  The string to be removed as a tag from the required set
Returns
void