Detailed Description

Base graph implementation logic.

Inheritance diagram for Doloro.Graphs.Graph:

[legend]

Collaboration diagram for Doloro.Graphs.Graph:

[legend]

Classes
class	RegistryOperationRevertException
	Exception operation that could cause registry operation revert, if supported. More...

Public Member Functions
delegate void	GraphsRegistryChangeHandler (Graph oldEntry, Graph newEntry)
	Delegate for an agent that handles. More...

	Graph ()
	Creates standalone graph without outside connections.

virtual Vector3	GetNodePosition (GraphNode node)
	Returns the node's point suggested by the graph logic. More...

virtual void	SetNodePosition (GraphNode node, Vector3 position)
	Defines world position for the certain graph node. More...

virtual GraphNode	Add ()
	Adds new GraphNode to the graph. More...

virtual T	Add< T > ()
	Adds new node to the graph. More...

virtual T	Add< T > (string signature)
	Adds new node to the graph. More...

void	Add (string signature)
	Creates new GraphNode. More...

void	Add (string signature, out GraphNode node)
	Creates new GraphNode. More...

virtual void	Add (GraphNode node)
	Adds new node to the graph. More...

virtual bool	Remove (GraphNode node)
	Removing node from the graph. More...

virtual bool	Contains (string nodeSignature)
	Checks is the node included to the graph. More...

virtual bool	Contains (GraphNode node)
	Checks is the node included to the graph. More...

virtual bool	Remove (string signature)
	Removing node from the graph. More...

virtual bool	TryGetNode (string signature, out GraphNode node)
	Tries to get graph`s node by the signature. More...

Connection	GetConnection (Guid connectionId)
	Returns descriptor for the Connection by id. More...

virtual void	GetObjectData (SerializationInfo info, StreamingContext context)

override string	ToString ()
	Returns graph info. More...

void	Clear ()
	Clears entire graph from nodes.

void	CopyTo (GraphNode[] array, int arrayIndex)
	Copies graph nodes of the graph to array. More...

void	CopyTo (string[] array, int arrayIndex)
	Copies GraphNode.signature entries in graph to array. More...

virtual IEnumerator< GraphNode >	GetEnumerator ()
	Enumerates nodes withing the graph. More...

Protected Member Functions
void	OnBinaryDataLoaded ()
	Must be called within `ctor(SerializationInfo info, StreamingContext context)` after binary data deserialization.

Package Functions
	Graph (SerializationInfo info, StreamingContext context)

void	ReleaseConnection (Guid id)
	Releases connection from internal registry. More...

void	SetConnectionInfo (Connection connection)
	Adds connection info to the registry. More...

Properties
Guid	id `[get]`
	Id of the graph into internal runtime registry.

int	Count `[get]`
	Count of nodes into the graph.

int	ConnectionsCount `[get]`
	Count of currently established connections into the graph.

GraphNode	this[string signature] `[get]`

Dictionary< string, GraphNode >	nodes `[get]`
	Graph navigation map. More...

bool	IsReadOnly `[get]`
	Always false.

Events
Action< GraphNode >	NodeAdded
	Occurs when new node added to the graph via the API.

Action< GraphNode >	NodeRemoved
	Occurs when new node removed from the graph via the API.

static GraphsRegistryChangeHandler	GraphObsoleted
	Occurs when registry overridden with a new graph with id that already has been registered. More...

Member Function Documentation

◆ Add() [1/4]

virtual GraphNode Doloro.Graphs.Graph.Add ( )

virtual

Adds new GraphNode to the graph.

Returns: Node instance.

◆ Add() [2/4]

virtual void Doloro.Graphs.Graph.Add ( GraphNode node )

virtual

Adds new node to the graph.

Parameters

node	Node to add.

Reimplemented in Doloro.Graphs.Fragmented.GraphsNetwork.

◆ Add() [3/4]

void Doloro.Graphs.Graph.Add ( string signature )

Creates new GraphNode.

Parameters

signature Node signature.

◆ Add() [4/4]

void Doloro.Graphs.Graph.Add	(	string	signature,
		out GraphNode	node
	)

Creates new GraphNode.

Parameters

signature	Node signature.
node	Created instance.

◆ Add< T >() [1/2]

virtual T Doloro.Graphs.Graph.Add< T > ( )

virtual

Adds new node to the graph.

Template Parameters

T	Type of node to add.

Returns: Node instance.

Type Constraints

T	:	GraphNode
T	:	new()

◆ Add< T >() [2/2]

virtual T Doloro.Graphs.Graph.Add< T > ( string signature )

virtual

Adds new node to the graph.

Template Parameters

T	Type of node to add.

Parameters

signature Node signature.

Returns: Node instance.

Type Constraints

T

:

GraphNode

◆ Contains() [1/2]

virtual bool Doloro.Graphs.Graph.Contains ( GraphNode node )

virtual

Checks is the node included to the graph.

Parameters

node	Node to check.

Returns: Including status.

Reimplemented in Doloro.Graphs.Fragmented.GraphsNetwork.

◆ Contains() [2/2]

virtual bool Doloro.Graphs.Graph.Contains ( string nodeSignature )

virtual

Checks is the node included to the graph.

Parameters

nodeSignature GraphNode.signature to search.

Returns: Including status.

Reimplemented in Doloro.Graphs.Fragmented.GraphsNetwork.

◆ CopyTo() [1/2]

void Doloro.Graphs.Graph.CopyTo	(	GraphNode[]	array,
		int	arrayIndex
	)

Copies graph nodes of the graph to array.

Parameters

array	Destination array.
arrayIndex	Start index at the destination array.

◆ CopyTo() [2/2]

void Doloro.Graphs.Graph.CopyTo	(	string[]	array,
		int	arrayIndex
	)

Copies GraphNode.signature entries in graph to array.

Parameters

array	Destination array.
arrayIndex	Insertion index at destination array.

◆ GetConnection()

Connection Doloro.Graphs.Graph.GetConnection ( Guid connectionId )

Returns descriptor for the Connection by id.

Parameters

connectionId Id of the connection.

Returns: Instance of connection.

◆ GetEnumerator()

virtual IEnumerator< GraphNode > Doloro.Graphs.Graph.GetEnumerator ( )

virtual

Enumerates nodes withing the graph.

Returns: Nodes enumerator.

◆ GetNodePosition()

virtual Vector3 Doloro.Graphs.Graph.GetNodePosition ( GraphNode node )

virtual

Returns the node's point suggested by the graph logic.

Parameters

node	Target node.

Returns: World position of the node point.

◆ GraphsRegistryChangeHandler()

delegate void Doloro.Graphs.Graph.GraphsRegistryChangeHandler	(	Graph	oldEntry,
		Graph	newEntry
	)

Delegate for an agent that handles.

Parameters

oldEntry	Entry that excluded from the registry.
newEntry	Graph that applied to the registry instead of an old one.

◆ ReleaseConnection()

void Doloro.Graphs.Graph.ReleaseConnection ( Guid id )

package

Releases connection from internal registry.

Parameters

id	Connection.id to release.

◆ Remove() [1/2]

virtual bool Doloro.Graphs.Graph.Remove ( GraphNode node )

virtual

Removing node from the graph.

Parameters

node	Node to release.

Returns: Is the node successfully has been removed from the graph.

Reimplemented in Doloro.Graphs.Fragmented.GraphsNetwork.

◆ Remove() [2/2]

virtual bool Doloro.Graphs.Graph.Remove ( string signature )

virtual

Removing node from the graph.

Parameters

signature Signature of the node to release.

Returns: Is the node successfully has been removed from the graph.

Reimplemented in Doloro.Graphs.Fragmented.GraphsNetwork.

◆ SetConnectionInfo()

void Doloro.Graphs.Graph.SetConnectionInfo ( Connection connection )

package

Adds connection info to the registry.

Parameters

connection Connection to add.

◆ SetNodePosition()

virtual void Doloro.Graphs.Graph.SetNodePosition	(	GraphNode	node,
		Vector3	position
	)

virtual

Defines world position for the certain graph node.

Parameters

node	Node to position declare.
position	World position related to the node.

◆ ToString()

override string Doloro.Graphs.Graph.ToString ( )

Returns graph info.

Returns: String representation of graph instance.

◆ TryGetNode()

virtual bool Doloro.Graphs.Graph.TryGetNode	(	string	signature,
		out GraphNode	node
	)

virtual

Tries to get graph`s node by the signature.

Parameters

signature	GraphNode.signature as access key.
node	Node instance if found.

Returns: Search result.

Property Documentation

◆ nodes

Dictionary<string, GraphNode> Doloro.Graphs.Graph.nodes

getpackage

Graph navigation map.

string - GraphNode.signature <see cref="GraphNode"/> - node instance.

Event Documentation

◆ GraphObsoleted

GraphsRegistryChangeHandler Doloro.Graphs.Graph.GraphObsoleted

static

Occurs when registry overridden with a new graph with id that already has been registered.

Could occur when you loading the graph that has been loaded up to the moment from the binary data.

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

D:/Work/GitHub/DGDK22/Assets/Tauri Interactive/Doloro-GDK/Doloro-Graphs/Runtime/Core/Entities/Graph.cs

Detailed Description

Classes

Public Member Functions

Protected Member Functions

Package Functions

Properties

Events

Member Function Documentation

◆ Add() [1/4]

◆ Add() [2/4]

◆ Add() [3/4]

◆ Add() [4/4]

◆ Add< T >() [1/2]

◆ Add< T >() [2/2]

◆ Contains() [1/2]

◆ Contains() [2/2]

◆ CopyTo() [1/2]

◆ CopyTo() [2/2]

◆ GetConnection()

◆ GetEnumerator()

◆ GetNodePosition()

◆ GraphsRegistryChangeHandler()

◆ ReleaseConnection()

◆ Remove() [1/2]

◆ Remove() [2/2]

◆ SetConnectionInfo()

◆ SetNodePosition()

◆ ToString()

◆ TryGetNode()

Property Documentation

◆ nodes

Event Documentation

◆ GraphObsoleted