Reference navigation
On this page
RegionAnimate
Create styling animations through region.animate.
from proteinmotion.styling import RegionAnimateConstructor
RegionAnimate(region)Parameters
| Parameter | Default | Description |
|---|---|---|
region | Required | Region selection attached to a protein. |
Notes
set_color() returns Colorize; set_opacity() returns SetOpacity. Their keyword options include residue_delay, reverse, and easing.
Methods and properties
| Name | Description |
|---|---|
| set_color()method | Apply a tint across all representations. None restores the base palette. |
| set_opacity()method | Set or animate opacity in [0, 1]. |
| show_atoms()method | Show ball-and-stick detail over the active representation. Chained animations may also change color, opacity, or transforms. |
| hide_atoms()method | Hide ball-and-stick detail while retaining the active representation. |
RegionAnimate.set_color(color, **kwargs)Apply a tint across all representations. None restores the base palette.
| Parameter | Default | Description |
|---|---|---|
color | Required | Hex color or RGB values. For tint setters, None restores the representation’s base palette. |
**kwargs | — | Additional keyword options described below or in the linked constructor. |
Returns: The object or a Colorize animation.
RegionAnimate.set_opacity(opacity, **kwargs)Set or animate opacity in [0, 1].
| Parameter | Default | Description |
|---|---|---|
opacity | Required | Opacity in [0, 1], from transparent to opaque. |
**kwargs | — | Additional keyword options described below or in the linked constructor. |
Returns: The object or animation builder.
RegionAnimate.show_atoms(**kwargs)Show ball-and-stick detail over the active representation. Chained animations may also change color, opacity, or transforms.
| Parameter | Default | Description |
|---|---|---|
**kwargs | — | Additional keyword options described below or in the linked constructor. |
RegionAnimate.hide_atoms(**kwargs)Hide ball-and-stick detail while retaining the active representation.
| Parameter | Default | Description |
|---|---|---|
**kwargs | — | Additional keyword options described below or in the linked constructor. |