Representation

Transition between cartoon, ribbon, ball-and-stick and surface, with optional nucleotide base styles.

View source Guide and examplesInherits Animation

from proteinmotion import Representation

Constructor

Representation(
    protein,
    representation,
    *,
    bases=None,
    rate_func=smooth,
    easing=None,
    **options,
)

Parameters

Parameter	Default	Description
`protein`	Required	Protein object to read or animate.
`representation`	Required	"cartoon", "ribbon", "ball_and_stick", or "surface".
`bases`keyword only	`None`	Nucleotide base style: slabs, rings, sticks, ladder, or none. None in Representation preserves the current style.
`rate_func`keyword only	`smooth`	Callable that maps progress in [0, 1] to a finite value in [0, 1].
`easing`keyword only	`None`	Named easing (smooth, linear, ease_in_out_sine, there_and_back) or callable mapping [0, 1] to [0, 1]. Per-item easing preserves stagger timing.
`**options`	—	Representation options such as kind, grid_spacing, atom_scale, bond_radius, color, or width. These are applied when the transition begins.

Example and output

This excerpt runs inside a scene’s construct() method. The full example file includes imports, structure loading, and camera setup. Run it from a repository checkout.

Code Scene excerpt

p = ubiquitin().surface(resolution=0.7).cartoon()
frame(self, p)
self.wait(1)
for name in ("ribbon", "ball_and_stick", "surface"):
    self.play(Representation(p, name), run_time=1.2)
    self.play(Rotate(p, 0.45), run_time=1.5)

Output Preview · 9.1 s · 60 fps

Representation changes

Cartoon, ribbon, ball-and-stick, and SES surface.

Full source: Representations Download MP4

Methods and properties

Name	Description
bind()method	Capture starting values when the scene schedules the animation.
apply()method	Evaluate the animation at eased progress alpha. Called by the timeline.
during()method · inherited from Animation	Set this animation duration and start delay in seconds.
targetsproperty · inherited from Animation	Objects whose state this animation changes.

bind()

View source

Representation.bind()

Capture starting values when the scene schedules the animation.

Returns: None

Called by ProteinScene.play(). An animation instance can be bound once.

apply()

View source

Representation.apply(alpha)

Evaluate the animation at eased progress alpha. Called by the timeline.

Parameter	Default	Description
`alpha`	Required	Eased animation progress in [0, 1].

Returns: None

during()

View source

Inherited from animation.Animation.

Representation.during(seconds, *, delay=0)

Set this animation duration and start delay in seconds.

Parameter	Default	Description
`seconds`	Required	Positive animation duration in seconds.
`delay`keyword only	`0`	Nonnegative animation start delay in seconds.

targets

View source

Inherited from animation.Animation.

Representation.targets

Objects whose state this animation changes.