v_sim.PairCylinder¶

Implementations:: v_sim.PairLink

Methods¶

class	`getDefaultColorType` ()
class	`getDefaultRadius` ()
class	`getDefaultRadiusType` ()
	`getColorType` ()
	`getRadius` ()
	`getRadiusType` ()
	`setColorType` (val)
	`setRadius` (val)
	`setRadiusType` (val)

Virtual Methods¶

	`do_get_colorType` ()
	`do_get_radius` ()
	`do_get_radiusType` ()
	`do_set_colorType` (val)
	`do_set_radius` (val)
	`do_set_radiusType` (val)

Properties¶

Name	Type	Flags	Short Description
`color-type`	`int`	r/w	cylinder color type
`radius`	`float`	r/w	cylinder radius
`radius-type`	`int`	r/w	cylinder radius type

Signals¶

None

Fields¶

None

Class Details¶

class v_sim.PairCylinder¶

Bases:: GObject.GInterface
Structure:: v_sim.PairCylinderInterface

Interface object.

New in version 3.8.

classmethod getDefaultColorType()¶

Returns:: an integer corresponding to the color scheme.
Return type:: v_sim.PairCylinderColorId

Get the color scheme.

classmethod getDefaultRadius()¶

Returns:: the default value for cylinder radius.
Return type:: float

Get the default value for cylinder radius.

classmethod getDefaultRadiusType()¶

Returns:: an integer corresponding to the radius scheme.
Return type:: v_sim.PairCylinderRadiusId

Get the radius scheme.

New in version 3.9.

getColorType()¶

Returns:: the color type value.
Return type:: v_sim.PairCylinderColorId

Get the color type value for the specified pair.

getRadius()¶

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

Get the radius value for the specified pair.

getRadiusType()¶

Returns:: the radius type value.
Return type:: v_sim.PairCylinderRadiusId

Get the radius type value for the specified pair.

New in version 3.9.

setColorType(val)¶

Parameters:: val (v_sim.PairCylinderColorId) – a integer that identify the color scheme.
Returns:: True if the value is changed.
Return type:: bool

It sets the color scheme for cylinder pairs.

setRadius(val)¶

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

This method allows to change the radius value of a specific pair. When a pair is rendered via a cylinder, it first checks if that pairs has a specific radius value set by this method. If not, it uses the default value.

setRadiusType(val)¶

Parameters:: val (v_sim.PairCylinderRadiusId) – a integer that identify the radius scheme.
Returns:: True if the value is changed.
Return type:: bool

It sets the radius scheme for cylinder pairs.

New in version 3.9.

do_get_colorType() virtual¶

Return type:: v_sim.PairCylinderColorId

a method to get the coloring scheme.

do_get_radius() virtual¶

Return type:: float

a method to get the radius.

do_get_radiusType() virtual¶

Return type:: v_sim.PairCylinderRadiusId

a method to get the radius scheme.

do_set_colorType(val) virtual¶

Parameters:: val (v_sim.PairCylinderColorId) –
Return type:: bool

a method to change the coloring scheme.

do_set_radius(val) virtual¶

Parameters:: val (float) –
Return type:: bool

a method to change the radius of drawn cylinder v_sim.PairLink.

do_set_radiusType(val) virtual¶

Parameters:: val (v_sim.PairCylinderRadiusId) –
Return type:: bool

a method to change the radius scheme.

Property Details¶

v_sim.PairCylinder.props.color_type¶

Name:: color-type
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE

cylinder color type

v_sim.PairCylinder.props.radius¶

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

cylinder radius

v_sim.PairCylinder.props.radius_type¶

Name:: radius-type
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE

cylinder radius type