Class: XebraNode

xebra.js v1.2.5 - Documentation

XebraNode

new XebraNode(id, type, creationSeq)

Constructor for internal use only Base class for Max nodes in the Xebra state tree. Through Xebra, Max exposes patchers, mira.frame objects, other Max objects and assignable parameters for each object. Each of these is represented by a different XebraNode subclass.

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

Members

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.

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.

Methods

getParamTypes():Array.<string>

Returns a list of the names of all available parameters.

Returns:
Type Description
Array.<string>

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

setParamValue(type, value)

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

XebraNode.event:destroy

Object Destroyed event

Name Type Description
object XebraNode

The destroyed object