Vixen
dd8b0a81
csharp
public sealed class SceneEntityData

One entity in a scene file, and everything under it.

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

Remarks

⚠ Children are nested rather than each naming a parent, and that is a decision about diffs. A flat list with parent ids is simpler to stream and it makes moving a subtree an edit to n lines scattered through the file; nesting makes it one moved block. A scene is a file people merge by hand often enough that the readable form wins, which is the same reason the whole authoring format is YAML rather than the binary the runtime eventually loads.

The transform is the local one, because that is the authored value — a world matrix is derived every frame from the hierarchy and storing it would be storing something the next transform pass overwrites.

Fields and properties (18)

  • public EntityId Id

    What names this entity, in this file and in every reference to it.

  • public string Name

    What it is called.

  • public Vector3 Position

    Where it is, relative to its parent.

  • public Quaternion Rotation

    How it is turned, relative to its parent.

  • public Vector3 Scale

    How big it is, relative to its parent.

  • public string Shape

    How a scene used to carry a shape. Read, and never written.

  • public SceneLightData? Light

    How a scene used to carry a light. Read, and never written.

  • public string Asset

    The asset this entity is an instance of, in vx: form, or empty for none.

  • public string Prefab

    Which prefab this entity came from, in vx: form, or empty for none.

  • public EntityId Source

    Which entity inside that prefab this one was stamped from.

  • public List<string> Overrides

    Which of this entity's members are the instance's own rather than the template's.

  • public List<EntityId> Removed

    Which of the template's entities the author deleted from this instance.

  • public SceneMeshData? Mesh

    The editable geometry this entity carries, or for none.

  • public SceneShapeData? Parameters

    The live parameters its geometry is generated from, or .

  • public string Boolean

    Which boolean this entity's geometry is derived from its children by, or empty.

  • public List<SceneFaceMaterialData> Materials

    A material per face group, for the groups that name one.

  • public List<SceneEntityData> Children

    What hangs from it, in order.

  • public List<object> Components

    What it carries besides its transform, each tagged with what it is.

Methods (1)

  • public override string ToString()

    Renders it as its name.

Used by (20)

  • BehaviorsRunnerVixen.Cli
  • BlockoutBooleanTestsVixen.Editor.Blockout.Tests
  • BlockoutCreateTestsVixen.Editor.Blockout.Tests
  • EditMeshSceneTestsVixen.Editor.SceneView.Tests
  • EntityGizmoTargetVixen.Editor.SceneView
  • LightTestsVixen.Editor.SceneView.Tests
  • PrefabVixen.Editor.AssetEditors
  • PrefabInspectorTestsVixen.Editor.AssetEditors.Tests
  • PrefabInstanceTestsVixen.Editor.AssetEditors.Tests
  • PrefabOverrideTestsVixen.Editor.Core.Tests
  • PrefabOverridesVixen.Editor.Core
  • PrefabPlacementTestsVixen.Editor.AssetEditors.Tests
  • PrefabReconcileVixen.Editor.Core
  • PrefabSerializationTestsVixen.Editor.SceneView.Tests
  • PrefabSourceVixen.Editor.AssetEditors
  • PrimitiveShapeTestsVixen.Editor.SceneView.Tests
  • SceneCompilerVixen.Editor.Assets
  • SceneFileVixen.Editor.Core
  • SceneSerializerVixen.Editor.SceneView
  • TypeRegistrationVixen.Editor.Core