Doloro.Sensors.Sensor Class Reference

Detailed Description

Menages the object entering and exits

Inheritance diagram for Doloro.Sensors.Sensor:

Collaboration diagram for Doloro.Sensors.Sensor:

Public Member Functions
virtual void	Add (GameObject item)
	Adding object to triggered collection. Sending object to the filters. More...
virtual void	Clear ()
	Cleared collection of detected objects. More...
virtual bool	Contains (GameObject item)
	Checks is the object triggered. More...
virtual void	CopyTo (GameObject[] array, int arrayIndex)
	Copying triggered objects to destination array. More...
virtual bool	Remove (GameObject item)
	Trying to remove object from triggered. More...
virtual IEnumerator< GameObject >	GetEnumerator ()
	Returns enumerator for triggered objects. More...

Static Public Attributes
static Hashtable	registred = new Hashtable()
	Hash table that contain the pairs (Transform Holder -> List{SensorManager}) that registered in the system. Use this for optimizing of access.

Protected Member Functions
virtual void	Awake ()
	Occurs when sensors instantiated. More...
virtual void	OnDestroy ()
	Occurs when sensors zone destroying. More...
virtual void	OnTriggerEnter (Collider collision)
	Occurs when trigger collides with game object. More...
virtual void	OnTriggerExit (Collider collision)
	Occurs when game object leaving trigger bounds. More...

Protected Attributes
List< GameObject >	triggered = new List<GameObject>()
	List that contain the game objects that placed in zone in current time.

Properties
GameObject	LastEnterDetection [get]
	Last game object that was detected on zone enter. More...
GameObject	LastExitDetection [get]
	Last game object that was detected on zone exit.
virtual int	Count [get]
	Returns count of triggered objects.
virtual bool	IsReadOnly [get]
	Always false.
int	Id [get, set]
	Id of current sensor behaviorManager. Using for hot binding.

Events
System.Action< GameObject >	Detected
	Occurs when game object enters to a sensor borders.
System.Action< GameObject >	Exited
	Occurs when game object leaves a sensor borders.
System.Action< int >	IdChanged
	Occurs when Id is changed. Sharing id before change.

Member Function Documentation

Add()

virtual void Doloro.Sensors.Sensor.Add ( GameObject  item )

virtual

Adding object to triggered collection. Sending object to the filters.

Parameters

item	Item to manual triggering.

Reimplemented in Doloro.Sensors.FilteredSensor.

Awake()

virtual void Doloro.Sensors.Sensor.Awake ( )

protectedvirtual

Occurs when sensors instantiated.

Reimplemented in Doloro.Sensors.DependentFilteredSensor, and Doloro.Sensors.FilteredSensor.

Clear()

virtual void Doloro.Sensors.Sensor.Clear ( )

virtual

Cleared collection of detected objects.

Reimplemented in Doloro.Sensors.FilteredSensor.

Contains()

virtual bool Doloro.Sensors.Sensor.Contains ( GameObject  item )

virtual

Checks is the object triggered.

Parameters

item	Item to check.

Returns

Result of check.

Reimplemented in Doloro.Sensors.FilteredSensor.

CopyTo()

virtual void Doloro.Sensors.Sensor.CopyTo ( GameObject[]  array, int  arrayIndex  )

virtual

Copying triggered objects to destination array.

Parameters

array	Destination array
arrayIndex	Start index at destination array.

Reimplemented in Doloro.Sensors.FilteredSensor.

GetEnumerator()

virtual IEnumerator< GameObject > Doloro.Sensors.Sensor.GetEnumerator ( )

virtual

Returns enumerator for triggered objects.

Returns

Enumerator instance.

Reimplemented in Doloro.Sensors.FilteredSensor.

OnDestroy()

virtual void Doloro.Sensors.Sensor.OnDestroy ( )

protectedvirtual

Occurs when sensors zone destroying.

Reimplemented in Doloro.Sensors.DependentFilteredSensor.

OnTriggerEnter()

virtual void Doloro.Sensors.Sensor.OnTriggerEnter ( Collider  collision )

protectedvirtual

Occurs when trigger collides with game object.

Parameters

collision

Triggered collider.

Reimplemented in Doloro.Sensors.DependentFilteredSensor.

OnTriggerExit()

virtual void Doloro.Sensors.Sensor.OnTriggerExit ( Collider  collision )

protectedvirtual

Occurs when game object leaving trigger bounds.

Parameters

collision

Reimplemented in Doloro.Sensors.DependentFilteredSensor.

Remove()

virtual bool Doloro.Sensors.Sensor.Remove ( GameObject  item )

virtual

Trying to remove object from triggered.

Parameters

item	Item to remove.

Returns

Result of removing.

Simulates regular reaction the same as object left the trigger bound by itself.

Reimplemented in Doloro.Sensors.FilteredSensor.

Property Documentation

LastEnterDetection

GameObject Doloro.Sensors.Sensor.LastEnterDetection

get

Last game object that was detected on zone enter.

Will updated in case if setted object leaving the sensor's range. Null in case if any objects left.

---

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

• D:/Work/GitHub/DGDK22/Assets/Tauri Interactive/Doloro-GDK/Doloro-Sensor/Runtime/Components/Sensor.cs