Skip to content
Bit Quirky Behavior Trees and
State Machines

Search documentation

All topics and APIs

Close returns focus to Search.

What are you looking for?

Try a common topic or enter a complete API identifier.

Browse the reference instead

Esc closes · Tab reaches results · Enter opens the focused link

v0.11.0
Menu

Assembly: BitQuirky.Graph.GraphView.Editor

Category: Low-level runtime

C#
enum BitQuirky.Graph.GraphView.Preferences.GraphPreviewOrientation

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferencesProvider.cs:20-26

Underlying type: int

Flow direction of the preferences live-preview sample graph. Vertical reads top-to-bottom like a behavior tree; Horizontal reads left-to-right like a code / data-flow graph.

C#
Horizontal = 1

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferencesProvider.cs:25

Entry on the left, children to the right.

C#
Vertical = 0

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferencesProvider.cs:23

Parent above, children below.

Category: Low-level runtime

C#
class BitQuirky.Graph.GraphView.Preferences.GraphViewPreferenceDefaults

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferenceStore.cs:14-54

The values aGraphViewPreferenceStorefalls back to when the reader has never set a preference, and the values a reset restores. A product supplies one of these so its canvas starts out looking like itself.

C#
public UnityEngine.Color CanvasBackground { get; set; }

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferenceStore.cs:23

Starting canvas backdrop color.

C#
public UnityEngine.Color EdgeActiveColor { get; set; }

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferenceStore.cs:47

Starting color of an edge marked active.

C#
public float EdgeActiveStrokeWidth { get; set; }

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferenceStore.cs:49

Starting stroke width of an edge marked active.

C#
public UnityEngine.Color EdgeIdleColor { get; set; }

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferenceStore.cs:41

Starting color of an edge at rest.

C#
public float EdgeIdleOpacity { get; set; }

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferenceStore.cs:45

Starting opacity of an edge at rest.

C#
public float EdgeIdleStrokeWidth { get; set; }

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferenceStore.cs:43

Starting stroke width of an edge at rest.

C#
public int EdgeRoutingIndex { get; set; }

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferenceStore.cs:39

Starting wire routing, as an index into GraphEdgeRouting.

C#
public int EdgeStyleIndex { get; set; }

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferenceStore.cs:53

Starting edge style, as an index into the product’s style list.

C#
public UnityEngine.Color GridDot { get; set; }

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferenceStore.cs:27

Starting grid dot color.

C#
public int GridDotFrequency { get; set; }

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferenceStore.cs:35

Starting number of intersections between grid dots.

C#
public float GridDotRadius { get; set; }

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferenceStore.cs:37

Starting radius in graph units of a grid dot.

C#
public UnityEngine.Color GridLine { get; set; }

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferenceStore.cs:25

Starting grid line color.

C#
public float GridSpacing { get; set; }

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferenceStore.cs:33

Starting distance in graph units between grid lines.

C#
public bool InvertZoomDirection { get; set; }

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferenceStore.cs:19

Whether scrolling up zooms out instead of in.

C#
public int NodeDensityIndex { get; set; }

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferenceStore.cs:51

Starting node density, as an index from compact through spacious.

C#
public bool ScrollMovesViewport { get; set; }

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferenceStore.cs:17

Whether an unmodified scroll pans the canvas rather than zooming it. Defaults to true on macOS, where trackpad scrolling reads as panning.

C#
public bool ShowGridLines { get; set; }

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferenceStore.cs:29

Whether ruled grid lines start out visible.

C#
public bool SnapToGrid { get; set; }

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferenceStore.cs:31

Starting state of Snap to Grid. Defaults to false; a product opts in through its own defaults instance.

C#
public float ZoomSensitivity { get; set; }

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferenceStore.cs:21

Starting multiplier applied to each wheel notch before it changes zoom.

Category: Low-level runtime

C#
class BitQuirky.Graph.GraphView.Preferences.GraphViewPreferenceRow

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferencesProvider.cs:96-121

One product-owned setting on the shared preferences page. The product owns the value; the page reads and writes it through the row’s accessors and restores its default through Resetwhen the user presses “Reset all”.

C#
public string Description { get; }

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferencesProvider.cs:112

The dimmer line under the name; empty for none.

C#
public System.Func<bool> IsEnabled { get; }

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferencesProvider.cs:120

Whether the row can be edited right now (for example, only while another product setting is on); the page greys a disabled row out and re-asks after every product value changes. Null keeps the row always editable.

C#
public string Label { get; }

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferencesProvider.cs:110

The row’s name.

C#
public System.Action Reset { get; }

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferencesProvider.cs:114

Restores the default value.

GraphViewPreferenceRow(string label, string description, Action reset, Func<bool> isEnabled)

Section titled “GraphViewPreferenceRow(string label, string description, Action reset, Func<bool> isEnabled)”
C#
protected GraphViewPreferenceRow(string label, string description, System.Action reset, System.Func<bool> isEnabled)

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferencesProvider.cs:100-107

Exceptions

  • ArgumentException: label is empty.
  • ArgumentNullException: reset is null.

Category: Low-level runtime

C#
class BitQuirky.Graph.GraphView.Preferences.GraphViewPreferenceSection

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferencesProvider.cs:188-203

A captioned group of product-owned rows on the shared preferences page.

C#
public System.Collections.Generic.IReadOnlyList<BitQuirky.Graph.GraphView.Preferences.GraphViewPreferenceRow> Rows { get; }

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferencesProvider.cs:202

The section’s rows, in display order.

C#
public string Title { get; }

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferencesProvider.cs:200

The section caption, such as READ PILLS.

GraphViewPreferenceSection(string title, IReadOnlyList<GraphViewPreferenceRow> rows)

Section titled “GraphViewPreferenceSection(string title, IReadOnlyList<GraphViewPreferenceRow> rows)”
C#
public GraphViewPreferenceSection(string title, System.Collections.Generic.IReadOnlyList<BitQuirky.Graph.GraphView.Preferences.GraphViewPreferenceRow> rows)

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferencesProvider.cs:191-197

Exceptions

  • ArgumentException: title is empty or there are no rows.

Category: Low-level runtime

C#
class BitQuirky.Graph.GraphView.Preferences.GraphViewPreferenceSlider

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferencesProvider.cs:151-185

Inherits: GraphViewPreferenceRow

A product-owned number chosen on a slider (with a typed-value field beside it), shown with two decimals and an optional unit word such ascards.

C#
public System.Func<float> Getter { get; }

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferencesProvider.cs:176

Reads the stored value.

C#
public float Maximum { get; }

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferencesProvider.cs:182

The slider’s right end.

C#
public float Minimum { get; }

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferencesProvider.cs:180

The slider’s left end.

C#
public System.Action<float> Setter { get; }

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferencesProvider.cs:178

Stores a value the user chose (already within the slider’s range).

C#
public string Unit { get; }

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferencesProvider.cs:184

The word after the number; empty for none.

GraphViewPreferenceSlider(string label, string description, Func<float> getter, Action<float> setter, Action reset, float minimum, float maximum, string unit, Func<bool> isEnabled)

Section titled “GraphViewPreferenceSlider(string label, string description, Func<float> getter, Action<float> setter, Action reset, float minimum, float maximum, string unit, Func<bool> isEnabled)”
C#
public GraphViewPreferenceSlider(string label, string description, System.Func<float> getter, System.Action<float> setter, System.Action reset, float minimum, float maximum, string unit, System.Func<bool> isEnabled = null)

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferencesProvider.cs:155-173

Exceptions

  • ArgumentException: label is empty, or the range is empty.
  • ArgumentNullException: A getter, setter, or reset is null.

Category: Low-level runtime

C#
class BitQuirky.Graph.GraphView.Preferences.GraphViewPreferenceStore

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferenceStore.cs:62-540

Reads and writes the canvas preferences for one product, keyed by a prefix so several products can keep their own settings side by side in the editor’s preference storage. Every value is clamped to its published range on both read and write, and a change raisesChangedso open windows can re-apply it immediately.

C#
public UnityEngine.Color CanvasBackground { get; set; }

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferenceStore.cs:169-173

Backdrop color painted behind the whole canvas. Defaults to the shared dark palette’s canvas background, andCreateThemelayers this over that palette.

C#
public UnityEngine.Color EdgeActiveColor { get; set; }

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferenceStore.cs:324-328

Color of a wire the host has marked active, which is how a highlighted path reads against the idle wires. Defaults to the shared palette’s active edge color.

C#
public float EdgeActiveStrokeWidth { get; set; }

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferenceStore.cs:336-340

Stroke width a wire the host has marked active is drawn with; setting it above EdgeIdleStrokeWidthis what makes an active wire stand out. Defaults to the shared active stroke width, and both reads and writes clamp to EdgeStrokeWidthMinimum..EdgeStrokeWidthMaximum.

C#
public UnityEngine.Color EdgeIdleColor { get; set; }

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferenceStore.cs:290-294

Color of a wire at rest, meaning neither active, hovered, nor selected. Defaults to the shared palette’s idle edge color.

C#
public float EdgeIdleOpacity { get; set; }

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferenceStore.cs:314-318

Opacity of a wire at rest, from 0 to 1, used to push idle wires behind the nodes. Defaults to the shared idle opacity, and both reads and writes clamp to EdgeOpacityMinimum..EdgeOpacityMaximum- the floor keeps a wire visible rather than letting it disappear.

C#
public float EdgeIdleStrokeWidth { get; set; }

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferenceStore.cs:302-306

Stroke width a wire at rest is drawn with - the baseline the heavier active, hovered, and selected treatments read against. Defaults to the shared idle stroke width, and both reads and writes clamp to EdgeStrokeWidthMinimum..EdgeStrokeWidthMaximum.

C#
public BitQuirky.Graph.GraphView.GraphEdgeRouting EdgeRouting { get; }

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferenceStore.cs:268-284

The stored routing choice as the value the canvas draws with: index 0 is Orthogonal, 1 Bezier, and 2Straight. Read-only; write EdgeRoutingIndexto change it.

C#
public int EdgeRoutingIndex { get; set; }

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferenceStore.cs:256-260

The stored routing choice as a raw index, which is what a segmented control or popup binds to. Defaults to 1, meaning curved wires. Both reads and writes clamp to EdgeRoutingMinimumIndex..EdgeRoutingMaximumIndex, so the index always maps to a routing. ReadEdgeRoutingto draw with it.

C#
public int EdgeStyleIndex { get; set; }

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferenceStore.cs:360-364

Which of the product’s wire styles is in use, as an index from EdgeStyleMinimumIndex to EdgeStyleMaximumIndex. Defaults to 0, the product’s first style. Both reads and writes clamp to that range. Separate from EdgeRoutingIndex, which chooses the path rather than the look.

C#
public UnityEngine.Color GridDot { get; set; }

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferenceStore.cs:190-194

Color of the grid dots marking intersections. Defaults to the shared dark palette’s grid dot color. Independent ofShowGridLines: dots stay visible with lines off, which is how the canvas keeps a sense of scale without ruling.

C#
public int GridDotFrequency { get; set; }

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferenceStore.cs:233-237

How many grid intersections apart the dots are drawn: 1 dots every intersection, 2 every other one. Defaults to 1, and both reads and writes clamp to GridDotFrequencyMinimum..GridDotFrequencyMaximum.

C#
public float GridDotRadius { get; set; }

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferenceStore.cs:244-248

Radius of one grid dot, in the same graph units asGridSpacing. Defaults to 0.85, and both reads and writes clamp to GridDotRadiusMinimum..GridDotRadiusMaximum.

C#
public UnityEngine.Color GridLine { get; set; }

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferenceStore.cs:179-183

Color of the ruled grid lines, used only whileShowGridLinesis on. Defaults to the shared dark palette’s grid line color.

C#
public float GridSpacing { get; set; }

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferenceStore.cs:222-226

Distance in graph units between adjacent grid lines, which is also the spacing of the intersections dots can land on. Defaults to 20, and both reads and writes clamp to GridSpacingMinimum..GridSpacingMaximum.

C#
public bool InvertZoomDirection { get; set; }

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferenceStore.cs:147-151

Whether scrolling up zooms out instead of in. Defaults to false, so scrolling up zooms in; turning it on suits readers who expect the canvas rather than the view to move.

C#
public int NodeDensityIndex { get; set; }

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferenceStore.cs:348-352

How much padding and spacing node cards carry, as an index from NodeDensityMinimumIndex(most compact, fits the most on screen) through NodeDensityMaximumIndex(most spacious). Defaults to 1, the middle step. Both reads and writes clamp to that range.

C#
public bool ScrollMovesViewport { get; set; }

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferenceStore.cs:137-141

Whether an unmodified scroll pans the canvas, leaving zoom to Control-scroll, rather than zooming directly. Defaults to true on macOS and false elsewhere, matching each platform’s usual trackpad convention. DrivesScrollWheelBehavior.

C#
public BitQuirky.Graph.GraphView.GraphScrollWheelBehavior ScrollWheelBehavior { get; }

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferenceStore.cs:372-375

What the scroll wheel does, derived fromScrollMovesViewport: PanWithControlZoomwhen scrolling pans and Control-scroll zooms, otherwiseZoom. Read-only; setScrollMovesViewportto change it.

C#
public bool ShowGridLines { get; set; }

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferenceStore.cs:200-204

Whether the ruled grid lines are drawn at all. Defaults to true; turning it off leaves the dots as the only grid cue.

C#
public bool SnapToGrid { get; set; }

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferenceStore.cs:211-215

Whether a node-move write site rounds the written position to the nearest grid intersection. Defaults to the product’s ownSnapToGrid. DrivesSnapToGridEnabled via ApplyTo.

C#
public float ZoomSensitivity { get; set; }

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferenceStore.cs:159-163

Multiplier applied to each wheel notch before it changes zoom: higher reaches a given zoom in fewer notches. Defaults to 1, and both reads and writes clamp to ZoomSensitivityMinimum..ZoomSensitivityMaximum, so a value stored by an older build can never make zoom unusable.

C#
public event System.Action Changed

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferenceStore.cs:108

Raised after any preference actually changes value, so an open canvas can re-apply the settings. Writing the value a preference already holds raises nothing.

C#
public const float EdgeOpacityMaximum = 1

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferenceStore.cs:99

Largest accepted edge opacity.

C#
public const float EdgeOpacityMinimum = 0.1

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferenceStore.cs:97

Smallest accepted edge opacity, which still leaves a wire visible.

C#
public const int EdgeRoutingMaximumIndex = 2

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferenceStore.cs:91

Highest routing index, matching the last GraphEdgeRouting value.

C#
public const int EdgeRoutingMinimumIndex = 0

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferenceStore.cs:89

Lowest routing index, matching the first GraphEdgeRouting value.

C#
public const float EdgeStrokeWidthMaximum = 3

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferenceStore.cs:95

Largest accepted edge stroke width.

C#
public const float EdgeStrokeWidthMinimum = 0.75

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferenceStore.cs:93

Smallest accepted edge stroke width.

C#
public const int EdgeStyleMaximumIndex = 2

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferenceStore.cs:87

Highest edge-style index.

C#
public const int EdgeStyleMinimumIndex = 0

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferenceStore.cs:85

Lowest edge-style index.

C#
public const int GridDotFrequencyMaximum = 8

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferenceStore.cs:75

Largest accepted number of intersections between grid dots.

C#
public const int GridDotFrequencyMinimum = 1

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferenceStore.cs:73

Smallest accepted number of intersections between grid dots.

C#
public const float GridDotRadiusMaximum = 3

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferenceStore.cs:79

Largest accepted grid dot radius, in graph units.

C#
public const float GridDotRadiusMinimum = 0.1

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferenceStore.cs:77

Smallest accepted grid dot radius, in graph units.

C#
public const float GridSpacingMaximum = 64

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferenceStore.cs:71

Largest accepted grid spacing, in graph units.

C#
public const float GridSpacingMinimum = 8

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferenceStore.cs:69

Smallest accepted grid spacing, in graph units.

C#
public const int NodeDensityMaximumIndex = 2

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferenceStore.cs:83

Highest node-density index, the most spacious setting.

C#
public const int NodeDensityMinimumIndex = 0

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferenceStore.cs:81

Lowest node-density index, the most compact setting.

C#
public const float ZoomSensitivityMaximum = 2

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferenceStore.cs:67

Largest accepted zoom sensitivity.

C#
public const float ZoomSensitivityMinimum = 0.25

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferenceStore.cs:65

Smallest accepted zoom sensitivity.

GraphViewPreferenceStore(string keyPrefix, GraphViewPreferenceDefaults defaults)

Section titled “GraphViewPreferenceStore(string keyPrefix, GraphViewPreferenceDefaults defaults)”
C#
public GraphViewPreferenceStore(string keyPrefix, BitQuirky.Graph.GraphView.Preferences.GraphViewPreferenceDefaults defaults)

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferenceStore.cs:119-130

Opens the store for one product.keyPrefixnamespaces every stored key, and a trailing dot is appended when absent, so two products never read each other’s settings;defaultssupplies the value each preference reports until the reader writes one, and the value a reset restores. Throws ArgumentExceptionon a blank prefix and ArgumentNullExceptionon null defaults, because a store with no namespace or no fallbacks would silently report wrong settings.

C#
public void ApplyTo(BitQuirky.Graph.GraphView.GraphViewHost host)

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferenceStore.cs:421-444

Applies every stored preference to a live canvas, repainting it. A null host is ignored, so a caller need not check whether its window is open.

C#
public void ApplyTo(BitQuirky.Graph.GraphView.GraphViewOptions options)

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferenceStore.cs:393-415

Copies every stored preference into an options object, for a canvas that has not been built yet.

Exceptions

  • ArgumentNullException: options is null.

C#
public BitQuirky.Graph.GraphView.GraphTheme CreateTheme()

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferenceStore.cs:380-386

Builds a theme from the stored canvas and grid colors over the shared dark palette.

C#
public void ResetAll()

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferenceStore.cs:450-459

Restores every preference to its default, raising a change for each value that actually moved.

C#
public void ResetEdges()

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferenceStore.cs:481-489

Restores the edge preferences to their defaults, leaving the canvas, grid, and interaction settings alone.

C#
public void ResetGrid()

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferenceStore.cs:465-475

Restores the canvas and grid preferences to their defaults, leaving interaction and edge settings alone.

Category: Low-level runtime

C#
class BitQuirky.Graph.GraphView.Preferences.GraphViewPreferenceToggle

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferencesProvider.cs:124-145

Inherits: GraphViewPreferenceRow

A product-owned on/off setting.

C#
public System.Func<bool> Getter { get; }

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferencesProvider.cs:142

Reads the stored value.

C#
public System.Action<bool> Setter { get; }

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferencesProvider.cs:144

Stores a value the user chose.

GraphViewPreferenceToggle(string label, string description, Func<bool> getter, Action<bool> setter, Action reset, Func<bool> isEnabled)

Section titled “GraphViewPreferenceToggle(string label, string description, Func<bool> getter, Action<bool> setter, Action reset, Func<bool> isEnabled)”
C#
public GraphViewPreferenceToggle(string label, string description, System.Func<bool> getter, System.Action<bool> setter, System.Action reset, System.Func<bool> isEnabled = null)

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferencesProvider.cs:128-139

Exceptions

  • ArgumentException: label is empty.
  • ArgumentNullException: A getter, setter, or reset is null.

Category: Low-level runtime

C#
class BitQuirky.Graph.GraphView.Preferences.GraphViewPreferencesProvider

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferencesProvider.cs:209-1191

Creates the shared canvas preferences page, so every product exposes the same grid, edge, and interaction settings in its own place in the editor’s preferences.

Create(GraphViewPreferenceStore store, GraphViewPreferencesProviderOptions options)

Section titled “Create(GraphViewPreferenceStore store, GraphViewPreferencesProviderOptions options)”
C#
public static UnityEditor.SettingsProvider Create(BitQuirky.Graph.GraphView.Preferences.GraphViewPreferenceStore store, BitQuirky.Graph.GraphView.Preferences.GraphViewPreferencesProviderOptions options)

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferencesProvider.cs:225-242

Builds the editor preferences page for a product’s canvas, reading and writing through storeso every change applies immediately.

Exceptions

  • ArgumentNullException: storeor options is null.
  • ArgumentException: The options carry no path or no label.

Category: Low-level runtime

C#
class BitQuirky.Graph.GraphView.Preferences.GraphViewPreferencesProviderOptions

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferencesProvider.cs:32-89

How a product identifies and captions its canvas preferences page, and which parts of that page it supplies itself.

C#
public System.Func<UnityEngine.UIElements.VisualElement> HeaderIconBuilder { get; set; }

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferencesProvider.cs:59

Optional builder for the header icon tile content. When set the tile drops its generic border / fill and the returned element owns the whole tile (product app glyphs). Null keeps the generic three-dot tile.

C#
public string HeaderSubtitle { get; set; }

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferencesProvider.cs:41

Line under the headline; defaults to a note that changes take effect at once.

C#
public string HeaderTitle { get; set; }

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferencesProvider.cs:39

Headline shown at the top of the page.

C#
public System.Collections.Generic.IEnumerable<string> Keywords { get; set; }

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferencesProvider.cs:43

Words that match this page in the preferences search box.

C#
public string Label { get; set; }

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferencesProvider.cs:37

The page’s name in the preferences list. Required.

C#
public string Path { get; set; }

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferencesProvider.cs:35

Where the page appears in the editor’s preferences tree, such as Preferences/My Product/Graph. Required.

C#
public BitQuirky.Graph.GraphView.Preferences.GraphPreviewOrientation PreviewOrientation { get; set; }

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferencesProvider.cs:51

Orientation of the live-preview sample graph. Defaults to Verticalso behavior-tree consumers are unaffected; code-flow consumers pass Horizontal.

C#
public System.Func<BitQuirky.Graph.GraphView.Preferences.GraphViewPreferenceStore, UnityEngine.UIElements.VisualElement> PreviewSampleBuilder { get; set; }

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferencesProvider.cs:68

Optional builder for the live-preview sample content layered over the grid. When set the provider suppresses its default entry / value / return sample nodes and painted edges; the returned element fills the preview and owns every sample node, edge, and caption. Null keeps the generic sample graph.

C#
public string ProductSectionTitle { get; set; }

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferencesProvider.cs:74

Caption of the section that holdsProductToggles, such as TOOLBAR. Required when any product toggle is supplied.

C#
public System.Collections.Generic.IReadOnlyList<BitQuirky.Graph.GraphView.Preferences.GraphViewPreferenceSection> ProductSections { get; set; }

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferencesProvider.cs:88

Further product-owned sections, each with its own caption, shown in order below the ProductTogglessection and above the shared ones, with the same row chrome. “Reset all” resets their rows too. Null or empty adds none.

C#
public System.Collections.Generic.IReadOnlyList<BitQuirky.Graph.GraphView.Preferences.GraphViewPreferenceToggle> ProductToggles { get; set; }

Source declaration: ../bitquirky-graph/Editor/GraphView/Preferences/GraphViewPreferencesProvider.cs:81

On/off settings the product stores itself (outside the shared canvas store), shown in their own section above the shared ones, with the same row chrome. “Reset all” resets them too. Null or empty adds no section.

Source fingerprint: sha256:29003d8b1658b98a79bebcd93e3b4030caf8511268b96817ab764d63df8d6c3b

Full-size image