Merge branch 'master' of https://github.com/20tab/UnrealEnginePython

Author: Roberto De Ioris

README.md

@@ -24,7 +24,7 @@ Once the plugin is installed and enabled, you get access to the 'PythonConsole'
 
 All of the exposed engine features are under the 'unreal_engine' virtual module (it is completely coded in c into the plugin, so do not expect to run 'import unreal_engine' from a standard python shell)
 
-The currently supported Unreal Engine versions are 4.12, 4.13, 4.14, 4.15, 4.16, 4.17 and 4.18.
+The currently supported Unreal Engine versions are 4.12, 4.13, 4.14, 4.15, 4.16, 4.17, 4.18 and 4.19
 
 We support official python.org releases as well as IntelPython and Anaconda distributions.
 
@@ -487,6 +487,30 @@ To access the fields of a struct just call the fields() method.
 
 A good example of struct usage is available here: https://github.com/20tab/UnrealEnginePython/blob/master/docs/Settings.md
 
+As structs are passed by value, you need to pay attention when manipulating structs fields that are structs by themselves:
+
+```python
+from unreal_engine.structs import TerrificStruct, DumbStruct
+
+ts = TerrificStruct()
+ts.dumb = DumbStruct(Foo=17, Bar=22)
+
+# will not modify the original DumbStruct but a copy of it !!!
+ts.dumb.Foo = 22
+```
+
+You can eventually force structs to be passed by ref (extremely dangerous as the internal C pointer could be a dangling one) using the ref() function:
+
+```python
+from unreal_engine.structs import TerrificStruct, DumbStruct
+
+ts = TerrificStruct()
+ts.dumb = DumbStruct(Foo=17, Bar=22)
+
+# ref() will return a pointer to a struct
+ts.ref().dumb.foo().Foo = 22
+```
+
 The ue_site.py file
 -------------------
 
@@ -808,15 +832,9 @@ Memory management
 
 Dealing with 2 different GC's is really challenging.
 
-PyActor, PyPawn and PythonComponent automatically DECREF's the mapped classes. This should be enough unless you hold references
-in the python modules themselves. As this would be a bad programming practice, the current approach should be safe enough.
-
-In addition to this, every time a uobject has to return its UObject mapping, it checks for its validity and safety:
+Starting from release 20180226 a new memory management system has been added (FUnrealEnginePythonHouseKeeper, available here https://github.com/20tab/UnrealEnginePython/blob/master/Source/UnrealEnginePython/Public/PythonHouseKeeper.h). This new system is completely integrated with the Unreal Engine reflection-based GC and will hold track of each ue_PyUObject abd the related UObject to understand when a python object can be safely destroyed.
 
-```c
-#define ue_py_check(py_u) if (!py_u->ue_object || !py_u->ue_object->IsValidLowLevel() || py_u->ue_object->IsPendingKillOrUnreachable())\
-							return PyErr_Format(PyExc_Exception, "PyUObject is in invalid state")
-```
+The same system works for delegates, as well as Slate.
 
 
 Unit Testing

Source/UnrealEnginePython/Private/Fbx/UEPyFbxObject.cpp

@@ -138,6 +138,108 @@ static PyObject *py_ue_fbx_object_key_get_seconds(ue_PyFbxObject *self, PyObject
 	return PyFloat_FromDouble(fbx_anim_curve->KeyGetTime(index).GetSecondDouble());
 }
 
+static PyObject *py_ue_fbx_object_key_get_left_tangent(ue_PyFbxObject *self, PyObject *args) {
+	int index;
+	if (!PyArg_ParseTuple(args, "i", &index)) {
+		return nullptr;
+	}
+	FbxAnimCurve *fbx_anim_curve = FbxCast<FbxAnimCurve>(self->fbx_object);
+	if (!fbx_anim_curve)
+		return PyErr_Format(PyExc_Exception, "object is not a FbxAnimCurve");
+	return PyFloat_FromDouble(fbx_anim_curve->KeyGetLeftDerivative(index));
+}
+
+static PyObject *py_ue_fbx_object_key_get_right_tangent(ue_PyFbxObject *self, PyObject *args) {
+	int index;
+	if (!PyArg_ParseTuple(args, "i", &index)) {
+		return nullptr;
+	}
+	FbxAnimCurve *fbx_anim_curve = FbxCast<FbxAnimCurve>(self->fbx_object);
+	if (!fbx_anim_curve)
+		return PyErr_Format(PyExc_Exception, "object is not a FbxAnimCurve");
+	return PyFloat_FromDouble(fbx_anim_curve->KeyGetRightDerivative(index));
+}
+
+static PyObject *py_ue_fbx_object_key_get_interp_mode(ue_PyFbxObject *self, PyObject *args) {
+	int index;
+	if (!PyArg_ParseTuple(args, "i", &index)) {
+		return nullptr;
+	}
+	FbxAnimCurve *fbx_anim_curve = FbxCast<FbxAnimCurve>(self->fbx_object);
+	if (!fbx_anim_curve)
+		return PyErr_Format(PyExc_Exception, "object is not a FbxAnimCurve");
+
+	ERichCurveInterpMode Mode = RCIM_Linear;
+	// Convert the interpolation type from FBX to Unreal.
+	switch (fbx_anim_curve->KeyGetInterpolation(index))
+	{
+	case FbxAnimCurveDef::eInterpolationCubic:
+		Mode = RCIM_Cubic;
+		break;
+
+	case FbxAnimCurveDef::eInterpolationConstant:
+		if (fbx_anim_curve->KeyGetTangentMode(index) != (FbxAnimCurveDef::ETangentMode)FbxAnimCurveDef::eConstantStandard)
+		{
+			// warning not support
+			;
+		}
+		Mode = RCIM_Constant;
+		break;
+
+	case FbxAnimCurveDef::eInterpolationLinear:
+		Mode = RCIM_Linear;
+		break;
+	}
+
+	return PyLong_FromUnsignedLong(uint64(Mode));
+}
+
+static PyObject *py_ue_fbx_object_key_get_tangent_mode(ue_PyFbxObject *self, PyObject *args) {
+	int index;
+	if (!PyArg_ParseTuple(args, "i", &index)) {
+		return nullptr;
+	}
+	FbxAnimCurve *fbx_anim_curve = FbxCast<FbxAnimCurve>(self->fbx_object);
+	if (!fbx_anim_curve)
+		return PyErr_Format(PyExc_Exception, "object is not a FbxAnimCurve");
+
+	ERichCurveTangentMode Mode = RCTM_Auto;
+	// Convert the interpolation type from FBX to Unreal.
+	if ( fbx_anim_curve->KeyGetInterpolation(index) == 
+		FbxAnimCurveDef::eInterpolationCubic )
+	{
+		switch (fbx_anim_curve->KeyGetTangentMode(index))
+		{
+			// Auto tangents will now be imported as user tangents to allow the
+			// user to modify them without inadvertently resetting other tangents
+			// 				case KFbxAnimCurveDef::eTANGENT_AUTO:
+			// 					if ((KFbxAnimCurveDef::eTANGENT_GENERIC_CLAMP & FbxKey.GetTangentMode(true)))
+			// 					{
+			// 						Mode = CIM_CurveAutoClamped;
+			// 					}
+			// 					else
+			// 					{
+			// 						Mode = CIM_CurveAuto;
+			// 					}
+			// 					break;
+		case FbxAnimCurveDef::eTangentBreak:
+			Mode = RCTM_Break;
+			break;
+		case FbxAnimCurveDef::eTangentAuto:
+			Mode = RCTM_Auto;
+			break;
+		case FbxAnimCurveDef::eTangentUser:
+		case FbxAnimCurveDef::eTangentTCB:
+			Mode = RCTM_User;
+			break;
+		default:
+			break;
+		}
+	}
+
+	return PyLong_FromUnsignedLong(uint64(Mode));
+}
+
 static PyMethodDef ue_PyFbxObject_methods[] = {
 	{ "get_member_count", (PyCFunction)py_ue_fbx_object_get_member_count, METH_VARARGS, "" },
 	{ "get_member", (PyCFunction)py_ue_fbx_object_get_member, METH_VARARGS, "" },
@@ -153,6 +255,10 @@ static PyMethodDef ue_PyFbxObject_methods[] = {
 	{ "key_get_count", (PyCFunction)py_ue_fbx_object_key_get_count, METH_VARARGS, "" },
 	{ "key_get_value", (PyCFunction)py_ue_fbx_object_key_get_value, METH_VARARGS, "" },
 	{ "key_get_seconds", (PyCFunction)py_ue_fbx_object_key_get_seconds, METH_VARARGS, "" },
+	{ "key_get_left_tangent", (PyCFunction)py_ue_fbx_object_key_get_left_tangent, METH_VARARGS, "" },
+	{ "key_get_right_tangent", (PyCFunction)py_ue_fbx_object_key_get_right_tangent, METH_VARARGS, "" },
+	{ "key_get_interp_mode", (PyCFunction)py_ue_fbx_object_key_get_interp_mode, METH_VARARGS, "" },
+	{ "key_get_tangent_mode", (PyCFunction)py_ue_fbx_object_key_get_tangent_mode, METH_VARARGS, "" },
 	{ NULL }  /* Sentinel */
 };