godot_voxel/edition/voxel_tool.h

#ifndef VOXEL_TOOL_H
#define VOXEL_TOOL_H

#include "../storage/funcs.h"
#include "../util/math/box3i.h"
#include "../util/math/sdf.h"
#include "funcs.h"
#include "voxel_raycast_result.h"

class VoxelBuffer;

// TODO Need to review VoxelTool to account for transformed volumes

// High-level generic voxel edition utility.
// Ease of use comes at cost.
// It's not a class to instantiate alone, get it from the voxel objects you want to work with
class VoxelTool : public Reference {
	GDCLASS(VoxelTool, Reference)
public:
	enum Mode {
		MODE_ADD,
		MODE_REMOVE,
		MODE_SET,
		MODE_TEXTURE_PAINT
	};

	VoxelTool();

	void set_value(uint64_t val);
	uint64_t get_value() const;

	void set_channel(int channel);
	int get_channel() const;

	void set_mode(Mode mode);
	Mode get_mode() const;

	void set_eraser_value(uint64_t value);
	uint64_t get_eraser_value() const;

	uint64_t get_voxel(Vector3i pos) const;
	float get_voxel_f(Vector3i pos) const;

	float get_sdf_scale() const;
	void set_sdf_scale(float s);

	void set_texture_index(int ti);
	int get_texture_index() const;

	void set_texture_opacity(float opacity);
	float get_texture_opacity() const;

	void set_texture_falloff(float falloff);
	float get_texture_falloff() const;

	// TODO Methods working on a whole area must use an implementation that minimizes locking!

	// The following methods represent one edit each. Pick the correct one for the job.
	// For example, using `do_box` will be more efficient than calling `do_point` many times.
	virtual void set_voxel(Vector3i pos, uint64_t v);
	virtual void set_voxel_f(Vector3i pos, float v);
	virtual void do_point(Vector3i pos);
	virtual void do_line(Vector3i begin, Vector3i end);
	virtual void do_circle(Vector3i pos, int radius, Vector3i direction);
	virtual void do_sphere(Vector3 center, float radius);
	virtual void do_box(Vector3i begin, Vector3i end);

	void sdf_stamp_erase(Ref<VoxelBuffer> stamp, Vector3i pos);

	virtual void copy(Vector3i pos, Ref<VoxelBuffer> dst, uint8_t channels_mask) const;
	virtual void paste(Vector3i pos, Ref<VoxelBuffer> p_voxels, uint8_t channels_mask, bool use_mask,
			uint64_t mask_value);

	virtual Ref<VoxelRaycastResult> raycast(Vector3 pos, Vector3 dir, float max_distance, uint32_t collision_mask);

	// Checks if an edit affecting the given box can be applied, fully or partially
	virtual bool is_area_editable(const Box3i &box) const;

	virtual void set_voxel_metadata(Vector3i pos, Variant meta);
	virtual Variant get_voxel_metadata(Vector3i pos) const;

protected:
	static void _bind_methods();

	// These methods never go alone, but may be used in others.
	// They don't represent an edit, they only abstract the lower-level API
	virtual uint64_t _get_voxel(Vector3i pos) const;
	virtual float _get_voxel_f(Vector3i pos) const;
	virtual void _set_voxel(Vector3i pos, uint64_t v);
	virtual void _set_voxel_f(Vector3i pos, float v);
	virtual void _post_edit(const Box3i &box);

private:
	// Bindings to convert to more specialized C++ types and handle virtuality,
	// cuz I don't know if it works by binding straight

	uint64_t _b_get_voxel(Vector3 pos) {
		return get_voxel(Vector3i::from_floored(pos));
	}
	float _b_get_voxel_f(Vector3 pos) {
		return get_voxel_f(Vector3i::from_floored(pos));
	}
	void _b_set_voxel(Vector3 pos, uint64_t v) {
		set_voxel(Vector3i::from_floored(pos), v);
	}
	void _b_set_voxel_f(Vector3 pos, float v) {
		set_voxel_f(Vector3i::from_floored(pos), v);
	}
	Ref<VoxelRaycastResult> _b_raycast(Vector3 pos, Vector3 dir, float max_distance, uint32_t collision_mask) {
		return raycast(pos, dir, max_distance, collision_mask);
	}
	void _b_do_point(Vector3 pos) {
		do_point(Vector3i::from_floored(pos));
	}
	void _b_do_line(Vector3 begin, Vector3 end) {
		do_line(Vector3i::from_floored(begin), Vector3i::from_floored(end));
	}
	void _b_do_circle(Vector3 pos, float radius, Vector3 direction) {
		do_circle(Vector3i::from_floored(pos), radius, Vector3i::from_floored(direction));
	}
	void _b_do_sphere(Vector3 pos, float radius) {
		do_sphere(pos, radius);
	}
	void _b_do_box(Vector3 begin, Vector3 end) {
		do_box(Vector3i::from_floored(begin), Vector3i(end));
	}
	void _b_copy(Vector3 pos, Ref<Reference> voxels, int channel_mask) {
		copy(Vector3i::from_floored(pos), voxels, channel_mask);
	}
	void _b_paste(Vector3 pos, Ref<Reference> voxels, int channels_mask, int64_t mask_value) {
		// TODO May need two functions, one masked, one not masked, or add a parameter, but it breaks compat
		paste(Vector3i::from_floored(pos), voxels, channels_mask, mask_value > 0xffffffff, mask_value);
	}

	Variant _b_get_voxel_metadata(Vector3 pos) const {
		return get_voxel_metadata(Vector3i::from_floored(pos));
	}
	void _b_set_voxel_metadata(Vector3 pos, Variant meta) {
		return set_voxel_metadata(Vector3i::from_floored(pos), meta);
	}

	bool _b_is_area_editable(AABB box) const {
		return is_area_editable(Box3i(Vector3i::from_floored(box.position), Vector3i::from_floored(box.size)));
	}

protected:
	uint64_t _value = 0;
	uint64_t _eraser_value = 0; // air
	int _channel = 0;
	float _sdf_scale = 1.f;
	Mode _mode = MODE_ADD;

	struct TextureParams {
		float opacity = 1.f;
		float sharpness = 2.f;
		unsigned int index = 0;
	};

	struct TextureBlendSphereOp {
		Vector3 center;
		float radius;
		float radius_squared;
		TextureParams tp;

		TextureBlendSphereOp(Vector3 p_center, float p_radius, TextureParams p_tp) {
			center = p_center;
			radius = p_radius;
			radius_squared = p_radius * p_radius;
			tp = p_tp;
		}

		inline void operator()(Vector3i pos, uint16_t &indices, uint16_t &weights) const {
			const float distance_squared = pos.to_vec3().distance_squared_to(center);
			if (distance_squared < radius_squared) {
				const float distance_from_radius = radius - Math::sqrt(distance_squared);
				const float target_weight = tp.opacity * clamp(tp.sharpness * (distance_from_radius / radius), 0.f, 1.f);
				blend_texture_packed_u16(tp.index, target_weight, indices, weights);
			}
		}
	};

	template <typename Op, typename Shape>
	struct SdfOperation16bit {
		Op op;
		Shape shape;
		inline uint16_t operator()(Vector3i pos, uint16_t sdf) const {
			return norm_to_u16(op(u16_to_norm(sdf), shape(pos.to_vec3())));
		}
	};

	struct SdfUnion {
		inline float operator()(float a, float b) const {
			return sdf_union(a, b);
		}
	};

	struct SdfSubtract {
		inline float operator()(float a, float b) const {
			return sdf_subtract(a, b);
		}
	};

	struct SdfSet {
		inline float operator()(float a, float b) const {
			return b;
		}
	};

	struct SdfSphere {
		Vector3 center;
		float radius;
		float scale;

		inline float operator()(Vector3 pos) const {
			return scale * sdf_sphere(pos, center, radius);
		}
	};

	// Used on smooth terrain
	TextureParams _texture_params;
};

VARIANT_ENUM_CAST(VoxelTool::Mode)

#endif // VOXEL_TOOL_H