Xebra

Class: PatcherNode

xebra.js v1.2.5 - Documentation

PatcherNode

new PatcherNode(id, type, creationSeq, parentId)

nodes/patcher.js, line 14

Constructor for internal use only

Represent a single Max patcher. Use getFrames and getObjects to iterate over instances of FrameNode and ObjectNode, respectively. The very handy getObjectByScriptingName function can be used to get the ObjectNode instance bound to a Max object with the given varname attribute.

Name Type Description
id number

The id of the node
type string

Type identifier of the node
creationSeq number

The sequence number for the creation of this node
parentId number

The id of the parent node

Extends

Members

bgColor

Returns the current background color of the patcher considering whether it's currently locked or not

creationSequence:number

The creation sequence number associated with this node. This number is an increasing integer unique to each node.

id:Xebra.NodeId

readonly

Unique id associated with each XebraNode.

locked

Indicates whether the patcher is currently locked or not

name:string

Name of the patcher (same as the filename for saved patchers).

patcherId:Xebra.NodeId

readonly

Unique id of the parent patcher of the Max object.

type:string

Type associated with this node. For Objects, Frames and Patchers, this will correspond to the class name of the Max object. For parameters, this will be the name of the associated parameter. Parameters usually correspond to the name of a Max object's attribute.

viewMode:number

Returns whether the Max patcher is currently in Presentation or Patching display.

See:

Methods

getChannelNames():Array.<string>

nodes/patcher.js, line 367

Returns a list of the names of all mira.channel objects

Returns:
Type Description
Array.<string>

getFrame(id):Frame|null

nodes/patcher.js, line 383

Returns the frame with the given id.

Name Type Description
id Xebra.NodeId
Returns:
Type Description
Frame | null

getFrames():Array.<FrameNode>

nodes/patcher.js, line 391

Returns a list of frames that are present in this patch.

Returns:
Type Description
Array.<FrameNode>

getObject(id):ObjectNode|null

nodes/patcher.js, line 405

Returns the object with the given id.

Name Type Description
id Xebra.NodeId
Returns:
Type Description
ObjectNode | null

getObjectByScriptingName(scripting_name):ObjectNode|null

nodes/patcher.js, line 414

Returns the object with the given scripting name.

Name Type Description
scripting_name String
Returns:
Type Description
ObjectNode | null

getObjects():Array.<ObjectNode>

nodes/patcher.js, line 423

Returns a list of objects that are present in this patch.

Returns:
Type Description
Array.<ObjectNode>

inherited getParamTypes():Array.<string>

nodes/base.js, line 188

Returns a list of the names of all available parameters.

Returns:
Type Description
Array.<string>

inherited getParamValue(type):Xebra.ParamValueType

nodes/base.js, line 209

Returns the value for the parameter with the name type.

Name Type Description
type String

Parameter type identifier
Returns:
Type Description
Xebra.ParamValueType returns the value(s) of the given parameter type or null

inherited setParamValue(type, value)

nodes/base.js, line 220

Sets the value for the parameter with the name type to the given value.

Name Type Description
type String

Parameter type identifier
value Object

Parameter value

Events

PatcherNode.event:frame_changed

nodes/patcher.js, line 32
Name Type Description
frame FrameNode

The changed frame
param ParamNode

The parameter node

PatcherNode.event:object_changed

nodes/patcher.js, line 71
Name Type Description
object ObjectNode

The changed object
param ParamNode

The changed parameter