glaxnimate
Constants:
name | type | value | docs |
---|---|---|---|
__version__ |
str |
'0.3.2' |
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 |
translate()
translate(self: glaxnimate.utils.bezier.Point, arg0: glaxnimate.utils.Point) -> None
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 |
clear()
clear(self: glaxnimate.utils.bezier.Bezier) -> None
insert_point()
insert_point(self: glaxnimate.utils.bezier.Bezier, arg0: int, arg1: glaxnimate.utils.bezier.Point) -> 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
add_smooth_point()
add_smooth_point(self: glaxnimate.utils.bezier.Bezier, arg0: glaxnimate.utils.Point, arg1: glaxnimate.utils.Point) -> glaxnimate.utils.bezier.Bezier
close()
close(self: 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
quadratic_to()
quadratic_to(self: glaxnimate.utils.bezier.Bezier, arg0: glaxnimate.utils.Point, arg1: glaxnimate.utils.Point) -> 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
reverse()
reverse(self: glaxnimate.utils.bezier.Bezier) -> None
bounding_box()
bounding_box(self: glaxnimate.utils.bezier.Bezier) -> glaxnimate.utils.Rect
split_segment()
split_segment(self: glaxnimate.utils.bezier.Bezier, arg0: int, arg1: float) -> None
split_segment_point()
split_segment_point(self: glaxnimate.utils.bezier.Bezier, arg0: int, arg1: float) -> glaxnimate.utils.bezier.Point
remove_point()
remove_point(self: glaxnimate.utils.bezier.Bezier, arg0: int) -> None
lerp()
lerp(self: glaxnimate.utils.bezier.Bezier, arg0: glaxnimate.utils.bezier.Bezier, arg1: float) -> glaxnimate.utils.bezier.Bezier
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 |
to_point()
to_point(self: glaxnimate.utils.Size) -> glaxnimate.utils.Point
glaxnimate.utils.IntSize
Properties:
name | type | notes | docs |
---|---|---|---|
width |
int |
||
height |
int |
to_point()
to_point(self: glaxnimate.utils.IntSize) -> glaxnimate.utils.Point
glaxnimate.utils.Vector2D
Properties:
name | type | notes | docs |
---|---|---|---|
x |
float |
||
y |
float |
normalize()
normalize(self: glaxnimate.utils.Vector2D) -> None
normalized()
normalized(self: glaxnimate.utils.Vector2D) -> glaxnimate.utils.Vector2D
to_point()
to_point(self: glaxnimate.utils.Vector2D) -> glaxnimate.utils.Point
length()
length(self: glaxnimate.utils.Vector2D) -> float
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.log
Logging utilities
info()
info(arg0: str) -> None
warning()
warning(arg0: str) -> None
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
Properties:
name | type | notes | docs |
---|---|---|---|
slug |
str |
Read only | |
name |
str |
Read only | |
mime_types |
List[str] |
Read only |
serialize()
serialize(self: glaxnimate.io.MimeSerializer, arg0: List[glaxnimate.model.DocumentNode]) -> bytes
glaxnimate.io.IoRegistry
importers()
importers(self: glaxnimate.io.IoRegistry) -> List[glaxnimate.io.ImportExport]
exporters()
exporters(self: glaxnimate.io.IoRegistry) -> List[glaxnimate.io.ImportExport]
from_extension()
from_extension(self: glaxnimate.io.IoRegistry, arg0: str) -> glaxnimate.io.ImportExport
from_filename()
from_filename(self: glaxnimate.io.IoRegistry, arg0: str) -> glaxnimate.io.ImportExport
from_slug()
from_slug(self: glaxnimate.io.IoRegistry, arg0: str) -> glaxnimate.io.ImportExport
serializers()
serializers(self: glaxnimate.io.IoRegistry) -> List[glaxnimate.io.MimeSerializer]
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 |
can_handle_extension()
Signature:
can_handle_extension(self, extension: str) -> bool
can_handle_filename()
Signature:
can_handle_filename(self, filename: str) -> bool
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
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
name_filter()
Signature:
name_filter(self) -> str
warning()
Signature:
warning(self, message: str) -> None
information()
Signature:
information(self, message: str) -> None
error()
Signature:
error(self, message: str) -> None
progress_max_changed()
progress_max_changed(self: glaxnimate.io.ImportExport, arg0: int) -> None
progress()
progress(self: glaxnimate.io.ImportExport, arg0: int) -> None
glaxnimate.io.GlaxnimateFormat
Base classes:
Constants:
name | type | value | docs |
---|---|---|---|
instance |
GlaxnimateFormat |
glaxnimate.io.IoFormat
Base classes:
glaxnimate.model.defs
glaxnimate.model.defs.Asset
Base classes:
Sub classes:
glaxnimate.model.defs.BrushStyle
Base classes:
Sub classes:
glaxnimate.model.defs.NamedColor
Base classes:
Properties:
name | type | notes | docs |
---|---|---|---|
color |
Color | Read only |
glaxnimate.model.defs.GradientColors
Base classes:
Properties:
name | type | notes | docs |
---|---|---|---|
colors |
List[Tuple[float , Color]] |
Read only |
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
remove_stop()
Signature:
remove_stop(self, index: int) -> None
glaxnimate.model.defs.Gradient.GradientType
Properties:
name | type | notes | docs |
---|---|---|---|
name |
str |
Read only |
Constants:
name | type | value | docs |
---|---|---|---|
Linear |
GradientType | 1 |
|
Radial |
GradientType | 2 |
glaxnimate.model.defs.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 |
radius()
Signature:
radius(self, t: FrameTime) -> float
glaxnimate.model.defs.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 |
refresh()
Signature:
refresh(self, rebuild_embedded: bool) -> None
embed()
Signature:
embed(self, embedded: bool) -> None
glaxnimate.model.defs.Precomposition
Base classes:
glaxnimate.model.defs.Defs
Base classes:
Properties:
name | type | notes | docs |
---|---|---|---|
colors |
List[NamedColor] | Read only | |
images |
List[Bitmap] | Read only | |
gradient_colors |
List[GradientColors] | Read only | |
gradients |
List[Gradient] | Read only | |
precompositions |
List[Precomposition] | Read only |
find_by_uuid()
Signature:
find_by_uuid(self, n: uuid.UUID) -> glaxnimate.model.ReferenceTarget
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
add_image_file()
Signature:
add_image_file(self, filename: str, embed: bool) -> glaxnimate.model.Bitmap
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
add_gradient_colors()
Signature:
add_gradient_colors(self, index: int) -> glaxnimate.model.GradientColors
add_gradient_colors(self) -> glaxnimate.model.GradientColors
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.PolyStar.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 |
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 |
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.Fill.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.Stroke.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.Stroke.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 |
glaxnimate.model
glaxnimate.model.Object
Sub classes:
glaxnimate.model.UndoMacroGuard
Context manager that creates undo macros
start()
start(self: glaxnimate.model.UndoMacroGuard) -> None
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 |
||
defs |
Object | Read only | |
size |
IntSize | Read only | |
rect |
Rect | Read only | |
metadata |
dict |
find_by_uuid()
Signature:
find_by_uuid(self, n: uuid.UUID) -> glaxnimate.model.ReferenceTarget
find_by_type_name()
Signature:
find_by_type_name(self, type_name: str) -> list
undo()
Signature:
undo(self) -> bool
redo()
Signature:
redo(self) -> bool
get_best_name()
Signature:
get_best_name(self, node: glaxnimate.model.DocumentNode, suggestion: str) -> str
get_best_name(self, node: glaxnimate.model.DocumentNode) -> str
set_best_name()
Signature:
set_best_name(self, node: glaxnimate.model.DocumentNode, suggestion: str) -> None
set_best_name(self, node: glaxnimate.model.DocumentNode) -> None
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
macro()
macro(self: glaxnimate.model.Document, arg0: str) -> glaxnimate.model.UndoMacroGuard
Context manager to group changes into a single undo command
glaxnimate.model.ReferenceTarget
Base classes:
Sub classes:
Properties:
name | type | notes | docs |
---|---|---|---|
uuid |
uuid.UUID |
Read only | |
name |
str |
glaxnimate.model.DocumentNode
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 |
find_by_type_name()
Signature:
find_by_type_name(self, type_name: str) -> list
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.Composition
Base classes:
Sub classes:
Properties:
name | type | notes | docs |
---|---|---|---|
shapes |
List[ShapeElement] | Read only |
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.KeyframeTransition.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 |
lerp_factor()
lerp_factor(self: glaxnimate.model.KeyframeTransition, arg0: float) -> float
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:
- AnimatedProperty
- AnimatedProperty
- AnimatedProperty
- AnimatedProperty
- AnimatedProperty
- AnimatedProperty
>> - AnimatedPropertyBezier
Properties:
name | type | notes | docs |
---|---|---|---|
keyframe_count |
int |
Read only | |
value |
<type> |
||
animated |
bool |
Read only |
value_mismatch()
Signature:
value_mismatch(self) -> bool
keyframe_index()
Signature:
keyframe_index(self, time: FrameTime) -> int
keyframe()
keyframe(self: glaxnimate.model.glaxnimate.model.AnimatableBase, time: float) -> glaxnimate.model.Keyframe
set_keyframe()
set_keyframe(self: glaxnimate.model.glaxnimate.model.AnimatableBase, time: float, value: <type>) -> glaxnimate.model.Keyframe
remove_keyframe_at_time()
remove_keyframe_at_time(self: glaxnimate.model.glaxnimate.model.AnimatableBase, time: float) -> None
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
on_visit_document()
on_visit_document(self: glaxnimate.model.Visitor, arg0: glaxnimate.model.Document) -> None
on_visit_node()
on_visit_node(self: glaxnimate.model.Visitor, arg0: glaxnimate.model.DocumentNode) -> None