Doloro GDK 22 .1.0 Beta
by Tauri Interactive
Doloro.Graphs.GraphNodeAPI Class Reference

Detailed Description

Static API for GraphNode related operations.

Static Public Member Functions

static Connection Connect (this GraphNode node1, GraphNode node2, int weight, params object[] args)
 Establishes a connection between two nodes. More...
 
static Connection Connect (this GraphNode node1, GraphNode node2, bool isDuplex, params object[] args)
 Establishes a connection between two nodes. More...
 
static Connection Connect (this GraphNode node1, GraphNode node2, int weight, bool isDuplex, params object[] args)
 Establishes a connection between two nodes. More...
 
static Connection Connect (this GraphNode node1, GraphNode node2, params object[] args)
 Establishes a connection between two nodes. More...
 
static T Connect< T > (this GraphNode node1, GraphNode node2, int weight, params object[] args)
 Establishes a connection between two nodes. More...
 
static T Connect< T > (this GraphNode node1, GraphNode node2, bool isDuplex, params object[] args)
 Establishes a connection between two nodes. More...
 
static T Connect< T > (this GraphNode node1, GraphNode node2, int weight, bool isDuplex, params object[] args)
 Establishes a connection between two nodes. More...
 
static T Connect< T > (this GraphNode node1, GraphNode node2, params object[] args)
 Establishes a connection between two nodes. More...
 
static bool Disconnect (this GraphNode node1, GraphNode node2)
 Releases entire connections between two nodes. More...
 
static void DisconnectAll (this GraphNode node)
 Releases entire connections established with the node. More...
 
static void SetPostion (this GraphNode node, Vector3 position)
 Defines world position for the certain graph node. More...
 
static Vector3 GetPostion (this GraphNode node)
 Returns the node's point suggested by the graph logic. More...
 

Member Function Documentation

◆ Connect() [1/4]

static Connection Doloro.Graphs.GraphNodeAPI.Connect ( this GraphNode  node1,
GraphNode  node2,
bool  isDuplex,
params object[]  args 
)
static

Establishes a connection between two nodes.

Template Parameters
TType of the connection to use.
Parameters
node1First node.
node2Second node.
isDuplexDefines is the connection could be used in two ways.
argsCustom arguments applied to the bond.
Returns
Established connection instance.
Exceptions
NotSupportedExceptionAttempt to connect nodes located at different graphs.
NotSupportedExceptionNode not attached to an any graph.

◆ Connect() [2/4]

static Connection Doloro.Graphs.GraphNodeAPI.Connect ( this GraphNode  node1,
GraphNode  node2,
int  weight,
bool  isDuplex,
params object[]  args 
)
static

Establishes a connection between two nodes.

Template Parameters
TType of the connection to use.
Parameters
node1First node.
node2Second node.
weightWeight of the connection.
isDuplexDefines is the connection could be used in two ways.
argsCustom arguments applied to the bond.
Returns
Established connection instance.
Exceptions
NotSupportedExceptionAttempt to connect nodes located at different graphs.
NotSupportedExceptionNode not attached to an any graph.

◆ Connect() [3/4]

static Connection Doloro.Graphs.GraphNodeAPI.Connect ( this GraphNode  node1,
GraphNode  node2,
int  weight,
params object[]  args 
)
static

Establishes a connection between two nodes.

Parameters
node1First node.
node2Second node.
weightWeight of the connection.
argsCustom arguments applied to the bond.
Returns
Established connection instance.
Exceptions
NotSupportedExceptionAttempt to connect nodes located at different graphs.
NotSupportedExceptionNode not attached to an any graph.

◆ Connect() [4/4]

static Connection Doloro.Graphs.GraphNodeAPI.Connect ( this GraphNode  node1,
GraphNode  node2,
params object[]  args 
)
static

Establishes a connection between two nodes.

Parameters
node1First node.
node2Second node.
argsCustom arguments applied to the bond.
Returns
Established connection instance.
Exceptions
NotSupportedExceptionAttempt to connect nodes located at different graphs.
NotSupportedExceptionNode not attached to an any graph.

◆ Connect< T >() [1/4]

static T Doloro.Graphs.GraphNodeAPI.Connect< T > ( this GraphNode  node1,
GraphNode  node2,
bool  isDuplex,
params object[]  args 
)
static

Establishes a connection between two nodes.

Template Parameters
TType of the connection to use.
Parameters
node1First node.
node2Second node.
isDuplexDefines is the connection could be used in two ways.
argsCustom arguments applied to the bond.
Returns
Established connection instance.
Exceptions
NotSupportedExceptionAttempt to connect nodes located at different graphs.
NotSupportedExceptionNode not attached to an any graph.
Type Constraints
T :Connection 
T :new() 

◆ Connect< T >() [2/4]

static T Doloro.Graphs.GraphNodeAPI.Connect< T > ( this GraphNode  node1,
GraphNode  node2,
int  weight,
bool  isDuplex,
params object[]  args 
)
static

Establishes a connection between two nodes.

Template Parameters
TType of the connection to use.
Parameters
node1First node.
node2Second node.
weightWeight of the connection.
isDuplexDefines is the connection could be used in two ways.
argsCustom arguments applied to the bond.
Returns
Established connection instance.
Exceptions
NotSupportedExceptionAttempt to connect nodes located at different graphs.
NotSupportedExceptionNode not attached to an any graph.
Type Constraints
T :Connection 
T :new() 

◆ Connect< T >() [3/4]

static T Doloro.Graphs.GraphNodeAPI.Connect< T > ( this GraphNode  node1,
GraphNode  node2,
int  weight,
params object[]  args 
)
static

Establishes a connection between two nodes.

Template Parameters
TType of the connection to use.
Parameters
node1First node.
node2Second node.
weightWeight of the connection.
argsCustom arguments applied to the bond.
Returns
Established connection instance.
Exceptions
NotSupportedExceptionAttempt to connect nodes located at different graphs.
NotSupportedExceptionNode not attached to an any graph.
Type Constraints
T :Connection 
T :new() 

◆ Connect< T >() [4/4]

static T Doloro.Graphs.GraphNodeAPI.Connect< T > ( this GraphNode  node1,
GraphNode  node2,
params object[]  args 
)
static

Establishes a connection between two nodes.

Template Parameters
TType of the connection to use.
Parameters
node1First node.
node2Second node.
argsCustom arguments applied to the bond.
Returns
Established connection instance.
Exceptions
NotSupportedExceptionAttempt to connect nodes located at different graphs.
NotSupportedExceptionNode not attached to an any graph.
Type Constraints
T :Connection 
T :new() 

◆ Disconnect()

static bool Doloro.Graphs.GraphNodeAPI.Disconnect ( this GraphNode  node1,
GraphNode  node2 
)
static

Releases entire connections between two nodes.

Parameters
node1First node.
node2Second node.
Returns
Is the nodes had been connected before call.

◆ DisconnectAll()

static void Doloro.Graphs.GraphNodeAPI.DisconnectAll ( this GraphNode  node)
static

Releases entire connections established with the node.

Parameters
nodeNode to connections release.

◆ GetPostion()

static Vector3 Doloro.Graphs.GraphNodeAPI.GetPostion ( this GraphNode  node)
static

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

Parameters
nodeTarget node.
Returns
World position of the node point.
Exceptions
InvalidOperationExceptionNode isn't located within a Graph>

◆ SetPostion()

static void Doloro.Graphs.GraphNodeAPI.SetPostion ( this GraphNode  node,
Vector3  position 
)
static

Defines world position for the certain graph node.

Parameters
nodeNode to position declare.
positionWorld position related to the node.
Exceptions
InvalidOperationExceptionNode isn't located within a Graph>

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