Style

class tissue_forge.rendering.ColorMapper(*args)
property min_val

minimum value of map

property max_val

maximum value of map

property has_map_particle: bool
property has_map_angle: bool
property has_map_bond: bool
property has_map_dihedral: bool
clear_map_particle()

Clear the particle map

clear_map_angle()

Clear the angle map

clear_map_bond()

Clear the bond map

clear_map_dihedral()

Clear the dihedral map

set_map_particle_position_x()

Set the particle map to x-coordinate of particle position

set_map_particle_position_y()

Set the particle map to y-coordinate of particle position

set_map_particle_position_z()

Set the particle map to z-coordinate of particle position

set_map_particle_velocity_x()

Set the particle map to x-component of particle velocity

set_map_particle_velocity_y()

Set the particle map to y-component of particle velocity

set_map_particle_velocity_z()

Set the particle map to z-component of particle velocity

set_map_particle_speed()

Set the particle map to particle speed

set_map_particle_force_x()

Set the particle map to x-component of particle force

set_map_particle_force_y()

Set the particle map to y-component of particle force

set_map_particle_force_z()

Set the particle map to z-component of particle force

set_map_particle_species(pType, name)

Set the particle map to a species value

Parameters:
  • pType (ParticleType) – particle type

  • name (string) – species name

set_map_angle_angle()

Set the angle map to angle

set_map_angle_angle_eq()

Set the angle map to angle from equilibrium

set_map_bond_length()

Set the bond map to length

set_map_bond_length_eq()

Set the bond map to length from equilibrium

set_map_dihedral_angle()

Set the dihedral map to angle

set_map_dihedral_angle_eq()

Set the dihedral map to angle from equilibrium

class tissue_forge.rendering.Style(*args)

Construct a new style

Parameters:
  • color (string) – name of color

  • visible (boolean, optional) – visibility flag

  • flags (int, optional) – style flags

  • cmap (ColorMapper, optional) – color mapper

property color

Default color

property visible: bool

Visibility flag

property colormap: str

Name of color map

property mapper

Color mapper of this style

setColor(colorName)

Set the color by name

Parameters:

colorName (string) – name of color

Return type:

int

Returns:

HRESULT

toString()

Get a JSON string representation

Return type:

string

Returns:

std::string

static fromString(str)

Create from a JSON string representation.

Parameters:

str (string)

Return type:

Style

Returns:

Style*

__reduce__()

Helper for pickle.