/**
Most basic 3D game object, parent of all 3D related nodes.

Copyright:
Copyright (c) 2007-2018 Juan Linietsky, Ariel Manzur.  
Copyright (c) 2014-2018 Godot Engine contributors (cf. AUTHORS.md)  
Copyright (c) 2017-2018 Godot-D contributors  

License: $(LINK2 https://opensource.org/licenses/MIT, MIT License)


*/
module godot.spatial;
import std.meta : AliasSeq, staticIndexOf;
import std.traits : Unqual;
import godot.d.meta;
import godot.core;
import godot.c;
import godot.d.bind;
import godot.d.reference;
import godot.object;
import godot.classdb;
import godot.node;
import godot.world;
import godot.spatialgizmo;
/**
Most basic 3D game object, parent of all 3D related nodes.

Most basic 3D game object, with a 3D $(D Transform) and visibility settings. All other 3D game objects inherit from Spatial. Use Spatial as a parent node to move, scale, rotate and show/hide children in a 3D project.
Affine operations (rotate, scale, translate) happen in parent's local coordinate system, unless the Spatial object is set as top level. Affine operations in this coordinate system correspond to direct affine operations on the Spatial's transform. The word local below refers to this coordinate system. The coordinate system that is attached to the Spatial object itself is referred to as object-local coordinate system.
*/
@GodotBaseClass struct Spatial
{
	enum string _GODOT_internal_name = "Spatial";
public:
@nogc nothrow:
	union { godot_object _godot_object; Node _GODOT_base; }
	alias _GODOT_base this;
	alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses);
	package(godot) __gshared bool _classBindingInitialized = false;
	package(godot) static struct _classBinding
	{
		__gshared:
		@GodotName("set_transform") GodotMethod!(void, Transform) setTransform;
		@GodotName("get_transform") GodotMethod!(Transform) getTransform;
		@GodotName("set_translation") GodotMethod!(void, Vector3) setTranslation;
		@GodotName("get_translation") GodotMethod!(Vector3) getTranslation;
		@GodotName("set_rotation") GodotMethod!(void, Vector3) setRotation;
		@GodotName("get_rotation") GodotMethod!(Vector3) getRotation;
		@GodotName("set_rotation_degrees") GodotMethod!(void, Vector3) setRotationDegrees;
		@GodotName("get_rotation_degrees") GodotMethod!(Vector3) getRotationDegrees;
		@GodotName("set_scale") GodotMethod!(void, Vector3) setScale;
		@GodotName("get_scale") GodotMethod!(Vector3) getScale;
		@GodotName("set_global_transform") GodotMethod!(void, Transform) setGlobalTransform;
		@GodotName("get_global_transform") GodotMethod!(Transform) getGlobalTransform;
		@GodotName("get_parent_spatial") GodotMethod!(Spatial) getParentSpatial;
		@GodotName("set_ignore_transform_notification") GodotMethod!(void, bool) setIgnoreTransformNotification;
		@GodotName("set_as_toplevel") GodotMethod!(void, bool) setAsToplevel;
		@GodotName("is_set_as_toplevel") GodotMethod!(bool) isSetAsToplevel;
		@GodotName("set_disable_scale") GodotMethod!(void, bool) setDisableScale;
		@GodotName("is_scale_disabled") GodotMethod!(bool) isScaleDisabled;
		@GodotName("get_world") GodotMethod!(World) getWorld;
		@GodotName("force_update_transform") GodotMethod!(void) forceUpdateTransform;
		@GodotName("_update_gizmo") GodotMethod!(void) _updateGizmo;
		@GodotName("update_gizmo") GodotMethod!(void) updateGizmo;
		@GodotName("set_gizmo") GodotMethod!(void, SpatialGizmo) setGizmo;
		@GodotName("get_gizmo") GodotMethod!(SpatialGizmo) getGizmo;
		@GodotName("set_visible") GodotMethod!(void, bool) setVisible;
		@GodotName("is_visible") GodotMethod!(bool) isVisible;
		@GodotName("is_visible_in_tree") GodotMethod!(bool) isVisibleInTree;
		@GodotName("show") GodotMethod!(void) show;
		@GodotName("hide") GodotMethod!(void) hide;
		@GodotName("set_notify_local_transform") GodotMethod!(void, bool) setNotifyLocalTransform;
		@GodotName("is_local_transform_notification_enabled") GodotMethod!(bool) isLocalTransformNotificationEnabled;
		@GodotName("set_notify_transform") GodotMethod!(void, bool) setNotifyTransform;
		@GodotName("is_transform_notification_enabled") GodotMethod!(bool) isTransformNotificationEnabled;
		@GodotName("rotate") GodotMethod!(void, Vector3, double) rotate;
		@GodotName("global_rotate") GodotMethod!(void, Vector3, double) globalRotate;
		@GodotName("global_scale") GodotMethod!(void, Vector3) globalScale;
		@GodotName("global_translate") GodotMethod!(void, Vector3) globalTranslate;
		@GodotName("rotate_object_local") GodotMethod!(void, Vector3, double) rotateObjectLocal;
		@GodotName("scale_object_local") GodotMethod!(void, Vector3) scaleObjectLocal;
		@GodotName("translate_object_local") GodotMethod!(void, Vector3) translateObjectLocal;
		@GodotName("rotate_x") GodotMethod!(void, double) rotateX;
		@GodotName("rotate_y") GodotMethod!(void, double) rotateY;
		@GodotName("rotate_z") GodotMethod!(void, double) rotateZ;
		@GodotName("translate") GodotMethod!(void, Vector3) translate;
		@GodotName("orthonormalize") GodotMethod!(void) orthonormalize;
		@GodotName("set_identity") GodotMethod!(void) setIdentity;
		@GodotName("look_at") GodotMethod!(void, Vector3, Vector3) lookAt;
		@GodotName("look_at_from_position") GodotMethod!(void, Vector3, Vector3, Vector3) lookAtFromPosition;
		@GodotName("to_local") GodotMethod!(Vector3, Vector3) toLocal;
		@GodotName("to_global") GodotMethod!(Vector3, Vector3) toGlobal;
	}
	bool opEquals(in Spatial other) const { return _godot_object.ptr is other._godot_object.ptr; }
	Spatial opAssign(T : typeof(null))(T n) { _godot_object.ptr = null; }
	bool opEquals(typeof(null) n) const { return _godot_object.ptr is null; }
	mixin baseCasts;
	static Spatial _new()
	{
		static godot_class_constructor constructor;
		if(constructor is null) constructor = _godot_api.godot_get_class_constructor("Spatial");
		if(constructor is null) return typeof(this).init;
		return cast(Spatial)(constructor());
	}
	@disable new(size_t s);
	/// 
	enum Constants : int
	{
		/**
		Spatial nodes receives this notification when their global transform changes. This means that either the current or a parent node changed its transform.
		In order for NOTIFICATION_TRANSFORM_CHANGED to work user first needs to ask for it, with set_notify_transform(true).
		*/
		notificationTransformChanged = 29,
		/**
		Spatial nodes receives this notification when they are registered to new $(D World) resource.
		*/
		notificationEnterWorld = 41,
		/**
		Spatial nodes receives this notification when they are unregistered from current $(D World) resource.
		*/
		notificationExitWorld = 42,
		/**
		Spatial nodes receives this notification when their visibility changes.
		*/
		notificationVisibilityChanged = 43,
	}
	/**
	
	*/
	void setTransform(in Transform local)
	{
		checkClassBinding!(typeof(this))();
		ptrcall!(void)(_classBinding.setTransform, _godot_object, local);
	}
	/**
	
	*/
	Transform getTransform() const
	{
		checkClassBinding!(typeof(this))();
		return ptrcall!(Transform)(_classBinding.getTransform, _godot_object);
	}
	/**
	
	*/
	void setTranslation(in Vector3 translation)
	{
		checkClassBinding!(typeof(this))();
		ptrcall!(void)(_classBinding.setTranslation, _godot_object, translation);
	}
	/**
	
	*/
	Vector3 getTranslation() const
	{
		checkClassBinding!(typeof(this))();
		return ptrcall!(Vector3)(_classBinding.getTranslation, _godot_object);
	}
	/**
	
	*/
	void setRotation(in Vector3 euler)
	{
		checkClassBinding!(typeof(this))();
		ptrcall!(void)(_classBinding.setRotation, _godot_object, euler);
	}
	/**
	
	*/
	Vector3 getRotation() const
	{
		checkClassBinding!(typeof(this))();
		return ptrcall!(Vector3)(_classBinding.getRotation, _godot_object);
	}
	/**
	
	*/
	void setRotationDegrees(in Vector3 euler_degrees)
	{
		checkClassBinding!(typeof(this))();
		ptrcall!(void)(_classBinding.setRotationDegrees, _godot_object, euler_degrees);
	}
	/**
	
	*/
	Vector3 getRotationDegrees() const
	{
		checkClassBinding!(typeof(this))();
		return ptrcall!(Vector3)(_classBinding.getRotationDegrees, _godot_object);
	}
	/**
	
	*/
	void setScale(in Vector3 scale)
	{
		checkClassBinding!(typeof(this))();
		ptrcall!(void)(_classBinding.setScale, _godot_object, scale);
	}
	/**
	
	*/
	Vector3 getScale() const
	{
		checkClassBinding!(typeof(this))();
		return ptrcall!(Vector3)(_classBinding.getScale, _godot_object);
	}
	/**
	
	*/
	void setGlobalTransform(in Transform global)
	{
		checkClassBinding!(typeof(this))();
		ptrcall!(void)(_classBinding.setGlobalTransform, _godot_object, global);
	}
	/**
	
	*/
	Transform getGlobalTransform() const
	{
		checkClassBinding!(typeof(this))();
		return ptrcall!(Transform)(_classBinding.getGlobalTransform, _godot_object);
	}
	/**
	Returns the parent `Spatial`, or an empty $(D GodotObject) if no parent exists or parent is not of type `Spatial`.
	*/
	Spatial getParentSpatial() const
	{
		checkClassBinding!(typeof(this))();
		return ptrcall!(Spatial)(_classBinding.getParentSpatial, _godot_object);
	}
	/**
	Set whether the node ignores notification that its transformation (global or local) changed.
	*/
	void setIgnoreTransformNotification(in bool enabled)
	{
		checkClassBinding!(typeof(this))();
		ptrcall!(void)(_classBinding.setIgnoreTransformNotification, _godot_object, enabled);
	}
	/**
	Makes the node ignore its parents transformations. Node transformations are only in global space.
	*/
	void setAsToplevel(in bool enable)
	{
		checkClassBinding!(typeof(this))();
		ptrcall!(void)(_classBinding.setAsToplevel, _godot_object, enable);
	}
	/**
	Returns whether this node is set as Toplevel, that is whether it ignores its parent nodes transformations.
	*/
	bool isSetAsToplevel() const
	{
		checkClassBinding!(typeof(this))();
		return ptrcall!(bool)(_classBinding.isSetAsToplevel, _godot_object);
	}
	/**
	
	*/
	void setDisableScale(in bool disable)
	{
		checkClassBinding!(typeof(this))();
		ptrcall!(void)(_classBinding.setDisableScale, _godot_object, disable);
	}
	/**
	
	*/
	bool isScaleDisabled() const
	{
		checkClassBinding!(typeof(this))();
		return ptrcall!(bool)(_classBinding.isScaleDisabled, _godot_object);
	}
	/**
	Returns the current $(D World) resource this Spatial node is registered to.
	*/
	Ref!World getWorld() const
	{
		checkClassBinding!(typeof(this))();
		return ptrcall!(World)(_classBinding.getWorld, _godot_object);
	}
	/**
	
	*/
	void forceUpdateTransform()
	{
		checkClassBinding!(typeof(this))();
		ptrcall!(void)(_classBinding.forceUpdateTransform, _godot_object);
	}
	/**
	
	*/
	void _updateGizmo()
	{
		Array _GODOT_args = Array.empty_array;
		String _GODOT_method_name = String("_update_gizmo");
		this.callv(_GODOT_method_name, _GODOT_args);
	}
	/**
	Updates the $(D SpatialGizmo) of this node.
	*/
	void updateGizmo()
	{
		checkClassBinding!(typeof(this))();
		ptrcall!(void)(_classBinding.updateGizmo, _godot_object);
	}
	/**
	
	*/
	void setGizmo(SpatialGizmo gizmo)
	{
		checkClassBinding!(typeof(this))();
		ptrcall!(void)(_classBinding.setGizmo, _godot_object, gizmo);
	}
	/**
	
	*/
	Ref!SpatialGizmo getGizmo() const
	{
		checkClassBinding!(typeof(this))();
		return ptrcall!(SpatialGizmo)(_classBinding.getGizmo, _godot_object);
	}
	/**
	
	*/
	void setVisible(in bool visible)
	{
		checkClassBinding!(typeof(this))();
		ptrcall!(void)(_classBinding.setVisible, _godot_object, visible);
	}
	/**
	
	*/
	bool isVisible() const
	{
		checkClassBinding!(typeof(this))();
		return ptrcall!(bool)(_classBinding.isVisible, _godot_object);
	}
	/**
	Returns whether the node is visible, taking into consideration that its parents visibility.
	*/
	bool isVisibleInTree() const
	{
		checkClassBinding!(typeof(this))();
		return ptrcall!(bool)(_classBinding.isVisibleInTree, _godot_object);
	}
	/**
	Enables rendering of this node. Change Spatial Visible property to "True".
	*/
	void show()
	{
		checkClassBinding!(typeof(this))();
		ptrcall!(void)(_classBinding.show, _godot_object);
	}
	/**
	Disables rendering of this node. Change Spatial Visible property to false.
	*/
	void hide()
	{
		checkClassBinding!(typeof(this))();
		ptrcall!(void)(_classBinding.hide, _godot_object);
	}
	/**
	Set whether the node notifies about its local transformation changes. Spatial will not propagate this by default.
	*/
	void setNotifyLocalTransform(in bool enable)
	{
		checkClassBinding!(typeof(this))();
		ptrcall!(void)(_classBinding.setNotifyLocalTransform, _godot_object, enable);
	}
	/**
	Returns whether node notifies about its local transformation changes. Spatial will not propagate this by default.
	*/
	bool isLocalTransformNotificationEnabled() const
	{
		checkClassBinding!(typeof(this))();
		return ptrcall!(bool)(_classBinding.isLocalTransformNotificationEnabled, _godot_object);
	}
	/**
	Set whether the node notifies about its global and local transformation changes. Spatial will not propagate this by default.
	*/
	void setNotifyTransform(in bool enable)
	{
		checkClassBinding!(typeof(this))();
		ptrcall!(void)(_classBinding.setNotifyTransform, _godot_object, enable);
	}
	/**
	Returns whether the node notifies about its global and local transformation changes. Spatial will not propagate this by default.
	*/
	bool isTransformNotificationEnabled() const
	{
		checkClassBinding!(typeof(this))();
		return ptrcall!(bool)(_classBinding.isTransformNotificationEnabled, _godot_object);
	}
	/**
	Rotates the local transformation around axis, a unit $(D Vector3), by specified angle in radians.
	*/
	void rotate(in Vector3 axis, in double angle)
	{
		checkClassBinding!(typeof(this))();
		ptrcall!(void)(_classBinding.rotate, _godot_object, axis, angle);
	}
	/**
	Rotates the global (world) transformation around axis, a unit $(D Vector3), by specified angle in radians. The rotation axis is in global coordinate system.
	*/
	void globalRotate(in Vector3 axis, in double angle)
	{
		checkClassBinding!(typeof(this))();
		ptrcall!(void)(_classBinding.globalRotate, _godot_object, axis, angle);
	}
	/**
	
	*/
	void globalScale(in Vector3 scale)
	{
		checkClassBinding!(typeof(this))();
		ptrcall!(void)(_classBinding.globalScale, _godot_object, scale);
	}
	/**
	Moves the global (world) transformation by $(D Vector3) offset. The offset is in global coordinate system.
	*/
	void globalTranslate(in Vector3 offset)
	{
		checkClassBinding!(typeof(this))();
		ptrcall!(void)(_classBinding.globalTranslate, _godot_object, offset);
	}
	/**
	Rotates the local transformation around axis, a unit $(D Vector3), by specified angle in radians. The rotation axis is in object-local coordinate system.
	*/
	void rotateObjectLocal(in Vector3 axis, in double angle)
	{
		checkClassBinding!(typeof(this))();
		ptrcall!(void)(_classBinding.rotateObjectLocal, _godot_object, axis, angle);
	}
	/**
	Scales the local transformation by given 3D scale factors in object-local coordinate system.
	*/
	void scaleObjectLocal(in Vector3 scale)
	{
		checkClassBinding!(typeof(this))();
		ptrcall!(void)(_classBinding.scaleObjectLocal, _godot_object, scale);
	}
	/**
	
	*/
	void translateObjectLocal(in Vector3 offset)
	{
		checkClassBinding!(typeof(this))();
		ptrcall!(void)(_classBinding.translateObjectLocal, _godot_object, offset);
	}
	/**
	Rotates the local transformation around the X axis by angle in radians
	*/
	void rotateX(in double angle)
	{
		checkClassBinding!(typeof(this))();
		ptrcall!(void)(_classBinding.rotateX, _godot_object, angle);
	}
	/**
	Rotates the local transformation around the Y axis by angle in radians.
	*/
	void rotateY(in double angle)
	{
		checkClassBinding!(typeof(this))();
		ptrcall!(void)(_classBinding.rotateY, _godot_object, angle);
	}
	/**
	Rotates the local transformation around the Z axis by angle in radians.
	*/
	void rotateZ(in double angle)
	{
		checkClassBinding!(typeof(this))();
		ptrcall!(void)(_classBinding.rotateZ, _godot_object, angle);
	}
	/**
	Changes the node's position by given offset $(D Vector3).
	*/
	void translate(in Vector3 offset)
	{
		checkClassBinding!(typeof(this))();
		ptrcall!(void)(_classBinding.translate, _godot_object, offset);
	}
	/**
	Resets this node's transformations (like scale, skew and taper) preserving its rotation and translation by performing Gram-Schmidt orthonormalization on this node's $(D Transform3D).
	*/
	void orthonormalize()
	{
		checkClassBinding!(typeof(this))();
		ptrcall!(void)(_classBinding.orthonormalize, _godot_object);
	}
	/**
	Reset all transformations for this node. Set its $(D Transform3D) to identity matrix.
	*/
	void setIdentity()
	{
		checkClassBinding!(typeof(this))();
		ptrcall!(void)(_classBinding.setIdentity, _godot_object);
	}
	/**
	Rotates itself so that the local -Z axis points towards the `target` position.
	The transform will first be rotated around the given `up` vector, and then fully aligned to the target by a further rotation around an axis perpendicular to both the `target` and `up` vectors.
	Operations take place in global space.
	*/
	void lookAt(in Vector3 target, in Vector3 up)
	{
		checkClassBinding!(typeof(this))();
		ptrcall!(void)(_classBinding.lookAt, _godot_object, target, up);
	}
	/**
	Moves the node to the specified `position`, and then rotates itself to point toward the `target` as per $(D lookAt). Operations take place in global space.
	*/
	void lookAtFromPosition(in Vector3 position, in Vector3 target, in Vector3 up)
	{
		checkClassBinding!(typeof(this))();
		ptrcall!(void)(_classBinding.lookAtFromPosition, _godot_object, position, target, up);
	}
	/**
	Transforms $(D Vector3) "global_point" from world space to this node's local space.
	*/
	Vector3 toLocal(in Vector3 global_point) const
	{
		checkClassBinding!(typeof(this))();
		return ptrcall!(Vector3)(_classBinding.toLocal, _godot_object, global_point);
	}
	/**
	Transforms $(D Vector3) "local_point" from this node's local space to world space.
	*/
	Vector3 toGlobal(in Vector3 local_point) const
	{
		checkClassBinding!(typeof(this))();
		return ptrcall!(Vector3)(_classBinding.toGlobal, _godot_object, local_point);
	}
	/**
	World space (global) $(D Transform) of this node.
	*/
	@property Transform globalTransform()
	{
		return getGlobalTransform();
	}
	/// ditto
	@property void globalTransform(Transform v)
	{
		setGlobalTransform(v);
	}
	/**
	Local translation of this node.
	*/
	@property Vector3 translation()
	{
		return getTranslation();
	}
	/// ditto
	@property void translation(Vector3 v)
	{
		setTranslation(v);
	}
	/**
	Rotation part of the local transformation in degrees, specified in terms of YXZ-Euler angles in the format (X-angle, Y-angle, Z-angle).
	*/
	@property Vector3 rotationDegrees()
	{
		return getRotationDegrees();
	}
	/// ditto
	@property void rotationDegrees(Vector3 v)
	{
		setRotationDegrees(v);
	}
	/**
	Rotation part of the local transformation in radians, specified in terms of YXZ-Euler angles in the format (X-angle, Y-angle, Z-angle).
	Note that in the mathematical sense, rotation is a matrix and not a vector. The three Euler angles, which are the three independent parameters of the Euler-angle parametrization of the rotation matrix, are stored in a $(D Vector3) data structure not because the rotation is a vector, but only because $(D Vector3) exists as a convenient data-structure to store 3 floating point numbers. Therefore, applying affine operations on the rotation "vector" is not meaningful.
	*/
	@property Vector3 rotation()
	{
		return getRotation();
	}
	/// ditto
	@property void rotation(Vector3 v)
	{
		setRotation(v);
	}
	/**
	Scale part of the local transformation.
	*/
	@property Vector3 scale()
	{
		return getScale();
	}
	/// ditto
	@property void scale(Vector3 v)
	{
		setScale(v);
	}
	/**
	Local space $(D Transform) of this node, with respect to the parent node.
	*/
	@property Transform transform()
	{
		return getTransform();
	}
	/// ditto
	@property void transform(Transform v)
	{
		setTransform(v);
	}
	/**
	If `true` this node is drawn. Default value: `true`.
	*/
	@property bool visible()
	{
		return isVisible();
	}
	/// ditto
	@property void visible(bool v)
	{
		setVisible(v);
	}
	/**
	The SpatialGizmo for this node. Used for example in $(D EditorSpatialGizmo) as custom visualization and editing handles in Editor.
	*/
	@property SpatialGizmo gizmo()
	{
		return getGizmo();
	}
	/// ditto
	@property void gizmo(SpatialGizmo v)
	{
		setGizmo(v);
	}
}