v_sim.NodeNeighbours¶

Subclasses:: None

Methods¶

Inherited:: GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`new` (data)
class	`new_forLink` (data, link)
	`addFilter` (pair)
	`getSurfaceAt` (nodeId)
	`getSurfaceFrom` (nodeId)
	`iter` (nodeId)

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

Name	Type	Flags	Short Description
`data`	`v_sim.Data`	r/w/co	the Data the neighbours are for
`factor`	`float`	r/w	additional percentage on radii
`link`	`v_sim.PairLink`	r/w/co	the Link the neighbours are for

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent	`GObject.Object`	r
priv	`v_sim.NodeNeighboursPrivate`	r

Class Details¶

class v_sim.NodeNeighbours(**kwargs)¶

Bases:: GObject.Object
Abstract:: No
Structure:: v_sim.NodeNeighboursClass

Common name to refer to a #_VisuNodeNeighbours.

classmethod new(data)¶

Parameters:: data (v_sim.Data) – a v_sim.Data object.
Returns:: a newly created v_sim.NodeNeighbours object.
Return type:: v_sim.NodeNeighbours

Create an object to handle a set of neighbours for data.

New in version 3.8.

classmethod new_forLink(data, link)¶

Parameters:

data (v_sim.Data) – a v_sim.Data object.
link (v_sim.PairLink) – a v_sim.PairLink object.

Returns:

a newly created v_sim.NodeNeighbours object.

Return type:

v_sim.NodeNeighbours

Create an object to handle a set of neighbours for data following link definition.

New in version 3.9.

addFilter(pair)¶

Parameters:: pair ([v_sim.Element]) – two v_sim.Element objects.

Restrain neighbour calculation to pairs matching pair.

New in version 3.9.

getSurfaceAt(nodeId)¶

Parameters:

nodeId (int) – a node number.

Returns:

True if def is generated.

def_:: a place to store points and polys.

Return type:

(bool, def_: v_sim.SurfaceDefinition)

Generate a surface definition around atom nodeId.

New in version 3.8.

getSurfaceFrom(nodeId)¶

Parameters:

nodeId (int) – a node id.

Returns:

True if there is any generated surface.

def_:: a place to store points and polys.

Return type:

(bool, def_: v_sim.SurfaceDefinition)

Generate a surface definition around atom nodeId and all its neighbours.

New in version 3.8.

iter(nodeId)¶

Parameters:

nodeId (int) – the node id to obtain neighbours of.

Returns:

True if the iterator is valid.

iter:: a v_sim.NodeNeighboursIter structure.

Return type:

(bool, iter: v_sim.NodeNeighboursIter)

Initialise iter to iterate over the neighbours of node nodeId.

New in version 3.8.

Property Details¶

v_sim.NodeNeighbours.props.data¶

Name:: data
Type:: v_sim.Data
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

the Data the neighbours are for

v_sim.NodeNeighbours.props.factor¶

Name:: factor
Type:: float
Default Value:: 0.20000000298023224
Flags:: READABLE, WRITABLE

additional percentage on radii

v_sim.NodeNeighbours.props.link¶

Name:: link
Type:: v_sim.PairLink
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

the Link the neighbours are for