Improvements to EditorRigblock, EditorModel, cEditorResource, EditorBaseHandle, TuningSpine.

Author: emd4600

Spore ModAPI/SourceCode/DLL/AddressesEditors.cpp

@@ -7,6 +7,7 @@
 #include <Spore\Editors\EditorCamera.h>
 #include <Spore\Editors\EditorRequest.h>
 #include <Spore\Editors\EditorUI.h>
+#include <Spore\Editors\TuningSpine.h>
 #include <Spore\Editors\PlayModeAnimations.h>
 #include <Spore\Editors\SpeciesManager.h>
 #include <Spore\Editors\CreatureWalkController.h>
@@ -20,6 +21,11 @@ namespace Editors
 		DefineAddress(Get, SelectAddress(0x401010, 0x401010, 0x401010));
 	}
 
+	namespace Addresses(cTuningSpine)
+	{
+		DefineAddress(Get, SelectAddress(0x401070, , 0x401070));
+	}
+
 	namespace Addresses(ContentValidation) {
 		DefineAddress(IllegalCharacters_ptr, SelectAddress(0x15DEA54, , 0x15DA7C4));
 		DefineAddress(ValidationEditableTests_ptr, SelectAddress(0x15DEA04, , 0x15DA7D4));
@@ -41,6 +47,11 @@ namespace Editors
 		DefineAddress(OnMouseMove, SelectAddress(0x5736C0, , 0x5737D0));
 		DefineAddress(OnMouseWheel, SelectAddress(0x5859E0, , 0x585D10));
 		DefineAddress(Update, SelectAddress(0x58BB20, , 0x58BE50));
+
+		DefineAddress(SetEditorModel, SelectAddress(0x5867D0, , 0x586B00));
+		DefineAddress(CommitEditHistory, SelectAddress(0x5860E0, , 0x586410));
+		DefineAddress(Undo, SelectAddress(0x58A270, , 0x58A5A0));
+		DefineAddress(Redo, SelectAddress(0x58A620, , 0x58A950));
 	}
 
 	namespace Addresses(EditorCamera)
@@ -99,8 +110,13 @@ namespace Editors
 
 	namespace Addresses(EditorModel)
 	{
+		DefineAddress(SetName, SelectAddress(0x4ADC20, , 0x4AE280));
+		DefineAddress(SetDescription, SelectAddress(0x4ADDE0, , 0x4AE440));
 		DefineAddress(GetCreationName, SelectAddress(0x4ADEA0, 0x4AE520, 0x4AE520));
 		DefineAddress(SetColor, SelectAddress(0x4ADBF0, 0x4AE250, 0x4AE250));
+		DefineAddress(Load, SelectAddress(0x4AE240, , 0x4AE8D0));
+		DefineAddress(Save, SelectAddress(0x4AF0F0, , 0x4AF780));
+		DefineAddress(Dispose, SelectAddress(0x4AD1F0, , 0x4AD850));
 	}
 
 	namespace Addresses(CreatureWalkController)

Spore ModAPI/SourceCode/Editors/Editor.cpp

@@ -1,13 +1,24 @@
 #ifndef MODAPI_DLL_EXPORT
 #include <Spore\Editors\Editor.h>
 #include <Spore\Editors\EditorModel.h>
+#include <Spore\Editors\TuningSpine.h>
 
 namespace Editors
 {
 	auto_METHOD(cEditor, bool, sub_581F70, Args(EditorRigblock* part, void* activeHandle, int value), Args(part, activeHandle, value));
 
+	auto_METHOD_VOID(cEditor, SetEditorModel, Args(EditorModel* pEditorModel), Args(pEditorModel));
+	auto_METHOD_VOID(cEditor, CommitEditHistory, Args(bool p, EditorStateEditHistory* pStateHistory), Args(p, pStateHistory));
+	auto_METHOD_VOID(cEditor, Undo, Args(bool a, bool b), Args(a, b));
+	auto_METHOD_VOID_(cEditor, Redo);
+
+	auto_METHOD_VOID_(EditorModel, Dispose);
 	auto_METHOD_const_(EditorModel, string16&, GetCreationName);
 	auto_METHOD_VOID(EditorModel, SetColor, Args(int index, struct ColorRGB color), Args(index, color));
+	auto_METHOD_VOID(EditorModel, Load, Args(cEditorResource* pResource), Args(pResource));
+	auto_METHOD_VOID(EditorModel, Save, Args(cEditorResource* pResource), Args(pResource));
+
+	auto_STATIC_METHOD_(cTuningSpine, cTuningSpine*, Get);
 
 
 	int IEditorLimits::AddRef() {
@@ -24,5 +35,64 @@ namespace Editors
 		return mnRefCount;
 	}
 
+
+	auto_METHOD_VIRTUAL_VOID(EditorModel, INameableEntity, SetName, Args(const char16_t* pString), Args(pString));
+	auto_METHOD_VIRTUAL_VOID(EditorModel, INameableEntity, SetDescription, Args(const char16_t* pString), Args(pString));
+
+	const char16_t* EditorModel::GetName() {
+		return mName.c_str();
+	}
+
+	const char16_t* EditorModel::GetDescription() {
+		return mDescription.c_str();
+	}
+
+	void EditorModel::SetTags(const char16_t* pString) {}
+	const char16_t* EditorModel::GetTags() { return nullptr; }
+
+	EditorModel::EditorModel()
+		: mnRefCount(0)
+		, mKey()
+		, mParts()
+		, field_2C()
+		, field_30()
+		, field_34()
+		, field_38()
+		, field_3C()
+		, field_40(-2.0f)
+		, field_44(2.0f)
+		, field_48()
+		, field_4C()
+		, field_4D()
+		, field_4E(true)
+		, field_4F()
+		, field_50()
+		, field_51()
+		, mTranslationOptions()
+		, mModelType()
+		, mName()
+		, mDescription()
+		, mAcceptedName()
+		, mSkinEffectIDs()
+		, mSkinEffectSeeds{1234, 1234, 1234}
+		, mColors {ColorRGB(1.0f, 1.0f, 1.0f), ColorRGB(1.0f, 1.0f, 1.0f), ColorRGB(1.0f, 1.0f, 1.0f)}
+		, field_C8()
+	{
+	}
+
+	EditorModel::~EditorModel()
+	{
+		Dispose();
+
+		// field_30 is a pointer, but I don't know what kind so we manually Release it
+		if (field_30 != 0) {
+			int* pointer = (int*)field_30;
+			pointer[1]--;
+			if (pointer[1] == 0) {
+				pointer[1] = 1;
+				delete ((IVirtual*)pointer);
+			}
+		}
+	}
 }
 #endif

Spore ModAPI/Spore ModAPI.vcxproj

@@ -318,6 +318,7 @@
     <ClInclude Include="ModAPI\Detouring.h" />
     <ClInclude Include="Spore\Creations.h" />
     <ClInclude Include="Spore\Editors\CreatureWalkController.h" />
+    <ClInclude Include="Spore\Editors\EditorBaseHandle.h" />
     <ClInclude Include="Spore\Editors\EditorLimits.h" />
     <ClInclude Include="Spore\Editors\INameableEntity.h" />
     <ClInclude Include="Spore\Editors\PlayModeActor.h" />

Spore ModAPI/Spore ModAPI.vcxproj.filters

@@ -1863,6 +1863,9 @@
     <ClInclude Include="Spore\Simulator\cScenarioSimulator.h">
       <Filter>Header Files</Filter>
     </ClInclude>
+    <ClInclude Include="Spore\Editors\EditorBaseHandle.h">
+      <Filter>Header Files</Filter>
+    </ClInclude>
   </ItemGroup>
   <ItemGroup>
     <ClCompile Include="SourceCode\Allocator.cpp">

Spore ModAPI/Spore/Editors/Editor.h

@@ -55,7 +55,7 @@
 #include <EASTL\string.h>
 #include <EASTL\vector.h>
 
-/// Access the active editor object.
+/// Access the active editor object; check Editors::cEditor
 #define Editor (*Editors::GetEditor())
 
 #define cEditorPtr intrusive_ptr<Editors::cEditor>
@@ -96,6 +96,26 @@ namespace Editors
 		kComplexityFlagBakedBlock = 0x4,
 	};
 
+	/// Structure that records the state of the editor (current mode, budget, etc) for undo/redo history
+	class EditorStateEditHistory
+		: public DefaultRefCounted
+	{
+	public:
+		/* 08h */	int mBudget;
+		/* 0Ch */	Mode mMode;
+		/* 10h */	int field_10;
+		/* 14h */	bool field_14;
+		/* 15h */	bool field_15;
+		/* 18h */	int field_18;
+		/* 1Ch */	int field_1C;
+		/* 20h */	int field_20;
+		/* 24h */	int field_24;
+		/* 28h */	int field_28;
+	};
+	ASSERT_SIZE(EditorStateEditHistory, 0x2C);
+
+	/// Main class for editors. A single instance of this class exists during the whole game, and is used for all
+	/// editors (except the Adventure editor, that one uses App::cScenarioMode); you can access it with the Editor macro.
 	class cEditor 
 		: public App::IGameMode
 		, public Graphics::IRenderable
@@ -110,17 +130,44 @@ namespace Editors
 		//PLACEHOLDER virtual method 54h -> reads temporary database
 		//PLACEHOLDER virtual method 58h -> wrties temporary database
 
-		virtual ~cEditor();
+		/// Changes the current editor model, updating the creation with the parts and paints of the new editor model.
+		/// @param pEditorModel
+		void SetEditorModel(EditorModel* pEditorModel);
+
+		/// Get current editor model, which is the creation with the parts and paints.
+		/// @returns
+		inline EditorModel* GetEditorModel() const;
+
+		/// Adds an edit history (undo/redo) entry based on the current model of the editor.
+		/// @param arg1
+		/// @param pStateHistory
+		void CommitEditHistory(bool arg1, EditorStateEditHistory* pStateHistory = nullptr);
+
+		void Undo(bool, bool);
+		void Redo();
 
-		///
 		/// Returns true if the editor is currently in the given mode.
 		/// @param mode Either build, paint or play mode.
+		/// @returns
 		bool IsMode(Mode mode) const;
 
-		///
 		/// Returns true if the editor is currently active.
+		/// @returns
 		bool IsActive() const;
 
+		EditorCamera* GetCamera();
+
+		// _ZN6Editor9ScalePartEP14EditorRigblockii
+		// Editor::ScalePart(EditorRigblock *, int, int)
+
+
+		bool sub_581F70(EditorRigblock* part, void* activeHandle, int value);
+
+		// loc_573BB1 -> set part is hovered?
+
+
+		void RemovePart(EditorRigblock* part);  //PLACEHOLDER
+
 	public:
 
 		int vftable_1C;
@@ -164,7 +211,7 @@ namespace Editors
 		/* 88h */	IModelWorldPtr field_88;
 		/// The model world that contains the background model.
 		/* 8Ch */	IModelWorldPtr mpBackgroundModelWorld;
-		/* 90h */	int field_90;
+		/* 90h */	int field_90;  // related with havok world?
 		/* 94h */	IEffectWorldPtr mpEffectWorld;
 
 		// use appropiate container!
@@ -188,14 +235,15 @@ namespace Editors
 		/* C8h */	int field_C8;  // not initialized
 
 		// also valid for spines
-		/* CCh */	intrusive_ptr<EditorRigblock> mpActivePart;
-		/* D0h */	intrusive_ptr<EditorRigblock> mpMovingPart;  // the part that is being moved, only when mouse is being clicked
-		/* D4h */	intrusive_ptr<EditorRigblock> mpSelectedPart;  // also valid for spines
+		/// Rigblock that is being hovered, and where actions like mouse wheel scaling will be applied
+		/* CCh */	EditorRigblockPtr mpActivePart;
+		/* D0h */	EditorRigblockPtr mpMovingPart;  // the part that is being moved, only when mouse is being clicked
+		/* D4h */	EditorRigblockPtr mpSelectedPart;  // also valid for spines
 
-		/* D8h */	int field_D8;
-		/* DCh */	int field_DC;
+		/* D8h */	DefaultRefCountedPtr field_D8;
+		/* DCh */	DefaultRefCountedPtr field_DC;
 		/* E0h */	bool field_E0;
-		/* E4h */	UnkClass4* mpActiveHandle;  // morph handles
+		/* E4h */	EditorBaseHandle* mpActiveHandle;  // morph handles
 		/// Is the mouse over the skin of the creature?
 		/* E8h */	bool mbMouseIsInSkin;
 		/* E9h */	bool field_E9;
@@ -212,7 +260,7 @@ namespace Editors
 		/* 142h */	bool field_142;
 		/* 143h */	bool field_143;  // not initialized
 		/* 144h */	bool field_144;  // true
-		/* 148h */	int field_148;
+		/* 148h */	ObjectPtr field_148;
 		/* 14Ch */	int field_14C; // vertebra? only present in creature-like editor
 		/* 150h */	intrusive_ptr<Object> field_150;  // something related with painting?  uses sub_4C3E70 to return something that parts also use
 		/* 154h */	int field_154;
@@ -224,9 +272,9 @@ namespace Editors
 
 		/* 158h */	int field_158;
 		/* 15Ch */	int field_15C;
-		/* 160h */	vector<int> field_160;
-		/* 174h */	vector<int> field_174;
-		/* 188h */	int field_188;
+		/* 160h */	vector<intrusive_ptr<EditorStateEditHistory>> mStateEditHistory;
+		/* 174h */	vector<cEditorResourcePtr> mEditHistory;
+		/* 188h */	int mEditHistoryIndex;
 		/// The ID of the .prop configuration file of the current editor.
 		/* 18Ch */	uint32_t mEditorName;  // 0x465C50BA
 		/* 190h */	bool mbTransitionHideUI;  // true
@@ -240,7 +288,7 @@ namespace Editors
 		/* 1ACh */	int field_1AC;
 		/// Maps a creation format extension to its default editor. For example, 'crt' is mapped to 'CreatureEditorExtraLarge'.
 		/* 1B0h */	map<uint32_t, uint32_t> mDefaultEditors;
-		/* 1CCh */	intrusive_ptr<EditorRequest> mEditorRequest;	// in 35h there is bool editorAllowNameEdit;
+		/* 1CCh */	EditorRequestPtr mEditorRequest;	// in 35h there is bool editorAllowNameEdit;
 		/* 1D0h */	ResourceKey mParentAssetKey;
 		/* 1DCh */	string16 field_1DC;
 		/* 1ECh */	int field_1EC;
@@ -375,7 +423,7 @@ namespace Editors
 		/* 364h	*/	int field_364;
 		/* 368h	*/	int field_368;
 		/* 36Ch	*/	vector<int> field_36C;
-		/* 380h */	int field_380;
+		/* 380h */	DefaultRefCountedPtr field_380;
 		/* 384h */	bool field_384;
 		/* 385h */	bool field_385;
 		/* 388h */	int field_388;  // not initialized
@@ -388,17 +436,13 @@ namespace Editors
 		/* 398h */	bool field_398;  // true
 		/* 399h */	bool field_399;  // true
 		/* 39Ah */	bool field_39A;  // true
-		/* 39Ch */	int field_39C;
-		/* 3A0h */	int field_3A0;
-		/* 3A4h */	int field_3A4;
-		/* 3A8h */	int field_3A8;  // not initialized
-		/* 3ACh */	int field_3AC;  // not initialized
-		/* 3B0h */	int field_3B0;  // not initialized
+		/* 39Ch */	vector<int> field_39C;
+		/* 3B0h */	float field_3B0;  // not initialized
 		/* 3B4h */	int field_3B4;  // not initialized
-		/* 3B8h */	intrusive_ptr<Palettes::PaletteMain> mpPartsPalette;
-		/* 3BCh */	intrusive_ptr<Palettes::PaletteUI> mpPartsPaletteUI;
-		/* 3C0h */	intrusive_ptr<Palettes::PaletteMain> mpPaintPalette;
-		/* 3C4h */	intrusive_ptr<Palettes::PaletteUI> mpPaintPaletteUI;
+		/* 3B8h */	PaletteMainPtr mpPartsPalette;
+		/* 3BCh */	PaletteUIPtr mpPartsPaletteUI;
+		/* 3C0h */	PaletteMainPtr mpPaintPalette;
+		/* 3C4h */	PaletteUIPtr mpPaintPaletteUI;
 		/* 3C8h */	bool field_3C8;
 		/* 3C9h */	bool field_3C9;  // true
 
@@ -515,19 +559,6 @@ namespace Editors
 		/* 5F4h */	int field_5F4;
 		/* 5F8h */	int field_5F8;
 		/* 5FCh */	int field_5FC;  // not initialized
-
-		EditorCamera* GetCamera();
-
-		// _ZN6Editor9ScalePartEP14EditorRigblockii
-		// Editor::ScalePart(EditorRigblock *, int, int)
-
-
-		bool sub_581F70(EditorRigblock* part, void* activeHandle, int value);
-
-		// loc_573BB1 -> set part is hovered?
-
-
-		void RemovePart(EditorRigblock* part);  //PLACEHOLDER
 	};
 
 	static_assert(sizeof(cEditor) == 0x600, "sizeof(cEditor) must be 0x600!");
@@ -547,6 +578,11 @@ namespace Editors
 		DeclareAddress(OnMouseMove);
 		DeclareAddress(OnMouseWheel);
 		DeclareAddress(Update);
+
+		DeclareAddress(SetEditorModel);  // 0x5867D0, 0x586B00
+		DeclareAddress(CommitEditHistory);  // 0x5860E0, 0x586410
+		DeclareAddress(Undo);  // 0x58A270, 0x58A5A0
+		DeclareAddress(Redo);  // 0x58A620, 0x58A950
 	}
 
 	/// Returns the Editor instance (there can only be one at a time).
@@ -557,16 +593,7 @@ namespace Editors
 
 	inline EditorCamera* cEditor::GetCamera()
 	{
-		App::ICamera* pCamera = this->mpGameModeMgr->GetCameraManager()->GetActiveCamera();
-
-		if (pCamera != nullptr)
-		{
-			return (EditorCamera*) pCamera->Cast(EditorCamera::TYPE);
-		}
-		else
-		{
-			return nullptr;
-		}
+		return object_cast<EditorCamera>(mpGameModeMgr->GetCameraManager()->GetActiveCamera());
 	}
 
 	inline bool cEditor::IsMode(Mode mode) const {
@@ -576,4 +603,9 @@ namespace Editors
 	inline bool cEditor::IsActive() const {
 		return mIsActive;
 	}
+
+	inline EditorModel* cEditor::GetEditorModel() const
+	{
+		return mpEditorModel;
+	}
 }