v_sim.ElementAtomic¶

Subclasses:: v_sim.ElementSpin

Methods¶

Inherited:: v_sim.ElementRenderer (16), GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`getShapeNames` (asLabel)
class	`new` (element)
	`bindToPool` ()
	`getElipsoidPhi` ()
	`getElipsoidRatio` ()
	`getElipsoidTheta` ()
	`getRadius` ()
	`getShape` ()
	`getUnits` ()
	`setElipsoidPhi` (val)
	`setElipsoidRatio` (val)
	`setElipsoidTheta` (val)
	`setRadius` (val)
	`setShape` (val)
	`setUnits` (val)

Virtual Methods¶

Inherited:: v_sim.ElementRenderer (4), GObject.Object (7)

Properties¶

Inherited:: v_sim.ElementRenderer (6)

Name	Type	Flags	Short Description
`elipsoid-angle-phi`	`float`	r/w	Elipsoid angle phi
`elipsoid-angle-theta`	`float`	r/w	Elipsoid angle theta
`elipsoid-ratio`	`float`	r/w	Elipsoid ratio
`radius`	`float`	r/w	atomic radius
`shape`	`int`	r/w	atomic shape
`units`	`int`	r/w	radius units

Signals¶

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

Fields¶

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

Name	Type	Access	Description
parent	`v_sim.ElementRenderer`	r

Class Details¶

class v_sim.ElementAtomic(**kwargs)¶

Bases:: v_sim.ElementRenderer
Abstract:: No
Structure:: v_sim.ElementAtomicClass

Structure used to define v_sim.ElementAtomic objects.

New in version 3.8.

classmethod getShapeNames(asLabel)¶

Parameters:: asLabel (bool) – a boolean.
Returns:: strings representing v_sim.ElementAtomicShapeId.
Return type:: [str]

Get the string defining v_sim.ElementAtomicShapeId. If asLabel is True, then the string are translated and stored in UTF8.

New in version 3.8.

classmethod new(element)¶

Parameters:: element (v_sim.Element) – a v_sim.Element object.
Returns:: a newly created v_sim.ElementAtomic object.
Return type:: v_sim.ElementAtomic

Creates a new v_sim.ElementAtomic object used to render element.

New in version 3.8.

bindToPool()¶: Bind all properties of self to the v_sim.ElementAtomic object corresponding to the same v_sim.Element from the pool. The binding is bidirectional. This method is usefull to create a pool of objects inheriting from v_sim.ElementAtomic.

New in version 3.8.

getElipsoidPhi()¶

Returns:: the phi angle.
Return type:: float

Retrieve the phi angle used to draw elipsoid shape with this renderer.

New in version 3.8.

getElipsoidRatio()¶

Returns:: a ratio value.
Return type:: float

When self is used to draw constant elipsoid or torus, this value is used to adjust the ratio between the two angles.

New in version 3.8.

getElipsoidTheta()¶

Returns:: a theta value.
Return type:: float

Retrieve the theta angle used to draw elipsoid shape with this renderer.

New in version 3.8.

getRadius()¶

Returns:: a radius value.
Return type:: float

Retrieve the radius used to draw self. The unit of the value is given by v_sim.ElementAtomic.getUnits().

New in version 3.8.

getShape()¶

Returns:: the shape used by self.
Return type:: v_sim.ElementAtomicShapeId

Retrieve the v_sim.ElementAtomicShapeId that self is using for representation.

New in version 3.8.

getUnits()¶

Returns:: a unit.
Return type:: v_sim.Units

The units in which the radius value is given.

New in version 3.8.

setElipsoidPhi(val)¶

Parameters:: val (float) – a float value.
Returns:: True if value is actually changed.
Return type:: bool

Change the phi angle of the representation for shapes that are not isotropic.

New in version 3.8.

setElipsoidRatio(val)¶

Parameters:: val (float) – a positive float value.
Returns:: True if value is actually changed.
Return type:: bool

Change the ratio between the long axe and the short axe of the representation for shapes that are not isotropic.

New in version 3.8.

setElipsoidTheta(val)¶

Parameters:: val (float) – a float value.
Returns:: True if value is actually changed.
Return type:: bool

Change the theta angle of the representation for shapes that are not isotropic.

New in version 3.8.

setRadius(val)¶

Parameters:: val (float) – a positive float value.
Returns:: True if value is actually changed.
Return type:: bool

Change the radius (or long axe) of the representation of self.

New in version 3.8.

setShape(val)¶

Parameters:: val (v_sim.ElementAtomicShapeId) – a v_sim.ElementAtomicShapeId value.
Returns:: True if value is actually changed.
Return type:: bool

Change the representation shape of self.

New in version 3.8.

setUnits(val)¶

Parameters:: val (v_sim.Units) – a v_sim.Units value.
Returns:: True if value is actually changed.
Return type:: bool

Change the unit in wich the radius is given, see v_sim.ElementAtomic.setRadius().

New in version 3.8.

Property Details¶

v_sim.ElementAtomic.props.elipsoid_angle_phi¶

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

Elipsoid angle phi

v_sim.ElementAtomic.props.elipsoid_angle_theta¶

Name:: elipsoid-angle-theta
Type:: float
Default Value:: 90.0
Flags:: READABLE, WRITABLE

Elipsoid angle theta

v_sim.ElementAtomic.props.elipsoid_ratio¶

Name:: elipsoid-ratio
Type:: float
Default Value:: 1.0
Flags:: READABLE, WRITABLE

Elipsoid ratio

v_sim.ElementAtomic.props.radius¶

Name:: radius
Type:: float
Default Value:: 1.0
Flags:: READABLE, WRITABLE

atomic radius

v_sim.ElementAtomic.props.shape¶

Name:: shape
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE

atomic shape

v_sim.ElementAtomic.props.units¶

Name:: units
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE

radius units