feat: AOI interface #833
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,92 @@ | ||
| using System.Collections.Generic; | ||
| using Unity.Netcode.Interest; | ||
| using UnityEngine; | ||
|
|
||
| namespace Unity.Netcode | ||
| { | ||
| // interest *system* instead of interest node ? | ||
| public class InterestManager | ||
| { | ||
| private readonly InterestNodeStatic m_DefaultInterestNode; | ||
|
|
||
| public InterestManager() | ||
| { | ||
| m_ChildNodes = new HashSet<InterestNode>(); | ||
|
|
||
| // This is the node objects will be added to if no replication group is | ||
| // specified, which means they always get replicated | ||
| m_DefaultInterestNode = ScriptableObject.CreateInstance<InterestNodeStatic>(); | ||
| m_ChildNodes.Add(m_DefaultInterestNode); | ||
| } | ||
|
|
||
| public void AddObject(in NetworkObject obj) | ||
| { | ||
| var nodes = obj.InterestNodes; | ||
|
|
||
| // If this new object has no associated Interest Nodes, then we put it in the | ||
| // default node, which all clients will then get. | ||
| // | ||
| // That is, if you don't opt into the system behavior is the same as before | ||
| // the Interest system was added | ||
| if (nodes.Count == 0) | ||
| { | ||
| m_DefaultInterestNode.AddObject(obj); | ||
| } | ||
| // else add myself to whatever Interest Nodes I am associated with | ||
| else | ||
| { | ||
| // I am walking through each of the interest nodes that this object has | ||
| // I should probably optimize for this later vs. doing this for every add! | ||
| foreach (var node in nodes) | ||
| { | ||
| // cover the case with an empty list entry | ||
| if (node != null) | ||
| { | ||
| // the Interest Manager lazily adds nodes to itself when it sees | ||
| // new nodes that associate with the objects being added | ||
| m_ChildNodes.Add(node); | ||
| // tell this node to add this object to itself | ||
| node.AddObject(obj); | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| public void RemoveObject(in NetworkObject oldObject) | ||
| { | ||
| var nodes = oldObject.InterestNodes; | ||
|
|
||
| // if the node never had an InterestNode, then it was using the default | ||
| // interest node | ||
| if (nodes.Count == 0) | ||
| { | ||
| m_DefaultInterestNode.RemoveObject(oldObject); | ||
| } | ||
| else | ||
| { | ||
| foreach (var node in nodes) | ||
| { | ||
| if (node == null) | ||
| { | ||
| continue; | ||
| } | ||
| node.RemoveObject(oldObject); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| public void QueryFor(in NetworkClient client, HashSet<NetworkObject> results) | ||
| { | ||
| foreach (var c in m_ChildNodes) | ||
| { | ||
| c.QueryFor(client, results); | ||
| } | ||
| } | ||
|
|
||
| public void Dispose() | ||
| { | ||
| } | ||
|
|
||
| private HashSet<InterestNode> m_ChildNodes; | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| using System.Collections.Generic; | ||
| using Unity.Netcode; | ||
| using UnityEngine; | ||
|
|
||
| namespace Unity.Netcode.Interest | ||
| { | ||
| public abstract class InterestNode : ScriptableObject | ||
| { | ||
| public abstract void QueryFor(in NetworkClient client, HashSet<NetworkObject> results); | ||
| public abstract void AddObject(in NetworkObject obj); | ||
| public abstract void RemoveObject(in NetworkObject obj); | ||
| public abstract void UpdateObject(in NetworkObject obj); | ||
| }; | ||
|
|
||
| public abstract class InterestKernel : ScriptableObject | ||
|
Contributor
There was a problem hiding this comment. Should this be in its own file? |
||
| { | ||
| public abstract void QueryFor(in NetworkClient client, in NetworkObject obj, HashSet<NetworkObject> results); | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| using System.Collections.Generic; | ||
| using Unity.Netcode; | ||
| using UnityEngine; | ||
|
|
||
| namespace Unity.Netcode.Interest | ||
| { | ||
| [CreateAssetMenu(fileName = "StaticInterestNode", menuName = "Interest/Nodes/Static", order = 1)] | ||
|
Contributor
There was a problem hiding this comment. Since this menu item is applied to the Assets menu, |
||
| public class InterestNodeStatic : InterestNode | ||
|
Comment on lines
+7
to
+8
Contributor
There was a problem hiding this comment. Interesting that the file name and the class differ. Personally would recommend this should be called StaticInterestNode (most-specific-first naming) |
||
| { | ||
| public List<InterestKernel> InterestKernels = new List<InterestKernel>(); | ||
|
|
||
| // these are the objects under my purview | ||
| protected HashSet<NetworkObject> ManagedObjects; | ||
|
|
||
| public void OnEnable() | ||
| { | ||
| ManagedObjects = new HashSet<NetworkObject>(); | ||
| } | ||
|
|
||
| public override void AddObject(in NetworkObject obj) | ||
| { | ||
| ManagedObjects.Add(obj); | ||
| } | ||
|
|
||
| public override void RemoveObject(in NetworkObject obj) | ||
| { | ||
| ManagedObjects.Remove(obj); | ||
| } | ||
|
|
||
| public override void QueryFor(in NetworkClient client, HashSet<NetworkObject> results) | ||
| { | ||
| if (InterestKernels.Count > 0) | ||
| { | ||
| foreach (var obj in ManagedObjects) | ||
| { | ||
| foreach (var ik in InterestKernels) | ||
| { | ||
| ik.QueryFor(client, obj, results); | ||
| } | ||
| } | ||
| } | ||
| else | ||
| { | ||
| results.UnionWith(ManagedObjects); | ||
| } | ||
| } | ||
|
|
||
| public override void UpdateObject(in NetworkObject obj) | ||
| { | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| using System.Collections; | ||
| using System.Collections.Generic; | ||
| using UnityEngine; | ||
|
|
||
| namespace Unity.Netcode.Interest | ||
| { | ||
| [CreateAssetMenu(fileName = "ReplicationSettings", menuName = "Interest/Settings/InterestSettings", order = 1)] | ||
|
Contributor
There was a problem hiding this comment. ReplicationSettings vs InterestSettings? |
||
|
|
||
| // these are settings used by the Interest management system to | ||
| // - adjust how it decides whether an item is replicated | ||
| // - adjust how prioritization occurs | ||
| public class InterestSettings : ScriptableObject | ||
| { | ||
| // TBD - add default interest settings here | ||
| } | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Weren't we shying away from sub-namespaces?