API Migration

1. Replace all "AddCallback()" subscriptions with calls of the Connect() method for the corresponding events. You can also replace callback IDs according to the following pattern:

   2.17	Source code (C#) System.IntPtr callback_id = ...
   2.18	Source code (C#) EventConnection callback_id = ...

   There is a set of regular expressions that can be used to speed up the process.
2. Replace all "RemoveCallback()" unsubscriptions with calls of the Disconnect() method for the former callback ID variables (if you changed their type to EventConnection as suggested in the previous step)

   2.17	Source code (C#) Render.RemoveCallback(Render.CALLBACK_INDEX.BEGIN_AUXILIARY_BUFFER, callback_id);
   2.18	Source code (C#) callback_id.Disconnect();

   There is a set of regular expressions that can be used to speed up the process.
3. Remove all "ClearCallbacks()" methods, use EventConnections pattern with a call to DisconnectAll() for such cases:

   2.17

   Source code (C#) // add the first Reparented callback handler property.AddCallback(Property.CALLBACK_INDEX.REPARENTED, event_handler); // add another Reparented callback handler property.AddCallback(Property.CALLBACK_INDEX.REPARENTED, (Property property) => { Log.Message("Reparented Handler\n"); }); // ... // remove all added Reparented callbacks property.ClearCallbacks(Property.CALLBACK_INDEX.REPARENTED);

   2.18

   Source code (C#) // create an instance of the EventConnections class private EventConnections conns = new EventConnections(); // subscribe for the Reparented event with the first handler linking to the EventConnections instance property.EventReparented.Connect(conns, event_handler); // subscribe for the Reparented event with another handler linking to the same EventConnections instance property.EventReparented.Connect(conns, (Property property) => { Log.Message("Reparented Handler\n"); } ); // ... // remove all subscriptions linked to the EventConnections instance conns.DisconnectAll();

4. In case you used the SetCallbackEnabled() method to temporarily disable firing of certain callbacks (e.g., for widgets), you can replace it by setting the Enabled property for the corresponding events:

   2.17	Source code (C#) widget.SetCallbackEnabled((int)Gui.CALLBACK_INDEX.CHANGED, false);
   2.18	Source code (C#) widget.EventChanged.Enabled = false;

   There is a set of regular expressions that can be used to speed up the process.

The set of regular expressions listed below might come in handy to save your time on upgrading your code:

([\S]*?)\.AddCallback\([\S]*?.(?:CALLBACK_INDEX\.|)([A-Z])([A-Z]*)(?:_([A-Z])([A-Z]*)){0,1}(?:_([A-Z])([A-Z]*)){0,1}(?:_([A-Z])([A-Z]*)){0,1}\s*?,\s*?([\S\s]*?)\)

$1.Event$2\L$3\E$4\L$5\E$6\L$7\E$8\L$9.\EConnect\(\E$10\)

viewport.AddCallback(Render.CALLBACK_INDEX.END_OPACITY_GBUFFER, gbuffers_ready_callback);

Properties.AddCallback(Properties.CALLBACK_INDEX.REMOVED, (Body b) => 
		{
			b.RenderInternalContacts(); 
			
			
			
			//...
		});

AsyncQueue.AddCallback(AsyncQueue.CALLBACK_INDEX.IMAGE_LOADED, image_loaded);

System.IntPtr callback_id = Render.AddCallback(Render.CALLBACK_INDEX.BEGIN_AUXILIARY_BUFFER, (Body b) => b.RenderInternalContacts() });

([\S]*?)\.Add([A-Za-z]+)Callback\(([\S\s]*?)\)

$1.Event$2.Connect\($3\)

trigger.AddEnterCallback(enter_callback);

joint.AddBrokenCallback((Joint j) => { j.Body0.Object.SetMaterialPath("some.mat", "*"); });

body.AddContactsCallback((Body b) => {
	b.RenderInternalContacts(); 
	
	
	//...
});

[\S]*?\.RemoveCallback\([\S\s]*?,\s*?([\S]*?)\s*?\)

$1.Disconnect\(\)

Render.RemoveCallback(Render.CALLBACK_INDEX.BEGIN_AUXILIARY_BUFFER, callback_id);

([\S]*?)\.SetCallbackEnabled\(\s*?\(int\)\s*?[\S]*?.(?:CALLBACK_INDEX\.|)([A-Z])([A-Z]*)(?:_([A-Z])([A-Z]*)){0,1}(?:_([A-Z])([A-Z]*)){0,1}(?:_([A-Z])([A-Z]*)){0,1}\s*?,\s*?([\S]*?)\s*?\)

$1.Event$2\L$3\E$4\L$5\E$6\L$7\E$8\L$9.\EEnabled = \E$10

widget.SetCallbackEnabled((int) Gui.CALLBACK_INDEX.CHANGED, false);