glaxnimate

Constants:

name type value docs
__version__ str '0.4.2-30-g8224d0e'

glaxnimate.utils

glaxnimate.utils.Color

Properties:

name type notes docs
red int Red component between 0 and 255
green int Green component between 0 and 255
blue int Blue component between 0 and 255
alpha int Transparency component between 0 and 255
name str
hue int
saturation int
value int

Constants:

name type value docs
from_hsv staticmethod

glaxnimate.utils.Point

Properties:

name type notes docs
x float
y float
length float Read only

glaxnimate.utils.Size

Properties:

name type notes docs
width float
height float

glaxnimate.utils.Size.to_point()

to_point(self: glaxnimate.utils.Size) -> glaxnimate.utils.Point

glaxnimate.utils.IntSize

Properties:

name type notes docs
width int
height int

glaxnimate.utils.IntSize.to_point()

to_point(self: glaxnimate.utils.IntSize) -> glaxnimate.utils.Point

glaxnimate.utils.Vector2D

Properties:

name type notes docs
x float
y float

glaxnimate.utils.Vector2D.normalize()

normalize(self: glaxnimate.utils.Vector2D) -> None

glaxnimate.utils.Vector2D.normalized()

normalized(self: glaxnimate.utils.Vector2D) -> glaxnimate.utils.Vector2D

glaxnimate.utils.Vector2D.to_point()

to_point(self: glaxnimate.utils.Vector2D) -> glaxnimate.utils.Point

glaxnimate.utils.Vector2D.length()

length(self: glaxnimate.utils.Vector2D) -> float

glaxnimate.utils.Vector2D.length_squared()

length_squared(self: glaxnimate.utils.Vector2D) -> float

glaxnimate.utils.Rect

Properties:

name type notes docs
left float
right float
top float
bottom float
center Point
top_left Point
top_right Point
bottom_right Point
bottom_left Point
size Size

glaxnimate.utils.bezier

glaxnimate.utils.bezier.PointType

Properties:

name type notes docs
name str Read only

Constants:

name type value docs
Corner PointType 0
Smooth PointType 1
Symmetrical PointType 2

glaxnimate.utils.bezier.Point

Properties:

name type notes docs
pos Point
tan_in Point
tan_out Point
type PointType

glaxnimate.utils.bezier.Point.translate()

translate(self: glaxnimate.utils.bezier.Point, arg0: glaxnimate.utils.Point) -> None

glaxnimate.utils.bezier.Point.translate_to()

translate_to(self: glaxnimate.utils.bezier.Point, arg0: glaxnimate.utils.Point) -> None

glaxnimate.utils.bezier.Bezier

Properties:

name type notes docs
empty bool Read only
closed bool

glaxnimate.utils.bezier.Bezier.clear()

clear(self: glaxnimate.utils.bezier.Bezier) -> None

glaxnimate.utils.bezier.Bezier.insert_point()

insert_point(self: glaxnimate.utils.bezier.Bezier, arg0: int, arg1: glaxnimate.utils.bezier.Point) -> glaxnimate.utils.bezier.Bezier

glaxnimate.utils.bezier.Bezier.add_point()

add_point(self: glaxnimate.utils.bezier.Bezier, arg0: glaxnimate.utils.Point, arg1: glaxnimate.utils.Point, arg2: glaxnimate.utils.Point) -> glaxnimate.utils.bezier.Bezier

glaxnimate.utils.bezier.Bezier.add_smooth_point()

add_smooth_point(self: glaxnimate.utils.bezier.Bezier, arg0: glaxnimate.utils.Point, arg1: glaxnimate.utils.Point) -> glaxnimate.utils.bezier.Bezier

glaxnimate.utils.bezier.Bezier.close()

close(self: glaxnimate.utils.bezier.Bezier) -> glaxnimate.utils.bezier.Bezier

glaxnimate.utils.bezier.Bezier.line_to()

line_to(self: glaxnimate.utils.bezier.Bezier, arg0: glaxnimate.utils.Point) -> glaxnimate.utils.bezier.Bezier

glaxnimate.utils.bezier.Bezier.quadratic_to()

quadratic_to(self: glaxnimate.utils.bezier.Bezier, arg0: glaxnimate.utils.Point, arg1: glaxnimate.utils.Point) -> glaxnimate.utils.bezier.Bezier

glaxnimate.utils.bezier.Bezier.cubic_to()

cubic_to(self: glaxnimate.utils.bezier.Bezier, arg0: glaxnimate.utils.Point, arg1: glaxnimate.utils.Point, arg2: glaxnimate.utils.Point) -> glaxnimate.utils.bezier.Bezier

glaxnimate.utils.bezier.Bezier.reverse()

reverse(self: glaxnimate.utils.bezier.Bezier) -> None

glaxnimate.utils.bezier.Bezier.bounding_box()

bounding_box(self: glaxnimate.utils.bezier.Bezier) -> glaxnimate.utils.Rect

glaxnimate.utils.bezier.Bezier.split_segment()

split_segment(self: glaxnimate.utils.bezier.Bezier, arg0: int, arg1: float) -> None

glaxnimate.utils.bezier.Bezier.split_segment_point()

split_segment_point(self: glaxnimate.utils.bezier.Bezier, arg0: int, arg1: float) -> glaxnimate.utils.bezier.Point

glaxnimate.utils.bezier.Bezier.remove_point()

remove_point(self: glaxnimate.utils.bezier.Bezier, arg0: int) -> None

glaxnimate.utils.bezier.Bezier.lerp()

lerp(self: glaxnimate.utils.bezier.Bezier, arg0: glaxnimate.utils.bezier.Bezier, arg1: float) -> glaxnimate.utils.bezier.Bezier

glaxnimate.utils.trace

Bitmap tracing functionality

glaxnimate.utils.trace.TraceOptions

Properties:

name type notes docs
smoothness float
min_area int

glaxnimate.utils.trace.Tracer

Properties:

name type notes docs
potrace_version str Read only

glaxnimate.utils.trace.Tracer.set_target_alpha()

set_target_alpha(self: glaxnimate.utils.trace.Tracer, threshold: int, invert: bool) -> None

glaxnimate.utils.trace.Tracer.set_target_color()

set_target_color(self: glaxnimate.utils.trace.Tracer, threshold: glaxnimate.utils.Color, invert: int) -> None

glaxnimate.utils.trace.Tracer.trace()

trace(self: glaxnimate.utils.trace.Tracer) -> glaxnimate.math.bezier::MultiBezier

glaxnimate.utils.quantize

Bitmap color quantization

glaxnimate.utils.quantize.color_frequencies()

color_frequencies(image: QImage, alpha_threshold: int = 128) -> List[Tuple[int, int]]

Counts pixel values and returns a list of (rgba, count) pairs.

glaxnimate.utils.quantize.k_modes()

k_modes(image: QImage, k: int) -> List[int]

Returns the k colors that appear most frequently in image.

glaxnimate.log

Logging utilities

glaxnimate.log.info()

info(arg0: str) -> None

glaxnimate.log.warning()

warning(arg0: str) -> None

glaxnimate.log.error()

error(arg0: str) -> None

glaxnimate.environment

glaxnimate.environment.Headless

Context manager that initializes a headless environment

glaxnimate.io

Input/Output utilities

Constants:

name type value docs
registry IoRegistry

glaxnimate.io.MimeSerializer

Sub classes:

Properties:

name type notes docs
slug str Read only
name str Read only
mime_types List[str] Read only

glaxnimate.io.MimeSerializer.serialize()

serialize(self: glaxnimate.io.MimeSerializer, arg0: List[glaxnimate.model.DocumentNode]) -> bytes

glaxnimate.io.RasterMime

Base classes:

Constants:

name type value docs
render_frame staticmethod

glaxnimate.io.IoRegistry

glaxnimate.io.IoRegistry.importers()

importers(self: glaxnimate.io.IoRegistry) -> List[glaxnimate.io.ImportExport]

glaxnimate.io.IoRegistry.exporters()

exporters(self: glaxnimate.io.IoRegistry) -> List[glaxnimate.io.ImportExport]

glaxnimate.io.IoRegistry.from_extension()

from_extension(self: glaxnimate.io.IoRegistry, arg0: str) -> glaxnimate.io.ImportExport

glaxnimate.io.IoRegistry.from_filename()

from_filename(self: glaxnimate.io.IoRegistry, arg0: str) -> glaxnimate.io.ImportExport

glaxnimate.io.IoRegistry.from_slug()

from_slug(self: glaxnimate.io.IoRegistry, arg0: str) -> glaxnimate.io.ImportExport

glaxnimate.io.IoRegistry.serializers()

serializers(self: glaxnimate.io.IoRegistry) -> List[glaxnimate.io.MimeSerializer]

glaxnimate.io.IoRegistry.serializer_from_slug()

serializer_from_slug(self: glaxnimate.io.IoRegistry, arg0: str) -> glaxnimate.io.MimeSerializer

glaxnimate.io.ImportExport

Sub classes:

Properties:

name type notes docs
name str Read only
slug str Read only
extensions List[str] Read only
can_open bool Read only
can_save bool Read only

glaxnimate.io.ImportExport.can_handle_extension()

Signature:

can_handle_extension(self, extension: str) -> bool

glaxnimate.io.ImportExport.can_handle_filename()

Signature:

can_handle_filename(self, filename: str) -> bool

glaxnimate.io.ImportExport.save()

Signature:

save(self, document: glaxnimate.model.Document, setting_values: dict, filename: str) -> bytes
save(self, document: glaxnimate.model.Document, setting_values: dict) -> bytes
save(self, document: glaxnimate.model.Document) -> bytes

glaxnimate.io.ImportExport.load()

Signature:

load(self, document: glaxnimate.model.Document, data: bytes, setting_values: dict, filename: str) -> bool
load(self, document: glaxnimate.model.Document, data: bytes, setting_values: dict) -> bool
load(self, document: glaxnimate.model.Document, data: bytes) -> bool

glaxnimate.io.ImportExport.name_filter()

Signature:

name_filter(self) -> str

glaxnimate.io.ImportExport.warning()

Signature:

warning(self, message: str) -> None

glaxnimate.io.ImportExport.information()

Signature:

information(self, message: str) -> None

glaxnimate.io.ImportExport.error()

Signature:

error(self, message: str) -> None

glaxnimate.io.ImportExport.progress_max_changed()

progress_max_changed(self: glaxnimate.io.ImportExport, arg0: int) -> None

glaxnimate.io.ImportExport.progress()

progress(self: glaxnimate.io.ImportExport, arg0: int) -> None

glaxnimate.io.GlaxnimateFormat

Base classes:

Constants:

name type value docs
instance GlaxnimateFormat

glaxnimate.io.RasterFormat

Base classes:

Constants:

name type value docs
render_frame staticmethod

glaxnimate.io.SvgFormat

Base classes:

Constants:

name type value docs
render_frame staticmethod

glaxnimate.io.IoFormat

Base classes:

glaxnimate.model

glaxnimate.model.Object

Sub classes:

glaxnimate.model.UndoMacroGuard

Context manager that creates undo macros

glaxnimate.model.UndoMacroGuard.start()

start(self: glaxnimate.model.UndoMacroGuard) -> None

glaxnimate.model.UndoMacroGuard.finish()

finish(self: glaxnimate.model.UndoMacroGuard) -> None

glaxnimate.model.Document

Properties:

name type notes docs
filename str Read only
main MainComposition Read only
current_time float
record_to_keyframe bool
assets Object Read only
size IntSize Read only
rect Rect Read only
metadata dict

glaxnimate.model.Document.find_by_uuid()

Signature:

find_by_uuid(self, n: uuid.UUID) -> glaxnimate.model.DocumentNode

glaxnimate.model.Document.find_by_name()

Signature:

find_by_name(self, name: str) -> glaxnimate.model.DocumentNode

glaxnimate.model.Document.find_by_type_name()

Signature:

find_by_type_name(self, type_name: str) -> list

glaxnimate.model.Document.undo()

Signature:

undo(self) -> bool

glaxnimate.model.Document.redo()

Signature:

redo(self) -> bool

glaxnimate.model.Document.get_best_name()

Signature:

get_best_name(self, node: glaxnimate.model.DocumentNode, suggestion: str) -> str
get_best_name(self, node: glaxnimate.model.DocumentNode) -> str

glaxnimate.model.Document.set_best_name()

Signature:

set_best_name(self, node: glaxnimate.model.DocumentNode, suggestion: str) -> None
set_best_name(self, node: glaxnimate.model.DocumentNode) -> None

glaxnimate.model.Document.render_image()

Signature:

render_image(self, time: float, size: glaxnimate.utils.IntSize, background: glaxnimate.utils.Color) -> PIL.Image.Image
render_image(self, time: float, size: glaxnimate.utils.IntSize) -> PIL.Image.Image
render_image(self, time: float) -> PIL.Image.Image
render_image(self) -> PIL.Image.Image

glaxnimate.model.Document.macro()

macro(self: glaxnimate.model.Document, arg0: str) -> glaxnimate.model.UndoMacroGuard

Context manager to group changes into a single undo command

glaxnimate.model.DocumentNode

Base classes:

Sub classes:

Properties:

name type notes docs
uuid uuid.UUID Read only
name str

glaxnimate.model.DocumentNode.find_by_name()

Signature:

find_by_name(self, name: str) -> glaxnimate.model.DocumentNode

glaxnimate.model.DocumentNode.find_by_uuid()

Signature:

find_by_uuid(self, uuid: uuid.UUID) -> glaxnimate.model.DocumentNode

glaxnimate.model.DocumentNode.find_by_type_name()

Signature:

find_by_type_name(self, type_name: str) -> list

glaxnimate.model.VisualNode

Base classes:

Sub classes:

Properties:

name type notes docs
group_color Color
visible bool
locked bool
visible_recursive bool Read only
locked_recursive bool Read only
selectable bool Read only

glaxnimate.model.AnimationContainer

Base classes:

Properties:

name type notes docs
first_frame float
last_frame float
time_visible bool Read only
duration float Read only

glaxnimate.model.StretchableTime

Base classes:

Properties:

name type notes docs
start_time float
stretch float

glaxnimate.model.Transform

Base classes:

Properties:

name type notes docs
anchor_point Point Read only
position Point Read only
scale Vector2D Read only
rotation float Read only

glaxnimate.model.MaskSettings

Base classes:

Properties:

name type notes docs
mask bool

glaxnimate.model.Composition

Base classes:

Sub classes:

Properties:

name type notes docs
shapes List[ShapeElement] Read only

glaxnimate.model.Composition.add_shape()

add_shape(self: glaxnimate.model.Composition, type_name: str, index: int = -1) -> glaxnimate.model.ShapeElement

Adds a shape from its class name

glaxnimate.model.MainComposition

Base classes:

Properties:

name type notes docs
animation AnimationContainer Read only
fps float
width int
height int

glaxnimate.model.Descriptive

Properties:

name type notes docs
name str Read only

Constants:

name type value docs
Hold Descriptive 0
Linear Descriptive 1
Ease Descriptive 2
Custom Descriptive 3

glaxnimate.model.KeyframeTransition

Properties:

name type notes docs
hold bool
before Point
after Point
before_descriptive Descriptive
after_descriptive Descriptive

glaxnimate.model.KeyframeTransition.lerp_factor()

lerp_factor(self: glaxnimate.model.KeyframeTransition, arg0: float) -> float

glaxnimate.model.KeyframeTransition.bezier_parameter()

bezier_parameter(self: glaxnimate.model.KeyframeTransition, arg0: float) -> float

glaxnimate.model.Keyframe

Properties:

name type notes docs
time float Read only
value <type> Read only
transition KeyframeTransition

glaxnimate.model.AnimatableBase

Sub classes:

Properties:

name type notes docs
keyframe_count int Read only
value <type>
animated bool Read only

glaxnimate.model.AnimatableBase.value_mismatch()

Signature:

value_mismatch(self) -> bool

glaxnimate.model.AnimatableBase.keyframe_index()

Signature:

keyframe_index(self, time: FrameTime) -> int

glaxnimate.model.AnimatableBase.keyframe()

keyframe(self: glaxnimate.model.glaxnimate.model.AnimatableBase, time: float) -> glaxnimate.model.Keyframe

glaxnimate.model.AnimatableBase.set_keyframe()

set_keyframe(self: glaxnimate.model.glaxnimate.model.AnimatableBase, time: float, value: <type>) -> glaxnimate.model.Keyframe

glaxnimate.model.AnimatableBase.remove_keyframe_at_time()

remove_keyframe_at_time(self: glaxnimate.model.glaxnimate.model.AnimatableBase, time: float) -> None

glaxnimate.model.Visitor

glaxnimate.model.Visitor.visit()

visit(*args, **kwargs)

Overloaded function.

visit(self: glaxnimate.model.Visitor, document: glaxnimate.model.Document, skip_locked: bool) -> None

visit(self: glaxnimate.model.Visitor, node: glaxnimate.model.DocumentNode, skip_locked: bool) -> None

glaxnimate.model.Visitor.on_visit_document()

on_visit_document(self: glaxnimate.model.Visitor, arg0: glaxnimate.model.Document) -> None

glaxnimate.model.Visitor.on_visit_node()

on_visit_node(self: glaxnimate.model.Visitor, arg0: glaxnimate.model.DocumentNode) -> None

glaxnimate.model.assets

glaxnimate.model.assets.AssetBase

Sub classes:

Properties:

name type notes docs
users Set[ReferencePropertyBase] Read only

glaxnimate.model.assets.Asset

Base classes:

Sub classes:

glaxnimate.model.assets.BrushStyle

Base classes:

Sub classes:

glaxnimate.model.assets.NamedColor

Base classes:

Properties:

name type notes docs
color Color Read only

glaxnimate.model.assets.GradientColors

Base classes:

Properties:

name type notes docs
colors List[Tuple[float, Color]] Read only

glaxnimate.model.assets.GradientColors.split_segment()

Signature:

split_segment(self, segment_index: int, factor: float, new_color: glaxnimate.utils.Color) -> None
split_segment(self, segment_index: int, factor: float) -> None
split_segment(self, segment_index: int) -> None

glaxnimate.model.assets.GradientColors.remove_stop()

Signature:

remove_stop(self, index: int) -> None

glaxnimate.model.assets.GradientType

Properties:

name type notes docs
name str Read only

Constants:

name type value docs
Linear GradientType 1
Radial GradientType 2

glaxnimate.model.assets.Gradient

Base classes:

Properties:

name type notes docs
colors GradientColors Reference
type GradientType
start_point Point Read only
end_point Point Read only
highlight Point Read only

glaxnimate.model.assets.Gradient.radius()

Signature:

radius(self, t: FrameTime) -> float

glaxnimate.model.assets.Bitmap

Base classes:

Properties:

name type notes docs
data bytes
filename str
format str Read only
width int Read only
height int Read only
embedded bool
image PIL.Image.Image Read only

glaxnimate.model.assets.Bitmap.refresh()

Signature:

refresh(self, rebuild_embedded: bool) -> None

glaxnimate.model.assets.Bitmap.embed()

Signature:

embed(self, embedded: bool) -> None

glaxnimate.model.assets.Precomposition

Base classes:

glaxnimate.model.assets.BitmapList

Base classes:

Properties:

name type notes docs
values List[Bitmap] Read only

glaxnimate.model.assets.NamedColorList

Base classes:

Properties:

name type notes docs
values List[NamedColor] Read only

glaxnimate.model.assets.GradientList

Base classes:

Properties:

name type notes docs
values List[Gradient] Read only

glaxnimate.model.assets.GradientColorsList

Base classes:

Properties:

name type notes docs
values List[GradientColors] Read only

glaxnimate.model.assets.PrecompositionList

Base classes:

Properties:

name type notes docs
values List[Precomposition] Read only

glaxnimate.model.assets.Assets

Base classes:

Properties:

name type notes docs
colors NamedColorList Read only
images BitmapList Read only
gradient_colors GradientColorsList Read only
gradients GradientList Read only
precompositions PrecompositionList Read only

glaxnimate.model.assets.Assets.add_color()

Signature:

add_color(self, color: glaxnimate.utils.Color, name: str) -> glaxnimate.model.NamedColor
add_color(self, color: glaxnimate.utils.Color) -> glaxnimate.model.NamedColor

glaxnimate.model.assets.Assets.add_image_file()

Signature:

add_image_file(self, filename: str, embed: bool) -> glaxnimate.model.Bitmap

glaxnimate.model.assets.Assets.add_image()

Signature:

add_image(self, image: PIL.Image.Image, store_as: str) -> glaxnimate.model.Bitmap
add_image(self, image: PIL.Image.Image) -> glaxnimate.model.Bitmap

glaxnimate.model.assets.Assets.add_gradient_colors()

Signature:

add_gradient_colors(self, index: int) -> glaxnimate.model.GradientColors
add_gradient_colors(self) -> glaxnimate.model.GradientColors

glaxnimate.model.assets.Assets.add_gradient()

Signature:

add_gradient(self, index: int) -> glaxnimate.model.Gradient
add_gradient(self) -> glaxnimate.model.Gradient

glaxnimate.model.shapes

glaxnimate.model.shapes.ShapeElement

Base classes:

Sub classes:

glaxnimate.model.shapes.Shape

Base classes:

Sub classes:

glaxnimate.model.shapes.Modifier

Base classes:

glaxnimate.model.shapes.Styler

Base classes:

Sub classes:

Properties:

name type notes docs
color Color Read only
opacity float Read only
use BrushStyle Reference

glaxnimate.model.shapes.Rect

Base classes:

Properties:

name type notes docs
position Point Read only
size Size Read only
rounded float Read only

glaxnimate.model.shapes.Ellipse

Base classes:

Properties:

name type notes docs
position Point Read only
size Size Read only

glaxnimate.model.shapes.StarType

Properties:

name type notes docs
name str Read only

Constants:

name type value docs
Star StarType 1
Polygon StarType 2

glaxnimate.model.shapes.PolyStar

Base classes:

Properties:

name type notes docs
type StarType
position Point Read only
outer_radius float Read only
inner_radius float Read only
angle float Read only
points int Read only

glaxnimate.model.shapes.Path

Base classes:

Properties:

name type notes docs
shape Bezier Read only
closed bool

glaxnimate.model.shapes.Group

Base classes:

Sub classes:

Properties:

name type notes docs
shapes List[ShapeElement] Read only
transform Transform Read only
opacity float Read only

glaxnimate.model.shapes.Group.add_shape()

add_shape(self: glaxnimate.model.shapes.Group, type_name: str, index: int = -1) -> glaxnimate.model.shapes.ShapeElement

Adds a shape from its class name

glaxnimate.model.shapes.Layer

Base classes:

Properties:

name type notes docs
animation AnimationContainer Read only
parent Layer Reference
render bool
mask MaskSettings Read only

glaxnimate.model.shapes.PreCompLayer

Base classes:

Properties:

name type notes docs
timing StretchableTime Read only
composition Precomposition Reference
size Size
transform Transform Read only
opacity float Read only

glaxnimate.model.shapes.Rule

Properties:

name type notes docs
name str Read only

Constants:

name type value docs
NonZero Rule 1
EvenOdd Rule 0

glaxnimate.model.shapes.Fill

Base classes:

Properties:

name type notes docs
fill_rule Rule

glaxnimate.model.shapes.Cap

Properties:

name type notes docs
name str Read only

Constants:

name type value docs
ButtCap Cap 0
RoundCap Cap 32
SquareCap Cap 16

glaxnimate.model.shapes.Join

Properties:

name type notes docs
name str Read only

Constants:

name type value docs
MiterJoin Join 0
RoundJoin Join 128
BevelJoin Join 64

glaxnimate.model.shapes.Stroke

Base classes:

Properties:

name type notes docs
width float Read only
cap Cap
join Join
miter_limit float

glaxnimate.model.shapes.Image

Base classes:

Properties:

name type notes docs
transform Transform Read only
image Bitmap Reference