Class Graph

Visject graph

Graph
Graph
Graph
Graph
Graph
Assembly: FlaxEngine.dll
File: Engine/Visject/Graph.h
Syntax
public class Graph<NodeType, BoxType, ParameterType>
Type Parameters
NodeType

BoxType

ParameterType

Constructors

~Graph()

Finalizes an instance of the Graph class.

Declaration
public virtual ~Graph()

Graph()

Initializes a new instance of the Graph class.

Declaration
public Graph()

Fields

Meta

Metadata for whole graph

Declaration
public VisjectMeta Meta
Field Value
VisjectMeta

Nodes

All graph nodes

Declaration
public Array<Node> Nodes
Field Value
Array<Node>

Parameters

All graph parameters

Declaration
public Array<Parameter> Parameters
Field Value
Array<Parameter>

Methods

Clear()

Clear whole graph data

Declaration
public virtual void Clear()

getFreeNodeID()

Declaration
protected uint32 getFreeNodeID() const
Returns
uint32

GetNode(uint32 id)

Find node by ID

Declaration
public Node* GetNode(uint32 id)
Parameters
uint32 id

Node ID
Returns
Node

Node or null if cannot find it

GetParameter(const Guid& id)

Find parameter by ID

Declaration
public Parameter* GetParameter(const Guid& id)
Parameters
Guid id

Parameter ID
Returns
Parameter

Parameter or null if cannot find it

GetParameter(const Guid& id, int32& outIndex)

Find parameter by ID

Declaration
public Parameter* GetParameter(const Guid& id, int32& outIndex)
Parameters
Guid id

Parameter ID
int32 outIndex

Parameter index
Returns
Parameter

Parameter or null if cannot find it

GetReferences(Array<Guid>& assets)

Gets the asset references.

Declaration
public virtual void GetReferences(Array<Guid>& assets) const
Parameters
Array<Guid> assets

The output collection of the asset ids referenced by this object.

Load(ReadStream* stream, bool loadMeta)

Load graph from the stream

Declaration
public virtual bool Load(ReadStream* stream, bool loadMeta)
Parameters
ReadStream stream

Input stream
bool loadMeta

True if load all saved metadata
Returns
bool

True if cannot load data, otherwise false

onNodeCreated(Node* n)

Declaration
protected virtual bool onNodeCreated(Node* n)
Parameters
Node n

Returns
bool

onNodeLoaded(Node* n)

Declaration
protected virtual bool onNodeLoaded(Node* n)
Parameters
Node n

Returns
bool

onParamCreated(Parameter* p)

Declaration
protected virtual bool onParamCreated(Parameter* p)
Parameters
Parameter p

Returns
bool

Save(WriteStream* stream, bool saveMeta)

Save graph to the stream

Declaration
public virtual bool Save(WriteStream* stream, bool saveMeta) const
Parameters
WriteStream stream

Output stream
bool saveMeta

True if save all loaded metadata
Returns
bool

True if cannot save data, otherwise false