python-lottie  0.6.8+dev6bb61be
A framework to work with lottie files and telegram animated stickers (tgs)
lottie.objects.properties.OffsetKeyframe Class Reference

Keyframe for MultiDimensional values. More...

Inheritance diagram for lottie.objects.properties.OffsetKeyframe:
[legend]
Collaboration diagram for lottie.objects.properties.OffsetKeyframe:
[legend]

Public Member Functions

def __init__ (self, time=0, start=None, end=None, easing_function=None, in_tan=None, out_tan=None)
 
def interpolated_value (self, ratio, next_start=None)
 
def interpolated_tangent_angle (self, ratio, next_start=None)
 
def __repr__ (self)
 
- Public Member Functions inherited from lottie.objects.properties.Keyframe
def __init__ (self, time=0, easing_function=None)
 
def bezier (self)
 
def lerp_factor (self, ratio)
 
def __str__ (self)
 
- Public Member Functions inherited from lottie.objects.base.LottieObject
def to_dict (self)
 Serializes into a JSON object fit for the Lottie format. More...
 
def load (cls, lottiedict)
 Loads from a JSON object. More...
 
def find (self, search, propname="name")
 Recursively searches for child objects with a matching property. More...
 
def find_all (self, type, predicate=None, include_self=True)
 Find all child objects that match a predicate. More...
 
def clone (self)
 Returns a copy of the object. More...
 
- Public Member Functions inherited from lottie.objects.base.LottieObjectMeta
def __new__ (cls, name, bases, attr)
 

Public Attributes

 start
 Start value of keyframe segment. More...
 
 end
 End value of keyframe segment. More...
 
 in_tan
 In Spatial Tangent. More...
 
 out_tan
 Out Spatial Tangent. More...
 
- Public Attributes inherited from lottie.objects.properties.Keyframe
 time
 Start time of keyframe segment. More...
 
 in_value
 Bezier curve easing in value. More...
 
 out_value
 Bezier curve easing out value. More...
 
 jump
 Jump to the end value. More...
 

Detailed Description

Keyframe for MultiDimensional values.

Bezier easing

Imagine a quadratic bezier, with starting point at (0, 0) and end point at (1, 1).

out_value and in_value are the other two handles for a quadratic bezier, expressed as absoulte values in this 0-1 space.

See also https://cubic-bezier.com/

Lottie JSON
Lottie name Type Description Attribute
t float Start time of keyframe segment.   time
i KeyframeBezierHandle Bezier curve easing in value.   in_value
o KeyframeBezierHandle Bezier curve easing out value.   out_value
h 0-1 int Jump to the end value.   jump
s NVector Start value of keyframe segment.   start
e NVector End value of keyframe segment.   end
ti NVector In Spatial Tangent.   in_tan
to NVector Out Spatial Tangent.   out_tan

Definition at line 160 of file properties.py.

Constructor & Destructor Documentation

◆ __init__()

def lottie.objects.properties.OffsetKeyframe.__init__ (   self,
  time = 0,
  start = None,
  end = None,
  easing_function = None,
  in_tan = None,
  out_tan = None 
)

Definition at line 181 of file properties.py.

Member Function Documentation

◆ __repr__()

def lottie.objects.properties.OffsetKeyframe.__repr__ (   self)

Definition at line 221 of file properties.py.

◆ interpolated_tangent_angle()

def lottie.objects.properties.OffsetKeyframe.interpolated_tangent_angle (   self,
  ratio,
  next_start = None 
)

Definition at line 211 of file properties.py.

◆ interpolated_value()

def lottie.objects.properties.OffsetKeyframe.interpolated_value (   self,
  ratio,
  next_start = None 
)

Definition at line 192 of file properties.py.

Member Data Documentation

◆ end

lottie.objects.properties.OffsetKeyframe.end

End value of keyframe segment.

Definition at line 186 of file properties.py.

◆ in_tan

lottie.objects.properties.OffsetKeyframe.in_tan

In Spatial Tangent.

Only for spatial properties. (for bezier smoothing on position)

Definition at line 188 of file properties.py.

◆ out_tan

lottie.objects.properties.OffsetKeyframe.out_tan

Out Spatial Tangent.

Only for spatial properties. (for bezier smoothing on position)

Definition at line 190 of file properties.py.

◆ start

lottie.objects.properties.OffsetKeyframe.start

Start value of keyframe segment.

Definition at line 184 of file properties.py.


The documentation for this class was generated from the following file: