Class MacaoNode

This class is used to build a node in a MacaoNet.

You can build a MacaoNet to have paths for your objects to walk on. A MacaoNet is identified by its name (= net type). See getNet(). A MacaoNet is build of MacaoNode objects, which are connected by MacaoConnection objects.

You create a net just by creating a node for this net. You provide the net

For nets that are representing a room for example, you will build the net "manual", by adding nodes and connecting them. For road maps, there is the package core/road.js. You can use this package to build large road maps. There you can use the Road Editor to build a large net, just by using the mouse. This functionality is using MacaoNet, MacaoNode and MacaoConnection to build a net with the name (= net type) "Road". You can use this net like a net you built manually.

Use this constructor to create a new node in a net.

When you create a node, the node is automatically registered to the net that is defined by the parameter netType. See also MacaoNet.

Parameters

netType: Provide the name of the net the node belongs to.
xPos: Provide the x-coordinate of the node relative to the page in pixels.
yPos: Provide the y-coordinate of the node relative to the page in pixels.
ownerObject: If you provide an owner object and another object wants to leave the node during walking, the owner object will be asked if the other object may leave the node. See mayILeave(). Provide null, if you don't need to control the passing objects.
name: Provide a unique name for the node, if you want to get the node by its name. See MacaoPage.getNodeByName(). Provide null, if you don't need to get the node by name.

Call this method to calculate the distance from this node to another position.

Parameters

xPos: Provide the x-coordinate of the other position in pixels relative to the page.
yPos: Provide the y-coordinate of the other position in pixels relative to the page.


Returns

Returns the distance between the node and the other position in pixels.

Call this method to connect this node to another node by a MacaoConnection.

See also disconnectFrom().

Parameters

node: Provide the target node, which has to be in the same MacaoNet as this node.
alsoBack: Provide true, if you also want to connect the other node to this node. Provide false or null, if you only want to create a one-way connection.


Returns

Returns the connection object, which represents the new connection. Returns null, if the nodes can't be connected.

Call this method to remove the connection from this node to another node.

See also connectTo().

Parameters

node: Provide the node you want to remove the connection to.
alsoBack: Provide true, if you also want to remove the connection from the other node to this node. Provide false or null, if you only want to remove the connection from this node to the other node.

Call this method to get an array with the names of all the objects, which are assigned to the node.

See MacaoObject.setAssignedNode().

Returns

Returns an array of strings containing the names of the objects, which are assigned to this node.

Call this method to get an array containing all the connections from this node.

See also connectTo().

Returns

Returns an array of MacaoConnection objects, which are all the connections starting at this node.

Call this method to get the index of the node in the MacaoNet the node belongs to.

See also MacaoNet.getNodeByIndex().

Returns

Returns the index of the node in the list of nodes in the net the node belongs to.

Call this method to get the name of the node.

See also setName().

Returns

Returns the name of the node or null, if there is no name assigned to the node.

Call this method to get the name of the net the node belongs to.

See also MacaoNet.

Returns

Returns the name of the net the node belongs to.

Call this method to check, if the property stepOn is activated.

See also setStepOn().

Returns

Returns true, if the property stepOn is activated. Else returns false.

Call this method to get the x-coordinate of the node.

Returns

Returns the x-coordinate of the node in pixels relative to the page.

Call this method to get the x-coordinate of the node.

Returns

Returns the y-coordinate of the node in pixels relative to the page.

Call this method to get the zoom factor, which is used to scale objects, which are passing this node.

See also setZoom().

Returns

Returns the zoom factor. The default value is 1.0.

This method is called, when an object wants to leave the node. The method can prohibit the leaving if it is for example controlled by a traffic light.

If an owner object has been assigned to the node (see MacaoNode()) the request to leave is forwarded to the owner. At the owner object the method mayObjectLeaveNode(object, fromNode, toNode) is called, where object is the object that wants to leave, fromNode is this node and toNode is the next node the object wants to walk to. The parameter toNode may be null.

Parameters

object: Provide the object, which wants to leave the node. You may provide null, if the object is unknown.
toNode: Provide the next node, the object wants to walk to. So this method may allow the walk in one direction but stop another direction.


Returns

The method returns true, if the object may leave the node. It returns false, if the object has to stay on the node.

Call this method to name the node.

You can use MacaoPage.getNodeByName() to find a node by its name. See also getName().

Parameters

nodeName: Provide a unique name to this node. Provide null, if you want to clear the node's name.

Call this method to define if walking objects have to step on this node.

If the property step on is deactivated, walking objects may step over this node in the direction to the next node. This makes the walking smoother. Set this property to true, if the node is for example a traffic light the object has to step on or if the node is assigned to an object. So when the walking object is walking to the assigned object it will stop exactly on the node. For traffic lights and assigned objects this property is set automatically. So you may set it for your own purposes. By default this property is set to false.

Parameters

activate: Set this parameter to true to activate the property. Set it to false to deactivate it.

Call this method to set a zoom factor, which will be used to zoom objects, which walk over this node.

If an object steps on this node, the zoom factor is set to the object. If the object walks on a connection between this node and another node, the zoom factor of the object will be set to a value calculated of the zoom factors of both nodes. The default value of the zoom factor is 1.0. See also MacaoObject.setZoom().

Parameters

zoomFactor: Provide the zoom factor that has to be used for objects that are walking over this node.