StopMotionAnimation#

class vivid3d.StopMotionAnimation#

Bases: vivid3d._core.Animation

Stop motion animation class, inherits from vivid3d.animation but present the models frame after frame

frames#

List of frames held, each model holds his own animation.

Type

list[vivid3d.Frame]

seconds_per_frame#

How long should each frame last

Type

float

ticks_per_second#

ticks per second

Type

float

add_model(self: vivid3d._core.Animation, model: vivid3d._core.Model) None#

Add a model to the animation.

Parameters

model (vivid3d.Model,) – model to add

add_models(self: vivid3d._core.Animation, models: List[vivid3d._core.Model]) None#

Add a list of models to the animation.

Parameters

models (list[vivid3d.Model],) – models to add

export(self: vivid3d._core.Animation, output_file: str, file_format: str = 'glb') None#

Exports Animation to output_file with given file_type format. For full list of supported file formats, see: https://vivid.readthedocs.io/en/latest/userguide/basics.html#supported-file-types

Parameters
  • output_file (str, default: "Vivid3dModel") – File Directory to export to

  • file_type (str, default: 'glb') – File format to export to

export_to_blob(self: vivid3d._core.Animation, file_type: str = 'glb') vivid3d._core.BlobData#

Exports Animation to Blob with given file_type format. For full list of supported file formats, see: https://vivid.readthedocs.io/en/latest/userguide/basics.html#supported-file-types

Parameters

file_type (str, default: 'glb') – File format to export to

Returns

blob (vivid3d.BlobData) – Object containing exported model file blobs

show(self: vivid3d._core.Animation, height: int = 600) object#

Render and view the model in a viewer window.

Parameters

height (int, default: 600) – height in pixels to open the viewer

Returns

html (str or IPython.display.HTML) – The HTML with embedded model

User Guide#