Detailed Description

Hyper cell of the graph that could be scaled at deep.

Graph vertex address map:

00---------------------01---------------------02
|                      |                       |
|                      50                      |
|                      TC                      |
|                      60                      |
|                      |                       |
10-------------11------12------13-------------14
|              |       |        |              |
|              |       |        |              |
|              |       61       |              |
20--21 LC 22--23--90  Root  91--24--25 RC 26--27
|              |       70       |              |
|              |       |        |              |
|              |       |        |              |
30-------------31------32------33-------------34
|                      |                       |
|                      71                      |
|                      BC                      |
|                      80                      |
|                      |                       |
40---------------------41---------------------42

Legend mark	Representation
TC	TopCluster
LC	LeftCluster
RC	RightCluster
BC	BottomCluster

Inheritance diagram for Doloro.UIEngine2.Modules.Graphs.ClusterGraph:

[legend]

Collaboration diagram for Doloro.UIEngine2.Modules.Graphs.ClusterGraph:

[legend]

Public Member Functions
void	ConnectClusterToNetwork (GraphsNetwork network, Direction clusterDirection)
	Makes connection between an internal cluster and the graph instance withing a GraphsNetwork. More...

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

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...

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 T	Add< T > ()
	Adds new node to the graph. More...

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

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

virtual bool	Remove (string signature)
	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	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...

Static Public Member Functions
static ClusterGraph	Create ()
	Builds graph

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

Package Functions
	ClusterGraph (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
ScalableLineGraph	TopCluster `[get, set]`
	Data graph related to the top sub-cluster.

ScalableLineGraph	LeftCluster `[get, set]`
	Data graph related to the left sub-cluster.

ScalableLineGraph	RightCluster `[get, set]`
	Data graph related to the right sub-cluster.

ScalableLineGraph	BottomCluster `[get, set]`
	Data graph related to the bottom sub-cluster.

override GraphNode	TopEnterNode `[get]`
	Node using for connection to the graph from the above. `01` if TopCluster defined, `12` otherwise. More...

override GraphNode	LeftEnterNode `[get]`
	Node using for connection to the graph from the left. `20` if LeftCluster defined, `23` otherwise. More...

override GraphNode	RightEnterNode `[get]`
	Node using for connection to the graph from the right. `27` if RightCluster defined, `24` otherwise. More...

override GraphNode	BottomEnterNode `[get]`
	Node using for connection to the graph from the bottom. `41` if BottomCluster defined, `32` otherwise. More...

override GraphNode	TopEscapeNode `[get]`
	Node using as start point for top directed path. Node `12`.

override GraphNode	LeftEscapeNode `[get]`
	Node using as start point for left directed path. Node `23`.

override GraphNode	RightEscapeNode `[get]`
	Node using as start point for right directed path. Node `24`.

override GraphNode	BottomEscapeNode `[get]`
	Node using as start point for bottom directed path. Node `32`.

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 ( )

virtualinherited

Adds new GraphNode to the graph.

Returns: Node instance.

◆ Add() [2/4]

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

virtualinherited

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 )

inherited

Creates new GraphNode.

Parameters

signature Node signature.

◆ Add() [4/4]

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

inherited

Creates new GraphNode.

Parameters

signature	Node signature.
node	Created instance.

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

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

virtualinherited

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 )

virtualinherited

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

◆ ConnectClusterToNetwork()

void Doloro.UIEngine2.Modules.Graphs.ClusterGraph.ConnectClusterToNetwork	(	GraphsNetwork	network,
		Direction	clusterDirection
	)

Makes connection between an internal cluster and the graph instance withing a GraphsNetwork.

Parameters

network	Network to setup.
clusterDirection	Cluster direction.

Direction	Representation
Direction.Top	TopCluster
Direction.Left	LeftCluster
Direction.Right	RightCluster
Direction.Bottom	BottomCluster

◆ Contains() [1/2]

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

virtualinherited

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 )

virtualinherited

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
	)

inherited

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
	)

inherited

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 )

inherited

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 ( )

virtualinherited

Enumerates nodes withing the graph.

Returns: Nodes enumerator.

◆ GetNodePosition()

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

virtualinherited

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
	)

inherited

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 )

packageinherited

Releases connection from internal registry.

Parameters

id	Connection.id to release.

◆ Remove() [1/2]

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

virtualinherited

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 )

virtualinherited

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 )

packageinherited

Adds connection info to the registry.

Parameters

connection Connection to add.

◆ SetNodePosition()

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

virtualinherited

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 ( )

inherited

Returns graph info.

Returns: String representation of graph instance.

◆ TryGetNode()

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

virtualinherited

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

◆ BottomEnterNode

override GraphNode Doloro.UIEngine2.Modules.Graphs.ClusterGraph.BottomEnterNode

get

Node using for connection to the graph from the bottom. 41 if BottomCluster defined, 32 otherwise.

>

◆ LeftEnterNode

override GraphNode Doloro.UIEngine2.Modules.Graphs.ClusterGraph.LeftEnterNode

get

Node using for connection to the graph from the left. 20 if LeftCluster defined, 23 otherwise.

>

◆ nodes

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

getpackageinherited

Graph navigation map.

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

◆ RightEnterNode

override GraphNode Doloro.UIEngine2.Modules.Graphs.ClusterGraph.RightEnterNode

get

Node using for connection to the graph from the right. 27 if RightCluster defined, 24 otherwise.

>

◆ TopEnterNode

override GraphNode Doloro.UIEngine2.Modules.Graphs.ClusterGraph.TopEnterNode

get

Node using for connection to the graph from the above. 01 if TopCluster defined, 12 otherwise.

>

Event Documentation

◆ GraphObsoleted

GraphsRegistryChangeHandler Doloro.Graphs.Graph.GraphObsoleted

staticinherited

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-UI-2-Graphs/Runtime/Core/Graphs/ClusterGraph.cs

Detailed Description

Public Member Functions

Static 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]

◆ ConnectClusterToNetwork()

◆ 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

◆ BottomEnterNode

◆ LeftEnterNode

◆ nodes

◆ RightEnterNode

◆ TopEnterNode

Event Documentation

◆ GraphObsoleted