All Classes Namespaces Functions Variables Enumerations Enumerator Properties
plyCommon.plyGraph Class Reference

A graph is a container for connected/ linked nodes More...

Inherits plyCommon.plyMetaDataInterface.

Public Member Functions

void OnCreated ()
 Called by editor when the graph is created (in editor) More...
 
void Awake (plyGraphManager owningGraphManager)
 Called at runtime after graph was Deserialize More...
 
override string ToString ()
 
void Serialize ()
 
void Deserialize ()
 
plyNode GetNodeById (int id)
 
Dictionary< string, plyMetaDataAllMetaData ()
 
List< plyMetaDataAllMetaDataList ()
 
plyMetaData GetMetaData (string name)
 Return reference to meta data object. Null if not found. More...
 
object GetMetaDataValue (string name)
 Return meta data value. Null if named meta data not found. More...
 
void SetMetaDataValue (string name, object val)
 Set meta data value. Will create the named meta data if not found and then set value. More...
 

Public Attributes

UniqueID id = new UniqueID()
 Unique ID to identify this graph by More...
 
string name = ""
 Name of graph. Name can be changed via graph editor More...
 
string customIdent = ""
 A custom identifier you may use to identify the graph by More...
 
string comment = ""
 Optional comment More...
 
plyMetaData[] metaData = new plyMetaData[0]
 Meta data is optional data/ information that the designer may associate with the graph. Do not access at runtime, use provided functions. More...
 
plySerializedData data = new plySerializedData()
 The serialised graph node data. Do not access this directly. More...
 
Vector2 __view_offset = Vector2.zero
 used by editor. More...
 

Properties

List< plyNodenodes [get]
 All nodes contained in the graph More...
 
plyNode startNode [get]
 The first node of the graph More...
 
static GameObject activeGO [get, set]
 This is a helper for some Nodes that might need an active object set. How this is used will depend on what is using it. More...
 
plyGraphManager owningGraphManager [get, set]
 The (runtime) GraphManager that owns this node More...
 
Dictionary< string, plyMetaDataruntimeMetaData [get, set]
 

Detailed Description

A graph is a container for connected/ linked nodes

Member Function Documentation

void plyCommon.plyGraph.Awake ( plyGraphManager  owningGraphManager)

Called at runtime after graph was Deserialize

plyMetaData plyCommon.plyGraph.GetMetaData ( string  name)

Return reference to meta data object. Null if not found.

Implements plyCommon.plyMetaDataInterface.

object plyCommon.plyGraph.GetMetaDataValue ( string  name)

Return meta data value. Null if named meta data not found.

Implements plyCommon.plyMetaDataInterface.

void plyCommon.plyGraph.OnCreated ( )

Called by editor when the graph is created (in editor)

void plyCommon.plyGraph.SetMetaDataValue ( string  name,
object  val 
)

Set meta data value. Will create the named meta data if not found and then set value.

Implements plyCommon.plyMetaDataInterface.

Member Data Documentation

Vector2 plyCommon.plyGraph.__view_offset = Vector2.zero

used by editor.

string plyCommon.plyGraph.comment = ""

Optional comment

string plyCommon.plyGraph.customIdent = ""

A custom identifier you may use to identify the graph by

plySerializedData plyCommon.plyGraph.data = new plySerializedData()

The serialised graph node data. Do not access this directly.

UniqueID plyCommon.plyGraph.id = new UniqueID()

Unique ID to identify this graph by

plyMetaData [] plyCommon.plyGraph.metaData = new plyMetaData[0]

Meta data is optional data/ information that the designer may associate with the graph. Do not access at runtime, use provided functions.

string plyCommon.plyGraph.name = ""

Name of graph. Name can be changed via graph editor

Property Documentation

GameObject plyCommon.plyGraph.activeGO
staticgetset

This is a helper for some Nodes that might need an active object set. How this is used will depend on what is using it.

List<plyNode> plyCommon.plyGraph.nodes
get

All nodes contained in the graph

plyGraphManager plyCommon.plyGraph.owningGraphManager
getset

The (runtime) GraphManager that owns this node

plyNode plyCommon.plyGraph.startNode
get

The first node of the graph