API¶
Work in progress
N.B. All of the following are available unprefixed after a from coldtype import *
, or are available at the specified prefix locations after an import coldtype
.
Textsetting Classes
|
Class for configuring font properties |
|
Lowest-level vectorized typesetting class |
|
For multiline text lockups |
The most important thing to understand is that textsetting classes can be turned into vector classes via the .pen
or .pens
methods available on both StyledString
and Composer
— .pen
gets you a single vector representation of a piece of text (aka a DATPen
), while .pens
gets you a structured list of DATPen’s, aka a DATPens
.
Geometry Classes
|
Representation of a point (x,y), indexable |
|
Representation of a rectangle as (x, y, w, h), indexable |
Vector/Path Classes
|
Main vector representation in Coldtype |
|
A set/collection of DATPen’s |
Rendering Decorators
|
Base class for any content renderable by Coldtype |
Base class for any frame-wise animation animatable by Coldtype |
Time/Timing Classes
|
Container for information about a frame |
|
Abstract base class for anything with a concept of start and end/duration |
|
General base class for any kind of timeline or sequence, in the NLE sense |
|
|
|
Construct for quickly developing animations based on loop |
|
Though available as a general-purpose function, this logic is usually accessed through something like the .progress function on an animation or timeable. |