» Conventions.NodeAndPinNaming
This site relies heavily on Javascript. You should enable it if you want the full experience. Learn more.

Conventions.NodeAndPinNaming

When writing a new node and you are not sure about naming come here and find a solution.

Nodes/Modules

All terms (names, categories, versions) are written in CamelCaps

NodeName (Category OptionalVersion1 OptionalVersion2 .. )

Rules for choosing a name

  • nodenames must be a single word without spaces
  • if you are mainly encapsulating a function of a library it may make sense to stick to that name. for all the dx-nodes we tried to stay close to the dx-sdk for example, so that people who know dx (or your library) easily find their way in vvvv.
  • make it a general associative term. if your node does something strange like the "stallone" node feel free to choose your own association.
  • as with the Trautner, Delauny and Gouraud nodes... name a node by the inventor of the technique implemented

Rules for choosing a Category

  • try to use an existing category

Rules for choosing optional Versions

  • if nodes do basically the same but only can be distinguished by a suptle detail that may go for the version (see the many IO nodes in the "devices" category for examples)

Rules for choosing optional Tags

read About Tags

Pins

  • pin names start with capital letter
  • instead of using CamelCaps separate the words here, like: "Transform Mesh" instead of "TransformMesh"
  • keep names generic. If they have no special meaning name them: Input, Output (this helps vvvv to automatically reconnect pins when exchanging similar nodes)

Configuration Pins:

Configuration pins are primarily pins that must not be changed programmatically in a running patch (e.g. since they would add/remove pins on their nodes)

Input Pins with Subtype Bang

Try to use one of the following:

  • Apply (instead of: DoIt, ...)
  • Update (instead of: Refresh, Reassign..)
  • Read
  • Write
  • Copy
  • Move
  • Reset

Don't use names like "Do Read", an imperative "Read" is enough.

anonymous user login

Shoutbox

~8min ago

matka: @lecloneur nice!!

~10h ago

unti: does the selectjoint node cause an error on your systems too? it seems to occur when you hover over the window where you select joints

~18h ago

Jackal: works with the Xbox one also.

~18h ago

Urbankind: is Kinect V 1.5 is exclusive for Kinect PC or all the new features works with old kinect?

~20h ago

sapo: kinect 1.5 works with 27.2 vux nodes!

~22h ago

microdee: vvvv_45alpha28-develop-697babe... horny version number is horny:D

~23h ago

newsheng: @milo:thank you!