JSDoc: Module: topo

Methods

(static) createTopology(name, srid, tolerance) → {module:topo~Topo}

Create topology.

Parameters:

Name	Type	Description
`name`	string
`srid`	number
`tolerance`	number

Source:

topo.js, line 96

Returns:

Type: module:topo~Topo

(static) on(topo, name, callback)

Registers a callback for a named event

Parameters:

Name	Type	Description
`topo`	module:topo~Topo	Topology instance.
`name`	string	Event name.
`callback`	function	Callback function.

Source:

topo.js, line 156

(static) un(topo, name, callback)

Unregisters a callback for a named event

Parameters:

Name	Type	Description
`topo`	module:topo~Topo	Topology instance.
`name`	string	Event name.
`callback`	function	Callback function.

Source:

topo.js, line 166

Type Definitions

Topo

Topology structure

Type:

Object

Properties:

Name	Type	Description
`nodes`	Array.<module:node~Node>
`nodesTree`	Object
`edges`	Array.<module:edge~Edge>
`edgesTree`	Object
`faces`	Array.<module:face~Face>
`facesTree`	Object
`universe`	module:face~Face
`getNodeByPoint`	function	Calls `module:node.getNodeByPoint` in the context of this object
`addIsoNode`	function	Calls `module:node.addIsoNode` in the context of this object
`removeIsoNode`	function	Calls `module:node.removeIsoNode` in the context of this object
`getEdgeByPoint`	function	Calls `module:edge.getEdgeByPoint` in the context of this object
`getEdgesByLine`	function	Calls `module:edge.getEdgesByLine` in the context of this object
`addIsoEdge`	function	Calls `module:edge.addIsoEdge` in the context of this object
`addEdgeNewFaces`	function	Calls `module:edge.addEdgeNewFaces` in the context of this object
`addEdgeModFace`	function	Calls `module:edge.addEdgeModFace` in the context of this object
`remEdgeNewFace`	function	Calls `module:edge.remEdgeNewFace` in the context of this object
`remEdgeModFace`	function	Calls `module:edge.remEdgeModFace` in the context of this object
`newEdgesSplit`	function	Calls `module:edge.newEdgesSplit` in the context of this object
`modEdgeSplit`	function	Calls `module:edge.modEdgeSplit` in the context of this object
`newEdgeHeal`	function	Calls `module:edge.newEdgeHeal` in the context of this object
`getRingEdges`	function	Calls `module:face.getRingEdges` in the context of this object
`getFaceGeometry`	function	Calls `module:face.getFaceGeometry` in the context of this object
`on`	function	Calls `module:topo.on` in the context of this object
`un`	function	Calls `module:topo.un` in the context of this object