02b45cc4

Guide
- Move sets
- Pose constraints
- The variation harness
- Getting content into a running game
- Components
- Entity queries
- Booleans and handoff
- The editing pipeline
- Element selection
- Face materials
- Foliage mode
- Icons
- The editor shell
- Editable meshes in a scene
- Editor modes
- Building to a number
- Scene menus
- The shape tool
- Snapping
- Sub-object picking
- Sculpt and paint mode
- Writing an editor plugin
- Block-out shapes
- Booting an application
- Character movement
- Editable meshes
- Growing a forest
- Foliage instances
- Grass
- Mesh booleans
- Mesh operations
- Mesh surfaces
- Networked players
- Players and possession
- Splines
- Terrain brushes
- The terrain heightfield
- Painting a terrain
- Sculpting a heightfield
- Saving and restoring a world
- Admission, health and the control plane
- Durable state and the ledger
- Placing players
- Placing realms
- Shards, keys and specs
- The cluster
- The service plane
- Transfer tickets
- Transferring players
- Upgrading a fleet
- Writing a realm
- Drawing foliage
- Drawing grass
- Impostors
- Culling and streaming instances
- Turning on dynamic global illumination
- Meshes and materials, type by type
- Drawing particles
- Lighting a scene in lux and lumens
- Making a room look different
- The post-processing node kinds
- Making everything cast a shadow
- Drawing a terrain
By kind
- Components39
- Systems48
- Controls165
- Shaders48
- Graph nodes64
- Importers22
- Annotations45
- Diagnostics8
- Log events64
All namespaces275
Releases1

Switch

ui control

Core/Vixen.Ui.Controls/Toggles.cs:141

csharp

public sealed class Switch

A switch: a track, and a knob that slides along it.

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

Remarks

⚠ Not a checkbox with a different skin, and the difference is what it means rather than how it looks. A checkbox is a value in a form that is applied when the form is; a switch takes effect the moment it is flipped. A control set that makes them interchangeable produces dialogs with a switch beside an OK button, where nobody can tell whether Cancel undoes it.

Fields and properties (3)

protected override string TagName
The element name this type answers to when a caller does not choose one.
public UiElement Track
The track the knob slides along.
public UiElement Knob
The knob.

Methods (1)

protected override void OnCreated()
Builds whatever this element is made of, once, as it joins a document.

Used by (5)

ShellHelloUi
ButtonTestsVixen.Ui.Controls.Tests
ControlVisualTestsVixen.Ui.Controls.Tests
ToggleInteractionTestsVixen.Ui.Controls.Tests
MarkupBindingVixen.Editor.Inspector