Skip to content

VoxelObject Editor

Christian Cuevas edited this page Jan 12, 2021 · 6 revisions

About

The VoxelObject editor allows you to easily create and modify voxel content within Godot.

Usage (Video)

The VoxelObject editor becomes visible, in the bottom panel, after selecting a VoxelObject in the scene tree. The editor has many keyboard shortcuts and tooltip hints to help navigate, as well as built-in undo redo support. You will also notice that the VoxelObject editor is divided into three sections.

Note: You won't be able to edit voxel content until you've toggled on editing, keyboard shortcut Space.

Tool panel (leftmost)

If there is no VoxelSet attached to the selected VoxelObject, you will be prompted to either attach one or create a new one.

  • Tools, keyboard shortcut 1, operation to be committed

    • Add, add voxels
    • Sub, subtract voxels
    • Swap, swap present voxels with selected palette
    • Fill, fill selected voxels with selected palette
    • Pick, pick selected voxel for palette
  • Palette, keyboard shortcut 2, voxel with which to commit operations

  • Selection mode, keyboard shortcut 3, manner by which operations are committed

    • Individual, operations are committed individually; pressing shift will make continues stokes
    • Area, operations are committed with selected area(s)
    • Extrude, operations are committed with selected face(s); pressing shift will select similar voxel face(s)
  • Color picker, keyboard shortcut 4, quickly add voxel of color to attached VoxelSet

  • VoxelSet viewer, browse voxels in attached VoxelSet and select voxel for current palette

Edit panel (middle)

Here you will find various options and effects that will be applied to all voxels in the VoxelObject.

  • Move, move voxels by the set translation
  • Center, center voxels by the set alignment; a value of 1.0 means align with the positive of that axis
  • Flip X, Y, Z, flip voxels over axis
  • Clear, remove all voxels
  • Import, import voxels from file; supports all Reader formats

Config panel (rightmost)

Configure the VoxelObject editor to your preference, such as: cursor color, grid color, grid visibility, etc.

The VoxelObject editor is designed to be easily extended, you can quickly modify and add tools, selection modes and more; See the source code for more information.