new FrameNode(id, type, creationSeq, patcherId)
Constructor for internal use only
FrameNode instances represent mira.frame objects in a Max patcher. Using the FrameNode object, it is possible to see which Max objects intersect a given mira.frame object, in both Patching as well as Presentation Modes.
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 |
patcherId |
number |
The id of the parent 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.
-
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
-
The view mode of the FrameNode. In Patching mode, object positions and visibility will be calculated relative to the patching_rect of the mira.frame object. In Presentation mode, the presentation_rect will be used. Linked mode will defer to Max. If Max is in Presentation mode, Xebra will use Presentation mode, and if Max is in Patching mode, Xebra will use Patching mode as well.
- See:
Methods
-
containsObject(id):boolean
-
Checks whether the frame contains the object identified by the given id.
Name Type Description id
Xebra.NodeId The id of the object
Returns:
Type Description boolean -
containsRect(rect):boolean
-
Boundary check whether the given rect is visible within the frame.
Name Type Description rect
Xebra.PatchingRect The rectangle to check
Returns:
Type Description boolean whether the rect is contained or not -
getObject(id):ObjectNode|null
-
Returns the object with the given id.
Name Type Description id
Xebra.NodeId The id of the object
Returns:
Type Description ObjectNode | null The object (if contained) or null -
getObjects():Array.<ObjectNode>
-
Returns a list of all objects contained in the frame.
Returns:
Type Description Array.<ObjectNode> An array of all contained objects -
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 -
getRelativeRect():Xebra.PatchingRect|null
-
Returns the frame of the object relative the the frame, in the current view mode, or null if the object is not in the frame.
Returns:
Type Description Xebra.PatchingRect | null Relative object frame. -
isViewModeLinked():boolean
-
Checks whether the current view mode is linked.
Returns:
Type Description boolean Whether the frame defers to Max for it's viewMode or not -
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