node Class Reference

#include "remoto!stdlib:js/panes/panes/nodeCanvas/node.js"

Inheritance diagram for node:

Public Member Functions
	node (_path, _cnv, _attrs, _in, _out, _base, _icon)
	applyDiff (diff, user)
	applyRequestSuccess (command, id, data, metadata)
	applySubscription (data, metadata)
	attach ()
	baseDiff (callback)
	baseValues (callback, definition)
	return the values of this node that differ from the default value More...
	bestPlugCandidate (c, pp)
	boundsPosition (pt, labelPoint, dist)
	bridgeOnDestroy ()
	changeField (variable, value, widget)
	checkSnap (x, y)
	copy ()
	createAttributes (attrs)
	createInputs (_in)
	createOutputs (_out)
	createSVG ()
	destroy ()
	detach (createUndo)
	diffPosition (variable, value, widget)
	dotsBelow ()
	getBBox ()
	getConnectedNode (input)
	getPlug (n, input, firstAvailable)
	hidePlugs ()
	show all hidden plugs, which would be split plugs that are not connected More...
	initHandlers ()
	isAncestorOf (n)
	isChildOf (_path, _cnv, _attrs, _in, _out)
	moveBy (x, y)
	position (x, y)
	refreshCableColor (_plug)
	resetInvalids ()
	resize ()
	resolvedType (_plug)
	showPlugs ()
	show all hidden plugs, which would be split plugs that are not connected More...
	splitPlug (p)
	splitPlugKey (k, a)
	startDiff ()
	startMove ()
	stopDiff ()
	stopMove (noundo)
	topStack (skipPlugs)
	unsplitPlug (p)

Getters & Setters
getter	id
	a getter DOCME More...
setter	name
	a setter DOCME More...
setter	type
	a setter DOCME More...
getter	color
	a getter DOCME More...
getter	x
	a getter DOCME More...
getter	y
	a getter DOCME More...
getter	selected
	a getter DOCME More...

Detailed Description

DOCME

Constructor & Destructor Documentation

node()

node	(		_path,
			_cnv,
			_attrs,
			_in,
			_out,
			_base,
			_icon
	)

Parameters

_path	path on the VFS
_cnv	canvas to attach to
_attrs	attributes to create, from definitions
_in	inputs to create
_out	outputs to create
_base	The base definition to extend from
_icon	the node's icon

DOCME

Member Function Documentation

applyDiff()

applyDiff	(		diff,
			user
	)

Parameters

diff
user

DOCME

applyRequestSuccess()

applyRequestSuccess	(		command,
			id,
			data,
			metadata
	)

Parameters

command
id
data
metadata

DOCME

applySubscription()

applySubscription	(		data,
			metadata
	)

Parameters

data
metadata

DOCME

attach()

attach

(

)

DOCME

baseDiff()

baseDiff

(

callback

)

Parameters

callback

DOCME

baseValues()

baseValues	(		callback,
			definition
	)

return the values of this node that differ from the default value

Parameters

callback	Used if present, otherwise the values are returned
definition	Unused, but there as a placeholder if basedDiff was called.

If an attribute was not given a default, the current value is returned. If the base definitions for a node's spec have not been loaded, you must used the baseDiff() form and provide a callback.

bestPlugCandidate()

bestPlugCandidate	(		c,
			pp
	)

Parameters

c
pp

Returns

DOCME

boundsPosition()

boundsPosition	(		pt,
			labelPoint,
			dist
	)

Parameters

pt
labelPoint
dist

Returns

DOCME

bridgeOnDestroy()

bridgeOnDestroy

(

)

Returns

DOCME

changeField()

changeField	(		variable,
			value,
			widget
	)

Parameters

variable
value
widget

DOCME

checkSnap()

checkSnap	(		x,
			y
	)

Parameters

x
y

Returns

DOCME

color()

setter color

a getter DOCME

a setter DOCME

copy()

copy

(

)

Returns

DOCME

createAttributes()

createAttributes

(

attrs

)

Parameters

attrs

DOCME

createInputs()

createInputs

(

_in

)

Parameters

_in

DOCME

createOutputs()

createOutputs

(

_out

)

Parameters

_out

DOCME

createSVG()

createSVG

(

)

DOCME

destroy()

destroy

(

)

DOCME

detach()

detach

(

createUndo

)

Parameters

createUndo

DOCME

diffPosition()

diffPosition	(		variable,
			value,
			widget
	)

Parameters

variable
value
widget

DOCME

dotsBelow()

dotsBelow

(

)

Returns

DOCME

getBBox()

getBBox

(

)

Returns

DOCME

getConnectedNode()

getConnectedNode

(

input

)

Parameters

input

Returns

DOCME

getPlug()

getPlug	(		n,
			input,
			firstAvailable
	)

Parameters

n
input
firstAvailable

Returns

DOCME

hidePlugs()

hidePlugs

(

)

show all hidden plugs, which would be split plugs that are not connected

This is deactivated by releasing the alt key in a node graph

id()

getter id

a getter DOCME

initHandlers()

initHandlers

(

)

DOCME

isAncestorOf()

isAncestorOf

(

n

)

Parameters

n

Returns

DOCME

isChildOf()

isChildOf	(		_path,
			_cnv,
			_attrs,
			_in,
			_out
	)

Parameters

_path	path on the VFS
_cnv	canvas to attach to
_attrs	attributes to create, from definitions
_in	inputs to create
_out	outputs to create

Returns

DOCME

moveBy()

moveBy	(		x,
			y
	)

Parameters

x
y

DOCME

name()

setter name

a setter DOCME

position()

position	(		x,
			y
	)

Parameters

x
y

Returns

DOCME

refreshCableColor()

refreshCableColor

(

_plug

)

Parameters

_plug

DOCME

resetInvalids()

resetInvalids

(

)

DOCME

resize()

resize

(

)

DOCME

resolvedType()

resolvedType

(

_plug

)

Parameters

_plug

Returns

DOCME

selected()

setter selected

a getter DOCME

a setter DOCME

showPlugs()

showPlugs

(

)

show all hidden plugs, which would be split plugs that are not connected

This is activated with the alt key in a node graph

splitPlug()

splitPlug

(

p

)

Parameters

p

DOCME

splitPlugKey()

splitPlugKey	(		k,
			a
	)

Parameters

k
a

Returns

DOCME

startDiff()

startDiff

(

)

DOCME

startMove()

startMove

(

)

DOCME

stopDiff()

stopDiff

(

)

DOCME

stopMove()

stopMove

(

noundo

)

Parameters

noundo

DOCME

topStack()

topStack

(

skipPlugs

)

Parameters

skipPlugs

DOCME

type()

setter type

a setter DOCME

unsplitPlug()

unsplitPlug

(

p

)

Parameters

p

DOCME

x()

getter x

a getter DOCME

y()

getter y

a getter DOCME

---

The documentation for this class was generated from the following file:

• node.js