bloqade.visual.animation.base.RowRegionGateArtist

← Module overview

classRowRegionGateArtist¶source

bloqade.visual.animation.base.RowRegionGateArtist

Bases: GateArtist

A row region gate artist object.

Signature

class RowRegionGateArtist(mpl_ax: Any, xmin, width, ymin, ymin_keepout, ymax, ymax_keepout, color)

bound box is [y_origin - width/2, y_origin + width/2]

Parameters

Name	Type	Description
mpl_ax	Any
xmin	—
width	—
ymin	—
ymin_keepout	—
ymax	—
ymax_keepout	—
color	—

Attributes

Name	Type	Default	Description
mpl_obj	mpatches.Rectangle	rc
mpl_obj_keepout_top	mpatches.Rectangle	rc_top
mpl_obj_keepout_btm	mpatches.Rectangle	rc_btm
width	float	width
xmin	float	xmin

methodclear_data¶source

bloqade.visual.animation.base.RowRegionGateArtist.clear_data

def clear_data() -> None

source

methodget_artists¶source

bloqade.visual.animation.base.RowRegionGateArtist.get_artists

def get_artists() -> Tuple[Any, ...]

Returns

Tuple[Any, ...]

source

methodupdate_data¶source

bloqade.visual.animation.base.RowRegionGateArtist.update_data

def update_data(ymin, ymax, ymin_keepout, ymax_keepout)

Parameters

Name	Type	Description
ymin	—
ymax	—
ymin_keepout	—
ymax_keepout	—

source

methodset_visible¶source

bloqade.visual.animation.base.RowRegionGateArtist.set_visible

def set_visible(visible: bool)

Parameters

Name	Type	Description
visible	bool

source