Infohazard.HyperNav.AvoidanceObstacleBase Class Reference

Base class for obstacles that are not expected to perform avoidance, but are avoided by agents. More...

Protected Member Functions
virtual void	OnEnable ()
	Resets desired velocity and adds self to list of all obstacles. More...
virtual void	OnDisable ()
	Removes self from list of all obstacles. More...

Properties
virtual float	MaxSpeed [get, set]
	Maximum speed the object can travel at. More...
virtual float	Radius [get, set]
	Radius of the object from its position. More...
virtual Vector3	Position [get]
	World-space position of the object. More...
virtual Vector3	InputVelocity [get]
	The object's desired (or actual) velocity. More...
TagMask	TagMask [get, private set]
	Tag of the object for matching agents' IAvoidanceAgent.AvoidedTags. More...
Properties inherited from Infohazard.HyperNav.IAvoidanceObstacle
Vector3	Position [get]
	World-space position of the object. More...
Vector3	InputVelocity [get]
	The object's desired (or actual) velocity. More...
float	MaxSpeed [get]
	Maximum speed the object can travel at. More...
float	Radius [get]
	Radius of the object from its position. More...
TagMask	TagMask [get]
	Tag of the object for matching agents' IAvoidanceAgent.AvoidedTags. More...

Private Attributes
float	_radius = 0.5f
	(Serialized) Radius of the obstacle. More...
float	_maxSpeed = 0
	(Serialized) Maximum speed the obstacle can travel at. More...

Detailed Description

Base class for obstacles that are not expected to perform avoidance, but are avoided by agents.

Objects that do perform avoidance (which are obstacles as well) should inherit from AvoidanceAgent instead, which is a derived class of AvoidanceObstacleBase.

Member Function Documentation

OnDisable()

virtual void Infohazard.HyperNav.AvoidanceObstacleBase.OnDisable ( )

protectedvirtual

Removes self from list of all obstacles.

Reimplemented in Infohazard.HyperNav.AvoidanceAgent.

OnEnable()

virtual void Infohazard.HyperNav.AvoidanceObstacleBase.OnEnable ( )

protectedvirtual

Resets desired velocity and adds self to list of all obstacles.

Reimplemented in Infohazard.HyperNav.AvoidanceAgent, and Infohazard.HyperNav.SimpleAvoidanceObstacle.

Member Data Documentation

_maxSpeed

float Infohazard.HyperNav.AvoidanceObstacleBase._maxSpeed = 0

private

(Serialized) Maximum speed the obstacle can travel at.

_radius

float Infohazard.HyperNav.AvoidanceObstacleBase._radius = 0.5f

private

(Serialized) Radius of the obstacle.

Property Documentation

InputVelocity

virtual Vector3 Infohazard.HyperNav.AvoidanceObstacleBase.InputVelocity

get

The object's desired (or actual) velocity.

Implements Infohazard.HyperNav.IAvoidanceObstacle.

MaxSpeed

virtual float Infohazard.HyperNav.AvoidanceObstacleBase.MaxSpeed

getset

Maximum speed the object can travel at.

Implements Infohazard.HyperNav.IAvoidanceObstacle.

Position

virtual Vector3 Infohazard.HyperNav.AvoidanceObstacleBase.Position

get

World-space position of the object.

Implements Infohazard.HyperNav.IAvoidanceObstacle.

Radius

virtual float Infohazard.HyperNav.AvoidanceObstacleBase.Radius

getset

Radius of the object from its position.

Implements Infohazard.HyperNav.IAvoidanceObstacle.

TagMask

TagMask Infohazard.HyperNav.AvoidanceObstacleBase.TagMask

getprivate set

Tag of the object for matching agents' IAvoidanceAgent.AvoidedTags.

Implements Infohazard.HyperNav.IAvoidanceObstacle.

---

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

• Runtime/Avoidance/AvoidanceObstacleBase.cs