Vixen
02b45cc4
csharp
public sealed class VfxGraphView

An effect, open for editing: the graph, the selected block, and the effect running.

No guide page documents this yet — the page shows what the code says about itself.

Remarks

Doc 11's row for this asset is "node graph + live preview viewport", and the three columns here are that: the canvas, which is NodeGraphView's and is already undoable in every gesture; the selected block's numbers, which are NodeInspector's; and the effect itself.

⚠ Compiling and previewing are one button, not two. A preview over a stale artefact is the failure mode that wastes an afternoon — the author changes a block, watches the old effect, and concludes the block does nothing. So Compile is what produces both, and the preview pane draws whatever the last compile left behind.

Fields and properties (11)

  • protected override string TagName

    The element name this type answers to when a caller does not choose one.

  • protected override bool AcceptsFocus

    Whether the focus can rest on this kind of control at all.

  • public NodeGraphView GraphView

    The canvas.

  • public UiElement Side

    The column beside it.

  • public NodeInspector Settings

    The selected block's settings.

  • public VfxPreviewView Preview

    The effect, running.

  • public Button Build

    The button that compiles the graph and restarts the preview.

  • public Button Restart

    The button that starts the effect again.

  • public ToggleButton Play

    The one that pauses it.

  • public UiElement Readout

    What the preview has to say about itself.

  • public UiElement Diagnostics

    What compiling said.

Methods (5)

  • protected override void OnCreated()

    Builds whatever this element is made of, once, as it joins a document.

  • public void Show(VfxDocument effect)

    Shows an effect.

  • protected override void OnRemoved()
  • public int Compile()

    Compiles the graph, restarts the preview, and lists what compiling said.

  • public void Tick(TimeSpan delta)

    Steps the preview and brings its readout up to date.

Used by (2)

  • EditorApplicationVixen.Editor.App
  • VfxEditorFactoryVixen.Editor.AssetEditors