v_sim.NodeMover¶

Subclasses:: v_sim.NodeMoverRotation, v_sim.NodeMoverTranslation

Methods¶

Inherited:: GObject.Object (37), v_sim.Animatable (6)
Structs:: GObject.ObjectClass (5)

	`animate` ()
	`apply` ()
	`getNodes` ()
	`push` ()
	`setNodes` (ids)
	`undo` ()

Virtual Methods¶

Inherited:: GObject.Object (7)

	`do_push` ()
	`do_setup` ()
	`do_validate` ()

Properties¶

Name	Type	Flags	Short Description
`completion`	`float`	r/w	percentage of completion during animation.
`ids`	`GLib.Array`	r/w	node ids to move.
`nodes`	`v_sim.NodeArray`	r/w	nodes to apply the move to.
`undo-stack-depth`	`int`	r	undo stack depth.
`valid`	`bool`	r	if mover parameters are valid.

Signals¶

Inherited:: GObject.Object (1), v_sim.Animatable (1)

Fields¶

Inherited:: GObject.Object (1), v_sim.Animatable (1)

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

Class Details¶

class v_sim.NodeMover(**kwargs)¶

Bases:: GObject.Object, v_sim.Animatable
Abstract:: No
Structure:: v_sim.NodeMoverClass

An opaque structure.

New in version 3.8.

animate()¶: Starts the animation defined by self. For an application of the change without animation, use v_sim.NodeMover.apply().

New in version 3.8.

apply()¶: Apply the modification defined by self. To animate the transition, use v_sim.NodeMover.animate().

New in version 3.8.

getNodes()¶

Returns:: a list of node ids.
Return type:: [int]

Retrieves the node ids impacted by self.

New in version 3.8.

push()¶: Push the current modification on the undo stack without actually doing the modification.

New in version 3.8.

setNodes(ids)¶

Parameters:: ids ([int]) – a list of node ids.

Defines the nodes that will be affected by the modification in self.

New in version 3.8.

undo()¶: Undo the last modification.

New in version 3.8.

do_push() virtual¶

Return type:: bool

do_setup() virtual¶

do_validate() virtual¶

Return type:: bool

Property Details¶

v_sim.NodeMover.props.completion¶

Name:: completion
Type:: float
Default Value:: 0.0
Flags:: READABLE, WRITABLE

percentage of completion during animation.

v_sim.NodeMover.props.ids¶

Name:: ids
Type:: GLib.Array
Default Value:: None
Flags:: READABLE, WRITABLE

node ids to move.

v_sim.NodeMover.props.nodes¶

Name:: nodes
Type:: v_sim.NodeArray
Default Value:: None
Flags:: READABLE, WRITABLE

nodes to apply the move to.

v_sim.NodeMover.props.undo_stack_depth¶

Name:: undo-stack-depth
Type:: int
Default Value:: 0
Flags:: READABLE

undo stack depth.

v_sim.NodeMover.props.valid¶

Name:: valid
Type:: bool
Default Value:: False
Flags:: READABLE

if mover parameters are valid.