» 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

  • 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 suptle detail (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

~6h ago

Urbankind: circuitb:Wrongcop is epic! :)

~7h ago

joreg: @tobi: use GetSlice() as the patch i referred you to is demonstrating. or start a forum thread with your patch.

~7h ago

TobiTobsen123: hmm yes i can see the values...but how to handle them as seperate values? I need to forward them via TCP/IP...

~9h ago

joreg: @tobi: OSCDecoder helppatch has a section: OSC_Advanced (bottomright) that demoes decoding of multiple messages

~9h ago

TobiTobsen123: I'm using an OSCDecoder, it receives two arguments...works but how can I seperate the arguments into two seperate values

~12h ago

u7angel: @mediadog, make it a forum question.

~12h ago

u7angel: @mediadog, tty renderer ?

~14h ago

microdee: however non-conductive objects are invisible for this so the pencil and the sticks in the video are still a mysteries