FVfxGraph
The particle-attribute flow authored as a node graph. Stores the nodes, their connections and their per-node parameter blobs, and serializes the whole thing to a .vfx MDF document. Compilation to a runtime emitter config lives in FVfxGraphCompiler.
- Module
- Particles
- Header
#include "Particles/VfxGraph.h"- Namespace
Mowo
Public functions
| Returns | Name | Description |
|---|---|---|
std::vector<FVfxGraphNode>& | Nodes | |
const std::vector<FVfxGraphNode>& | Nodes | |
std::vector<FVfxGraphConnection>& | Connections | |
const std::vector<FVfxGraphConnection>& | Connections | |
FVfxGraphNode* | FindNode | |
const FVfxGraphNode* | FindNode | |
std::string | AddNode | Append a node and return its generated id. |
void | RemoveNode | |
bool | Connect | |
void | Disconnect | |
void | Clear | |
FVfxGraphNode* | FindByType | The first node carrying the named ModuleType, or null. |
const FVfxGraphNode* | FindByType | |
void | WriteDocument | |
bool | ReadDocument | |
const std::string& | EmitterName | A .vfx is a system: this graph is its first emitter, and each extra emitter is a graph of its own. |
void | SetEmitterName | |
std::vector<FVfxGraph>& | ExtraEmitters | |
const std::vector<FVfxGraph>& | ExtraEmitters | |
std::vector<const FVfxGraph*> | AllEmitters | The first emitter's graph and then every extra one, in order. |
FVfxGraph& | AddEmitter | Adds an extra emitter holding the starter graph under a name no other emitter of the system uses, and returns it. |
std::string | UniqueEmitterName | |
std::string | SerializeToString | |
bool | LoadFromString | |
const char* | StageToString | |
EVfxStage | StageFromString |
Function details
Nodes
std::vector<FVfxGraphNode>& Nodes()Nodes
const std::vector<FVfxGraphNode>& Nodes() constConnections
std::vector<FVfxGraphConnection>& Connections()Connections
const std::vector<FVfxGraphConnection>& Connections() constFindNode
FVfxGraphNode* FindNode(const std::string& id)FindNode
const FVfxGraphNode* FindNode(const std::string& id) constAddNode
std::string AddNode(EVfxStage stage, const std::string& moduleType, float x, float y)Append a node and return its generated id. The new node starts with empty params; the caller fills them (or the compiler defaults them).
RemoveNode
void RemoveNode(const std::string& id)Connect
bool Connect(const std::string& fromNodeId, const std::string& toNodeId)Disconnect
void Disconnect(const std::string& fromNodeId, const std::string& toNodeId)Clear
void Clear()FindByType
FVfxGraphNode* FindByType(const std::string& moduleType)The first node carrying the named ModuleType, or null. Settings nodes are unique, so this resolves them.
FindByType
const FVfxGraphNode* FindByType(const std::string& moduleType) constWriteDocument
void WriteDocument(MDF::MdfDocument& doc) constReadDocument
bool ReadDocument(const MDF::MdfDocument& doc)EmitterName
const std::string& EmitterName() constA .vfx is a system: this graph is its first emitter, and each extra emitter is a graph of its own. The names are what a SubEmitter node's child_emitter targets; an emitter no SubEmitter claims plays alongside the first at the same transform.
SetEmitterName
void SetEmitterName(const std::string& name)ExtraEmitters
std::vector<FVfxGraph>& ExtraEmitters()ExtraEmitters
const std::vector<FVfxGraph>& ExtraEmitters() constAllEmitters
std::vector<const FVfxGraph*> AllEmitters() constThe first emitter's graph and then every extra one, in order.
AddEmitter
FVfxGraph& AddEmitter(const std::string& baseName)Adds an extra emitter holding the starter graph under a name no other emitter of the system uses, and returns it.
UniqueEmitterName
std::string UniqueEmitterName(const std::string& baseName) constSerializeToString
std::string SerializeToString() constLoadFromString
bool LoadFromString(const std::string& source)StageToString
static const char* StageToString(EVfxStage stage)StageFromString
static EVfxStage StageFromString(const std::string& text)