new ParamNode(id, type, creationSeq)
Constructor for internal use only
Representation of a Max object parameter. Usually, a parameter is simply a Max attribute. Setting the value of the parameter will update the Max object attribute with the same name. Some parameters do not map to attributes, for example the "distance" parameter of a slider object, which controls the value of the slider.
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 |
Extends
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.
-
remoteSequence:number
-
The sequence number associated with the most recent modification. Whenever the value of the parameter is updated in Max or some other remote endpoint, this sequence number will increase.
-
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.
-
The current value of this parameter. Setting the value will trigger an update in Max, if connected. This will not cause an ObjectNode.param_changed event to fire, however, since this is only fired on changes that come from Max.
Methods
-
inherited getParamTypes():Array.<string>
-
Returns a list of the names of all available parameters.
Returns:
Type Description Array.<string> -
inherited getParamValue(type):Xebra.ParamValueType
-
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)
-
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
-
ParamNode.event:change
-
Parameter change event
Name Type Description param
ParamNode this