Vixen
02b45cc4
csharp
public enum ShapeKind

Which shape a parametric entity is, before anybody edits it.

Read the guide page for this →

Remarks

Doc 24's Creation table, and the last five entries are the point of it. Box, cylinder, cone, sphere, capsule, torus and plane are the shapes every engine ships; Stairs, Ramp, Arch, Pipe and DoorFrame are the ones that are tedious to build by hand, which is why Unreal ships a Stairs tool and why a blockout toolset that stopped at the seven would send a designer back to extruding a staircase one step at a time.

⚠ Deliberately not PrimitiveKind, and not an extension of it. That enum is Vixen.Rendering's and says which of the built-in meshes an entity draws — it is a four-byte value a thousand entities share one upload of, and its members are a file format the runtime reads. These have parameters, produce one mesh per entity, and are the editor's: a stair with ten steps and a stair with eleven are not the same geometry, so nothing about the sharing that makes PrimitiveKind worth having applies.

Fields and properties (12)

  • Box

    A rectangular box: six four-sided faces, one group each.

  • Plane

    A flat rectangle in the ground plane, optionally divided into a grid.

  • Cylinder

    A round column with a cap at each end.

  • Cone

    A round column that comes to a point.

  • Sphere

    A ball, as rings of quads between two fans.

  • Capsule

    A cylinder with a hemisphere on each end.

  • Torus

    A ring of circular cross-section.

  • Stairs

    A flight of steps, as one closed solid rather than a pile of boxes.

  • Ramp

    A wedge: a box with one face sloped from the ground to the full height.

  • Arch

    A wall with a round-topped opening through it.

  • Pipe

    A tube with a bore down the middle and an annulus at each end.

  • DoorFrame

    A wall with a square-topped opening through it.

Used by (16)

  • MeshBooleanPropertyTestsVixen.Geometry.Tests
  • MeshBooleanTestsVixen.Geometry.Tests
  • MeshShapeTestsVixen.Geometry.Tests
  • MeshShapesVixen.Geometry
  • MeshSurfaceTestsVixen.Geometry.Tests
  • ShapeParametersVixen.Geometry
  • BlockoutBooleanTestsVixen.Editor.Blockout.Tests
  • BlockoutCreateVixen.Editor.Blockout
  • BlockoutCreateTestsVixen.Editor.Blockout.Tests
  • BlockoutCubeGridVixen.Editor.Blockout
  • BlockoutHistoryTestsVixen.Editor.Blockout.Tests
  • BlockoutModeVixen.Editor.Blockout
  • BlockoutModuleVixen.Editor.Blockout
  • BlockoutSurfaceTestsVixen.Editor.Blockout.Tests
  • EditMeshesVixen.Editor.SceneView
  • ShapeDragVixen.Editor.Blockout