v_sim.MethodSpin¶

Subclasses:: None

Methods¶

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

class	`getDefault` ()
class	`new` ()
	`getSpinVector` (dataSpin, node)

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

Name	Type	Flags	Short Description
`cone-omega`	`float`	r/w	The omega angle to orientate the colourisation cone.
`cone-phi`	`float`	r/w	The phi angle to orientate the colourisation cone.
`cone-theta`	`float`	r/w	The theta angle to orientate the colourisation cone.
`hiding-mode`	`int`	r/w	The hiding policy for spin with a null modulus.
`modulus-scaling`	`int`	r/w	The scaling policy based on modulus value.
`use-atomic`	`bool`	r/w	If atomic rendering is used in addition to spin rendering.

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent	`GObject.Object`	r

Class Details¶

class v_sim.MethodSpin(**kwargs)¶

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

Structure used to define v_sim.MethodSpin objects.

Added in version 3.8.

classmethod getDefault()¶

Returns:: the default spin method object.
Return type:: v_sim.MethodSpin

Access the default spin method object.

Added in version 3.8.

classmethod new()¶

Returns:: a newly allocated v_sim.MethodSpin object.
Return type:: v_sim.MethodSpin

Creates a v_sim.MethodSpin object.

Added in version 3.8.

getSpinVector(dataSpin, node)¶

Parameters:

dataSpin (v_sim.DataSpin) – a v_sim.DataSpin object.
node (v_sim.Node) – a v_sim.Node from dataSpin.

Returns:

three floats representing the spin.

ratio:: the ratio to apply when drawing the spin.
rgb:: a location to store the colour.
withAtomic:: a location to store if atomic rendering is required.

Return type:

(float, ratio: float, rgb: float, withAtomic: bool)

Retrieves the spin of node in spherical coordinates. According to rendering policy from self, ratio, rgb and withAtomic will be set to their respective values. If no spin should be rendered for node, None is returned.

Added in version 3.8.

Property Details¶

v_sim.MethodSpin.props.cone_omega¶

Name:: cone-omega
Type:: float
Default Value:: 0.0
Flags:: READABLE, WRITABLE

The omega angle to orientate the colourisation cone.

v_sim.MethodSpin.props.cone_phi¶

Name:: cone-phi
Type:: float
Default Value:: 0.0
Flags:: READABLE, WRITABLE

The phi angle to orientate the colourisation cone.

v_sim.MethodSpin.props.cone_theta¶

Name:: cone-theta
Type:: float
Default Value:: 0.0
Flags:: READABLE, WRITABLE

The theta angle to orientate the colourisation cone.

v_sim.MethodSpin.props.hiding_mode¶

Name:: hiding-mode
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE

The hiding policy for spin with a null modulus.

v_sim.MethodSpin.props.modulus_scaling¶

Name:: modulus-scaling
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE

The scaling policy based on modulus value.

v_sim.MethodSpin.props.use_atomic¶

Name:: use-atomic
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE

If atomic rendering is used in addition to spin rendering.