Doloro GDK 22 .1.0 Beta
by Tauri Interactive
Doloro.Sensors.ASensorFilter Class Referenceabstract

Detailed Description

An interface used into the Doloro Sensors module to extend the build-in sensor filter algorithms.

Inheritance diagram for Doloro.Sensors.ASensorFilter:
Collaboration diagram for Doloro.Sensors.ASensorFilter:

Public Member Functions

bool CheckCollision (FilteredSensor invocker, GameObject obj)
 Checking object from collision with filter settings. More...
 

Protected Member Functions

abstract bool FilterLogic (FilteredSensor invocker, GameObject obj)
 Handler that should provide internal logic for filter. More...
 
virtual void OnModified ()
 Handler that should be called after any settings modification.
 

Properties

FilteredSensor sensor [get]
 Reference to sensor component binded to the filter. More...
 
bool Inverted [get, set]
 Returns inverted result if true.
 

Events

System.Action< ASensorFilterModified
 Occurs when critical setting of the filter was modified.
 

Member Function Documentation

◆ CheckCollision()

bool Doloro.Sensors.ASensorFilter.CheckCollision ( FilteredSensor  invocker,
GameObject  obj 
)

Checking object from collision with filter settings.

Parameters
invockerThe source manager for the event.
objCollided object.
Returns

Result of filtering. True - passed False - rejected.

Result returns inverted in case if Inverted is true.

◆ FilterLogic()

abstract bool Doloro.Sensors.ASensorFilter.FilterLogic ( FilteredSensor  invocker,
GameObject  obj 
)
protectedpure virtual

Handler that should provide internal logic for filter.

Parameters
invockerThe source manager for the event.
objCollided object.
Returns
Result of filtering. True - passed False - rejected.

Implemented in Doloro.Sensors.Filters.GameObjectSensorFilter, Doloro.Sensors.Filters.HierarchyRootSensorFilter, Doloro.Sensors.Filters.LayerSensorFilter, and Doloro.Sensors.Filters.TagSensorFilter.

Property Documentation

◆ sensor

FilteredSensor Doloro.Sensors.ASensorFilter.sensor
get

Reference to sensor component binded to the filter.

Primary looks for first sensor at the same object. If not found then looking among parent sensors.

Exceptions
System.NullReferenceExceptionSensor instance not found in hierarchy.

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