Framebased Delay by timothymclure · Pull Request #284 · vvvv/vvvv-sdk

timothymclure · 2016-10-17T13:39:49Z

Framebased Delay added for Addonpack

joreg

some cosmetics

joreg · 2016-10-18T00:55:38Z

vvvv45/addonpack/src/nodes/plugins/Animation/DelayFramebased/DelayFramebasedNode.cs

+namespace VVVV.Nodes
+{
+	#region PluginInfo
+	[PluginInfo(Name = "Delay", Category = "Animation", Version ="Framebased", Help = "Framebased delay with adjustable frame count.", Tags = "Whiplash/joshuavh")]


"Whiplash/joshuavh" doesn't sound like a proper tag..please elaborate

joreg · 2016-10-18T00:57:20Z

vvvv45/addonpack/src/nodes/plugins/Animation/DelayFramebased/DelayFramebasedNode.cs

+		public ISpread<double> FInput;
+
+		[Input("Skip", IsBang = false)]
+		public ISpread<bool> skip;


all fields should start with a capital F, like FSkip, FReset, FDelayFrames, FListOfQueues

joreg · 2016-10-18T00:57:59Z

vvvv45/addonpack/src/nodes/plugins/Animation/DelayFramebased/DelayFramebasedNode.cs

+		[Input("Input", DefaultValue = 1.0)]
+		public ISpread<double> FInput;
+
+		[Input("Skip", IsBang = false)]


IsBang=false is not needed. bools are toggles by default.

joreg · 2016-10-18T00:59:08Z

vvvv45/addonpack/src/nodes/plugins/Animation/DelayFramebased/DelayFramebasedNode.cs

+
+		public void Evaluate(int SpreadMax)
+		{
+


please remove superfluous linebreaks.

joreg · 2016-10-18T01:00:38Z

vvvv45/addonpack/src/nodes/plugins/Animation/DelayFramebased/DelayFramebasedNode.cs

+////////////////////////////////////////////////////////////////////////////	
+
+
+		public void setDelayQueue(int index, int SMax, int diff){


Operations start with a capital letter

minor changes

timothymclure · 2016-10-27T08:55:19Z

hey joreg, we updated the forked repo with the requested cosmetics

joreg

sorry for my late answer and thanks for your changes so far. i hope you don't understand this to be to annoy you. i'm just hoping that those changes would contribute to a more concise code-base in the future.

joreg · 2016-10-29T17:50:34Z

vvvv45/addonpack/src/nodes/plugins/Animation/DelayFramebased/DelayFramebasedNode.cs

+	public class DelayFramebased : IPluginEvaluate
+	{
+		#region fields & pins
+		[Input("Input", DefaultValue = 1.0)]


any reason for the default being 1.0 here instead of 0? if not, then simply remove the default value

joreg · 2016-10-29T17:51:53Z

vvvv45/addonpack/src/nodes/plugins/Animation/DelayFramebased/DelayFramebasedNode.cs

+		[Input("Reset")]
+		public ISpread<bool> FReset;
+
+		[Input("Delay", DefaultValue = 1.0, MinValue = 0)]


in the Delay (Animation) node this parameter is called "Time". for consistency reasons i'd suggest to name this pin "Frames"

joreg · 2016-10-29T17:54:41Z

vvvv45/addonpack/src/nodes/plugins/Animation/DelayFramebased/DelayFramebasedNode.cs

+		[Input("Skip")]
+		public ISpread<bool> FSkip;
+
+		[Input("Reset")]


a "Reset" pin would typically be the last pin on a node. just checked with Delay (Animation) where it is not, but that should not stop you from doing it right here. also the original node has a "Reset Value" input, wouldn't that also be useful here?

joreg · 2016-10-29T17:55:43Z

vvvv45/addonpack/src/nodes/plugins/Animation/DelayFramebased/DelayFramebasedNode.cs

+		[Input("Input", DefaultValue = 1.0)]
+		public ISpread<double> FInput;
+
+		[Input("Skip")]


in Delay (Animation) the input is called "Insert". is that the same only in reverse? so not skip = insert? if so i'd suggest to name it "Insert" here also

joreg · 2016-10-29T17:56:54Z

vvvv45/addonpack/src/nodes/plugins/Animation/DelayFramebased/DelayFramebasedNode.cs

+
+		[Input("Delay", DefaultValue = 1.0, MinValue = 0)]
+		public ISpread<int> FDelayFrames;
+


also i suggest to adapt the order of pins to the original node. that would be: Input, Frames, Insert, Reset (Reset Value)

joreg · 2016-10-29T17:57:41Z

vvvv45/addonpack/src/nodes/plugins/Animation/DelayFramebased/DelayFramebasedNode.cs

+		public ILogger FLogger;
+		#endregion fields & pins
+
+		List<Queue<double>> listOfQueue = new List<Queue<double>>();


listOfQueue is also a field just like the inputs. therefore it would also be called: FListOfQueue

joreg · 2016-10-29T17:59:32Z

vvvv45/addonpack/src/nodes/plugins/Animation/DelayFramebased/DelayFramebasedNode.cs

+			FOutput.SliceCount = SpreadMax;
+
+
+			if(SpreadMax != listOfQueue.Count){


in most c# coding guidlines you'll learn to place opening brackets on a new line for good style and better readability.

joreg · 2016-10-29T18:00:58Z

vvvv45/addonpack/src/nodes/plugins/Animation/DelayFramebased/DelayFramebasedNode.cs

+
+				int difference = SpreadMax - listOfQueue.Count;
+
+				if(difference < 0){


while i'm at it: it is good practice to put a space between if and the opening bracket. same with "for ("

joreg · 2017-02-13T17:21:44Z

@timothymclure are you still interested in getting this into the addonpack? if so please answer my review..

timothymclure · 2017-02-15T12:50:50Z

@joreg -- of course. I don´t mean to be disrespectful, but the Plugin works and I think creative decisions and how to format the code should be up to the coder. Made this small plugin for ourselves and wanted to share it in case someone else might find it helpful.

joreg · 2017-02-15T13:23:14Z

hei @timothymclure thanks for getting back on this.
my review indeed comprises of different things:

node signature, ie naming, order and defaults of pins
coding style

i want to explain why each is important and not a creative choice:

node signature: in vvvv if you doubleclick a Delay (Animation) node to replace it with your Delay (Animation Framebased) all the pins that have the same name will keep their connections. this is a very convenient feature which you break with your creative decision. this is only regarding the pin-names. pin-order and defaults make sense to keep the same as well because if you already learned how to use the timebased delay-node you should not have to learn something new about a node that pretends (through its naming) to be quite the same but only a framebased version of it.
coding style: if you're coding for yourself you can of course choose any style you prefer. the addonpack is a huge codebase that many people contribute to over a long period of time. the more creative individuals get with their contributions the less maintainable the code will get over time.

having said that, i hope you understand why both reasons are important. we haven't been very strict about coding-style in the past so please consider my remarks regarding coding-style more as a recommendation. regarding the node-signature though i'll have to enforce my remarks for the sanity of all vvvv users.

so please either fix those or of course feel free to close this pullrequest if you prefer not to. you'll then still have the option to share your plugin as a contribution: https://vvvv.org/contributions

timothymclure · 2017-02-22T12:11:46Z

Hey @joreg, point one accepted, but think it should be communicated way better beforehand. This still is not a plugin especially made for the addonpack, so there was no need to follow guidelines in the first place.
As far as coding for yourself or for this Pack, I really think you should be able to code the way you are comfortable with and still have the opportunity to share it in the Pack, as long as the code is quite readable. But this of course is up to you to decide and I accept that. So I will look back into it, but it may take a while.

joreg · 2017-02-22T14:13:22Z

thanks for your understanding. looking fwd to your update anytime...

Framebased Delay

a087d92

Framebased Delay added for Addonpack

joreg requested changes Oct 18, 2016

View reviewed changes

Delay Framebased

04e158d

minor changes

joreg approved these changes Oct 27, 2016

View reviewed changes

joreg reviewed Oct 29, 2016

View reviewed changes

joreg closed this Feb 13, 2017

joreg reopened this Feb 13, 2017

		////////////////////////////////////////////////////////////////////////////


		public void setDelayQueue(int index, int SMax, int diff){


		[Input("Delay", DefaultValue = 1.0, MinValue = 0)]
		public ISpread<int> FDelayFrames;

		FOutput.SliceCount = SpreadMax;


		if(SpreadMax != listOfQueue.Count){


		int difference = SpreadMax - listOfQueue.Count;

		if(difference < 0){

Conversation

timothymclure commented Oct 17, 2016

Uh oh!

joreg left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

timothymclure commented Oct 27, 2016

Uh oh!

joreg left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

joreg commented Feb 13, 2017

Uh oh!

timothymclure commented Feb 15, 2017

Uh oh!

joreg commented Feb 15, 2017

Uh oh!

timothymclure commented Feb 22, 2017

Uh oh!

joreg commented Feb 22, 2017

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants