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

Conventions.NodeAndPinNaming

Italian | Spanish

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) (except pin names, see below) 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

  • a category is mandatory
  • it starts with a capital letter
  • it must only be a single word
  • prefer to use one of the existing categories over inventing a new one.

Rules for choosing optional Versions

  • for most nodes leaving this blank is the best option
  • do not use this version to indicate a specific version (as in "revision") of that particular node.
  • only use this to distinguish two nodes that do basically the same but only can be set apart by a subtle detail (see the many IO nodes in the "devices" category for examples)
  • in the rare case where you need to specify multiple versions, separate them by space.

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)
  • make use of the AutoName (VVVV DescriptiveName)-module to stick really to the conventions.

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

~23h ago

joreg: But first: This Friday in Berlin: Join our full day "Getting started with Generative Design Algorithms" workshop https://nodeforum.org/announcements/workshop-getting-started-with-generative-design/

~1d ago

joreg: In #Linz for #ArsElectronica? Join us for a free 2 days #vvvv workshop sponsored by businesses/responsive-spaces-gmbh Apply here: 2-day-gamma-vvvvorkshop-at-responsive-spaces-in-linz

~3d ago

joreg: Need your custom dose of #vvvv training? Join us at our studio in #berlin: vvvv-training-at-the-source

~8d ago

~13d ago

~13d ago

domj: Dev stream: Painting with light with a Vive controller, developing using VL and Schéma. Start at 17:00 https://www.twitch.tv/dominikjancik

~14d ago

joreg: July as it happened: vvvvhat-happened-in-july-2019 #vvvv

~15d ago

levi: @mrboni thanks mrboner. solved it by turning all the lights to strobe mode so framerate drops were actually a relief :P . love

~16d ago

joreg: reminder: this thursday, just before the patching circle, there is a free 2h intro to #vvvv gamma: free-vvvv-intro-workshops-this-summer-in-berlin