Module: MSPhysics::Replay

Defined in:

RubyExtension/MSPhysics/replay.rb

Overview

Since:

• 1.0.0

Constant Summary

DEFAULT_RECORD_GROUPS =

Since:

• 1.0.0

true

DEFAULT_RECORD_MATERIALS =

Since:

• 1.0.0

true

DEFAULT_RECORD_LAYERS =

Since:

• 1.0.0

false

DEFAULT_RECORD_CAMERA =

Since:

• 1.0.0

true

DEFAULT_RECORD_RENDER =

Since:

• 1.0.0

false

DEFAULT_RECORD_SHADOW =

Since:

• 1.0.0

false

DEFAULT_REPLAY_GROUPS =

Since:

• 1.0.0

true

DEFAULT_REPLAY_MATERIALS =

Since:

• 1.0.0

true

DEFAULT_REPLAY_LAYERS =

Since:

• 1.0.0

false

DEFAULT_REPLAY_CAMERA =

Since:

• 1.0.0

true

DEFAULT_REPLAY_RENDER =

Since:

• 1.0.0

false

DEFAULT_REPLAY_SHADOW =

Since:

• 1.0.0

false

EXPORT_MESSAGE =

Since:

• 1.0.0

"SketchUp is in the process of exporting MSPhysics animation. You can wait until the process is complete or press OK to abort. If you do stop, you might have to wait a little for the current scene to finish exporting."

Class Method Summary

• .activate_frame(pframe) ⇒ Boolean

  Activate frame data.

• .active? ⇒ Boolean

  Determine whether replay animation is in operation.

• .active_data_valid? ⇒ Boolean

  Determine whether active data is not empty.

• .camera_data_valid? ⇒ Boolean

  Determine whether camera data is not empty.

• .camera_record_enabled=(state) ⇒ Object

  Enable/disable camera recording.

• .camera_record_enabled? ⇒ Boolean

  Determine whether camera recording is enabled.

• .camera_replay_enabled=(state) ⇒ Object

  Enable/disable camera replay.

• .camera_replay_enabled? ⇒ Boolean

  Determine whether camera replay is enabled.

• .clear_active_data ⇒ Object

  Clear active data.

• .clear_data_from_file ⇒ Boolean

  Clear saved data from file.

• .clear_data_from_model(wrap_in_op = true, delete_particle_defs = true) ⇒ void

  Delete saved data from model.

• .clear_recorded_data ⇒ Object

  Clear recorded data.

• .end_frame ⇒ Fixnum^?

  Get ending frame of all data recorded.

• .export_to_images ⇒ Boolean

  Export animation into image files.

• .export_to_kerkythea ⇒ Boolean

  Export animation into Kerkythea files.

• .export_to_skindigo ⇒ Boolean

  Export animation into SkIndigo files.

• .export_to_skp ⇒ Boolean

  Export animation into sketchup files.

• .flatten_active_data ⇒ Object

  Fill in the gaps within all the recorded information.

• .frame ⇒ Numeric

  Get replay animation frame.

• .frame=(value) ⇒ Object

  Set replay animation frame.

• .get_camera_data(pframe) ⇒ Hash^?

  Get camera data at a particular frame.

• .get_frame_data(data, pframe) ⇒ Hash^?

  Get data at a particular frame.

• .get_group_data(group, pframe) ⇒ Hash^?

  Get group/component data at a particular frame.

• .get_layer_data(layer, pframe) ⇒ Hash^?

  Get layer data at a particular frame.

• .get_material_data(material, pframe) ⇒ Hash^?

  Get material data at a particular frame.

• .get_render_data(pframe) ⇒ Hash^?

  Get render data at a particular frame.

• .get_shadow_data(pframe) ⇒ Hash^?

  Get shadow data at a particular frame.

• .groups_data_valid? ⇒ Boolean

  Determine whether groups data is not empty.

• .groups_record_enabled=(state) ⇒ Object

  Enable/disable groups recording.

• .groups_record_enabled? ⇒ Boolean

  Determine whether groups recording is enabled.

• .groups_replay_enabled=(state) ⇒ Object

  Enable/disable groups replay.

• .groups_replay_enabled? ⇒ Boolean

  Determine whether groups replay is enabled.

• .layers_data_valid? ⇒ Boolean

  Determine whether layers data is not empty.

• .layers_record_enabled=(state) ⇒ Object

  Enable/disable layers recording.

• .layers_record_enabled? ⇒ Boolean

  Determine whether layers recording is enabled.

• .layers_replay_enabled=(state) ⇒ Object

  Enable/disable layers replay.

• .layers_replay_enabled? ⇒ Boolean

  Determine whether layers replay is enabled.

• .load_data_from_file ⇒ Boolean

  Load saved data from file.

• .load_replay_proc ⇒ void

  Load settings and data procedure.

• .load_replay_settings ⇒ void

  Load replay settings from model dictionary.

• .materials_data_valid? ⇒ Boolean

  Determine whether materials data is not empty.

• .materials_record_enabled=(state) ⇒ Object

  Enable/disable materials recording.

• .materials_record_enabled? ⇒ Boolean

  Determine whether materials recording is enabled.

• .materials_replay_enabled=(state) ⇒ Object

  Enable/disable materials replay.

• .materials_replay_enabled? ⇒ Boolean

  Determine whether materials replay is enabled.

• .pause ⇒ Boolean

  Pause replay animation.

• .paused? ⇒ Boolean

  Determine whether replay animation is paused.

• .play(activate_animation = true) ⇒ Boolean

  Play replay animation.

• .playing? ⇒ Boolean

  Determine whether replay animation is playing.

• .preset_definition(instance, definition) ⇒ Object

  When emitting groups, it would help to know their source, as as definitions often get purged.

• .record_all(pframe) ⇒ Object

  Record groups, camera, materials, layers, render, and shadow based on whether their recording is enabled.

• .record_camera(pframe) ⇒ Object

  Record camera.

• .record_enabled=(state) ⇒ Object

  Enable/disable simulation recording.

• .record_enabled? ⇒ Boolean

  Determine whether simulation recording is enabled.

• .record_group(group, pframe) ⇒ Object

  Record group/component.

• .record_groups(pframe) ⇒ Object

  Record all groups.

• .record_layer(layer, pframe) ⇒ Object

  Record layer.

• .record_layers(pframe) ⇒ Object

  Record all layers.

• .record_material(material, pframe) ⇒ Object

  Record material.

• .record_materials(pframe) ⇒ Object

  Record all materials.

• .record_render(pframe) ⇒ Object

  Record rendering options.

• .record_shadow(pframe) ⇒ Object

  Record shadow info.

• .recorded_data_valid? ⇒ Boolean

  Determine whether recorded data is not empty.

• .render_data_valid? ⇒ Boolean

  Determine whether render data is not empty.

• .render_record_enabled=(state) ⇒ Object

  Enable/disable render recording.

• .render_record_enabled? ⇒ Boolean

  Determine whether render recording is enabled.

• .render_replay_enabled=(state) ⇒ Object

  Enable/disable replay of rendering options.

• .render_replay_enabled? ⇒ Boolean

  Determine whether replay of rendering options is enabled.

• .reset ⇒ Boolean

  Stop replay animation and reset entity positions.

• .reset_replay_settings ⇒ void

  Reset replay settings.

• .reversed=(state) ⇒ Object

  Reverse replay animation.

• .reversed? ⇒ Boolean

  Determine whether replay animation is reversed.

• .save_data_to_file(wrap_in_op = true) ⇒ Boolean

  Save active data into file.

• .save_recorded_data ⇒ Object

  Activate recorded data.

• .save_replay_settings(wrap_in_op = true) ⇒ void

  Save replay settings into model dictionary.

• .shadow_data_valid? ⇒ Boolean

  Determine whether shadow data is not empty.

• .shadow_record_enabled=(state) ⇒ Object

  Enable/disable shadow recording.

• .shadow_record_enabled? ⇒ Boolean

  Determine whether shadow recording is enabled.

• .shadow_replay_enabled=(state) ⇒ Object

  Enable/disable replay of shadow info.

• .shadow_replay_enabled? ⇒ Boolean

  Determine whether relay of shadow info is enabled.

• .smoothen_camera_data(interval) ⇒ Boolean

  Smoothen the transitioning of active camera data.

• .speed ⇒ Numeric

  Get replay animation speed.

• .speed=(value) ⇒ Object

  Set replay animation speed.

• .start(activate_animation = true) ⇒ Boolean

  Start replay animation.

• .start_frame ⇒ Fixnum^?

  Get starting frame of all data recorded.

• .stop ⇒ Boolean

  Stop replay animation, but avoid reseting entity positions.

• .toggle_play ⇒ Boolean

  Pause/Resume replay animation.

Class Method Details

.activate_frame(pframe) ⇒ Boolean

Activate frame data.

Parameters:

• pframe (Fixnum)

Returns:

• (Boolean) —

  success

Since:

• 1.0.0

.active? ⇒ Boolean

Determine whether replay animation is in operation.

Returns:

• (Boolean)

Since:

• 1.0.0

.active_data_valid? ⇒ Boolean

Determine whether active data is not empty.

Returns:

• (Boolean)

Since:

• 1.0.0

.camera_data_valid? ⇒ Boolean

Determine whether camera data is not empty.

Returns:

• (Boolean)

Since:

• 1.0.0

.camera_record_enabled=(state) ⇒ Object

Enable/disable camera recording.

Parameters:

• state (Boolean)

Since:

• 1.0.0

.camera_record_enabled? ⇒ Boolean

Determine whether camera recording is enabled.

Returns:

• (Boolean)

Since:

• 1.0.0

.camera_replay_enabled=(state) ⇒ Object

Enable/disable camera replay.

Parameters:

• state (Boolean)

Since:

• 1.0.0

.camera_replay_enabled? ⇒ Boolean

Determine whether camera replay is enabled.

Returns:

• (Boolean)

Since:

• 1.0.0

.clear_active_data ⇒ Object

Clear active data.

Since:

• 1.0.0

.clear_data_from_file ⇒ Boolean

Note:

This attempts to delete the file if permissions are granted.

Clear saved data from file.

Returns:

• (Boolean) —

  success

Since:

• 1.0.0

.clear_data_from_model(wrap_in_op = true, delete_particle_defs = true) ⇒ void

This method returns an undefined value.

Delete saved data from model.

Parameters:

• wrap_in_op (Boolean) (defaults to: true) —

  Whether to wrap in operation.

• delete_particle_defs (Boolean) (defaults to: true) —

  Whether to delete particle definition preserving instances.

Since:

• 1.0.0

.clear_recorded_data ⇒ Object

Clear recorded data.

Since:

• 1.0.0

.end_frame ⇒ Fixnum^?

Get ending frame of all data recorded.

Returns:

• (Fixnum, nil)

Since:

• 1.0.0

.export_to_images ⇒ Boolean

Export animation into image files.

Returns:

• (Boolean) —

  success

Since:

• 1.0.0

.export_to_kerkythea ⇒ Boolean

Export animation into Kerkythea files.

Returns:

• (Boolean) —

  success

Since:

• 1.0.0

.export_to_skindigo ⇒ Boolean

Export animation into SkIndigo files.

Returns:

• (Boolean) —

  success

Since:

• 1.0.0

.export_to_skp ⇒ Boolean

Export animation into sketchup files.

Returns:

• (Boolean) —

  success

Since:

• 1.0.0

.flatten_active_data ⇒ Object

Fill in the gaps within all the recorded information.

Since:

• 1.0.0

.frame ⇒ Numeric

Get replay animation frame.

Returns:

• (Numeric)

Since:

• 1.0.0

.frame=(value) ⇒ Object

Set replay animation frame.

Parameters:

• value (Numeric)

Since:

• 1.0.0

.get_camera_data(pframe) ⇒ Hash^?

Get camera data at a particular frame.

Parameters:

• pframe (Fixnum)

Returns:

• (Hash, nil)

Since:

• 1.0.0

.get_frame_data(data, pframe) ⇒ Hash^?

Get data at a particular frame.

Parameters:

• data (Hash)
• pframe (Fixnum)

Returns:

• (Hash, nil)

Since:

• 1.0.0

.get_group_data(group, pframe) ⇒ Hash^?

Get group/component data at a particular frame.

Parameters:

• group (Sketchup::Group, Sketchup::ComponentInstance)
• pframe (Fixnum)

Returns:

• (Hash, nil)

Since:

• 1.0.0

.get_layer_data(layer, pframe) ⇒ Hash^?

Get layer data at a particular frame.

Parameters:

• layer (Sketchup::Layer)
• pframe (Fixnum)

Returns:

• (Hash, nil)

Since:

• 1.0.0

.get_material_data(material, pframe) ⇒ Hash^?

Get material data at a particular frame.

Parameters:

• material (Sketchup::Material)
• pframe (Fixnum)

Returns:

• (Hash, nil)

Since:

• 1.0.0

.get_render_data(pframe) ⇒ Hash^?

Get render data at a particular frame.

Parameters:

• pframe (Fixnum)

Returns:

• (Hash, nil)

Since:

• 1.0.0

.get_shadow_data(pframe) ⇒ Hash^?

Get shadow data at a particular frame.

Parameters:

• pframe (Fixnum)

Returns:

• (Hash, nil)

Since:

• 1.0.0

.groups_data_valid? ⇒ Boolean

Determine whether groups data is not empty.

Returns:

• (Boolean)

Since:

• 1.0.0

.groups_record_enabled=(state) ⇒ Object

Enable/disable groups recording.

Parameters:

• state (Boolean)

Since:

• 1.0.0

.groups_record_enabled? ⇒ Boolean

Determine whether groups recording is enabled.

Returns:

• (Boolean)

Since:

• 1.0.0

.groups_replay_enabled=(state) ⇒ Object

Enable/disable groups replay.

Parameters:

• state (Boolean)

Since:

• 1.0.0

.groups_replay_enabled? ⇒ Boolean

Determine whether groups replay is enabled.

Returns:

• (Boolean)

Since:

• 1.0.0

.layers_data_valid? ⇒ Boolean

Determine whether layers data is not empty.

Returns:

• (Boolean)

Since:

• 1.0.0

.layers_record_enabled=(state) ⇒ Object

Enable/disable layers recording.

Parameters:

• state (Boolean)

Since:

• 1.0.0

.layers_record_enabled? ⇒ Boolean

Determine whether layers recording is enabled.

Returns:

• (Boolean)

Since:

• 1.0.0

.layers_replay_enabled=(state) ⇒ Object

Enable/disable layers replay.

Parameters:

• state (Boolean)

Since:

• 1.0.0

.layers_replay_enabled? ⇒ Boolean

Determine whether layers replay is enabled.

Returns:

• (Boolean)

Since:

• 1.0.0

.load_data_from_file ⇒ Boolean

Load saved data from file.

Returns:

• (Boolean) —

  success

Since:

• 1.0.0

.load_replay_proc ⇒ void

This method returns an undefined value.

Load settings and data procedure.

Since:

• 1.0.0

.load_replay_settings ⇒ void

This method returns an undefined value.

Load replay settings from model dictionary.

Since:

• 1.0.0

.materials_data_valid? ⇒ Boolean

Determine whether materials data is not empty.

Returns:

• (Boolean)

Since:

• 1.0.0

.materials_record_enabled=(state) ⇒ Object

Enable/disable materials recording.

Parameters:

• state (Boolean)

Since:

• 1.0.0

.materials_record_enabled? ⇒ Boolean

Determine whether materials recording is enabled.

Returns:

• (Boolean)

Since:

• 1.0.0

.materials_replay_enabled=(state) ⇒ Object

Enable/disable materials replay.

Parameters:

• state (Boolean)

Since:

• 1.0.0

.materials_replay_enabled? ⇒ Boolean

Determine whether materials replay is enabled.

Returns:

• (Boolean)

Since:

• 1.0.0

.pause ⇒ Boolean

Pause replay animation.

Returns:

• (Boolean) —

  success

Since:

• 1.0.0

.paused? ⇒ Boolean

Determine whether replay animation is paused.

Returns:

• (Boolean)

Since:

• 1.0.0

.play(activate_animation = true) ⇒ Boolean

Play replay animation.

Parameters:

• activate_animation (Boolean) (defaults to: true)

Returns:

• (Boolean) —

  success

Since:

• 1.0.0

.playing? ⇒ Boolean

Determine whether replay animation is playing.

Returns:

• (Boolean)

Since:

• 1.0.0

.preset_definition(instance, definition) ⇒ Object

When emitting groups, it would help to know their source, as as definitions often get purged.

Parameters:

• instance (Sketchup::Group, Sketchup::ComponentInstance)
• definition (Sketchup::ComponentDefinition)

Since:

• 1.0.0

.record_all(pframe) ⇒ Object

Record groups, camera, materials, layers, render, and shadow based on whether their recording is enabled.

Parameters:

• pframe (Fixnum)

Since:

• 1.0.0

.record_camera(pframe) ⇒ Object

Record camera.

Parameters:

• pframe (Fixnum)

Since:

• 1.0.0

.record_enabled=(state) ⇒ Object

Enable/disable simulation recording.

Parameters:

• state (Boolean)

Since:

• 1.0.0

.record_enabled? ⇒ Boolean

Determine whether simulation recording is enabled.

Returns:

• (Boolean)

Since:

• 1.0.0

.record_group(group, pframe) ⇒ Object

Record group/component.

Parameters:

• group (Sketchup::Group, Sketchup::ComponentInstance)
• pframe (Fixnum)

Since:

• 1.0.0

.record_groups(pframe) ⇒ Object

Record all groups.

Parameters:

• pframe (Fixnum)

Since:

• 1.0.0

.record_layer(layer, pframe) ⇒ Object

Record layer.

Parameters:

• layer (Sketchup::Layer)
• pframe (Fixnum)

Since:

• 1.0.0

.record_layers(pframe) ⇒ Object

Record all layers.

Parameters:

• pframe (Fixnum)

Since:

• 1.0.0

.record_material(material, pframe) ⇒ Object

Record material.

Parameters:

• material (Sketchup::Material)
• pframe (Fixnum)

Since:

• 1.0.0

.record_materials(pframe) ⇒ Object

Record all materials.

Parameters:

• pframe (Fixnum)

Since:

• 1.0.0

.record_render(pframe) ⇒ Object

Record rendering options.

Parameters:

• pframe (Fixnum)

Since:

• 1.0.0

.record_shadow(pframe) ⇒ Object

Record shadow info.

Parameters:

• pframe (Fixnum)

Since:

• 1.0.0

.recorded_data_valid? ⇒ Boolean

Determine whether recorded data is not empty.

Returns:

• (Boolean)

Since:

• 1.0.0

.render_data_valid? ⇒ Boolean

Determine whether render data is not empty.

Returns:

• (Boolean)

Since:

• 1.0.0

.render_record_enabled=(state) ⇒ Object

Enable/disable render recording.

Parameters:

• state (Boolean)

Since:

• 1.0.0

.render_record_enabled? ⇒ Boolean

Determine whether render recording is enabled.

Returns:

• (Boolean)

Since:

• 1.0.0

.render_replay_enabled=(state) ⇒ Object

Enable/disable replay of rendering options.

Parameters:

• state (Boolean)

Since:

• 1.0.0

.render_replay_enabled? ⇒ Boolean

Determine whether replay of rendering options is enabled.

Returns:

• (Boolean)

Since:

• 1.0.0

.reset ⇒ Boolean

Stop replay animation and reset entity positions.

Returns:

• (Boolean) —

  success

Since:

• 1.0.0

.reset_replay_settings ⇒ void

This method returns an undefined value.

Reset replay settings.

Since:

• 1.0.0

.reversed=(state) ⇒ Object

Reverse replay animation.

Parameters:

• state (Boolean)

Since:

• 1.0.0

.reversed? ⇒ Boolean

Determine whether replay animation is reversed.

Returns:

• (Boolean)

Since:

• 1.0.0

.save_data_to_file(wrap_in_op = true) ⇒ Boolean

Save active data into file.

Parameters:

• wrap_in_op (Boolean) (defaults to: true) —

  Whether to wrap in operation.

Returns:

• (Boolean) —

  success

Since:

• 1.0.0

.save_recorded_data ⇒ Object

Activate recorded data.

Since:

• 1.0.0

.save_replay_settings(wrap_in_op = true) ⇒ void

This method returns an undefined value.

Save replay settings into model dictionary.

Parameters:

• wrap_in_op (Boolean) (defaults to: true) —

  Whether to wrap in operation.

Since:

• 1.0.0

.shadow_data_valid? ⇒ Boolean

Determine whether shadow data is not empty.

Returns:

• (Boolean)

Since:

• 1.0.0

.shadow_record_enabled=(state) ⇒ Object

Enable/disable shadow recording.

Parameters:

• state (Boolean)

Since:

• 1.0.0

.shadow_record_enabled? ⇒ Boolean

Determine whether shadow recording is enabled.

Returns:

• (Boolean)

Since:

• 1.0.0

.shadow_replay_enabled=(state) ⇒ Object

Enable/disable replay of shadow info.

Parameters:

• state (Boolean)

Since:

• 1.0.0

.shadow_replay_enabled? ⇒ Boolean

Determine whether relay of shadow info is enabled.

Returns:

• (Boolean)

Since:

• 1.0.0

.smoothen_camera_data(interval) ⇒ Boolean

Smoothen the transitioning of active camera data.

Parameters:

• interval (Fixnum)

Returns:

• (Boolean) —

  success

Since:

• 1.0.0

.speed ⇒ Numeric

Get replay animation speed.

Returns:

• (Numeric)

Since:

• 1.0.0

.speed=(value) ⇒ Object

Set replay animation speed.

Parameters:

• value (Numeric) —

  A value between 0.01 and 10000.

Since:

• 1.0.0

.start(activate_animation = true) ⇒ Boolean

Start replay animation.

Parameters:

• activate_animation (Boolean) (defaults to: true)

Returns:

• (Boolean) —

  success

Since:

• 1.0.0

.start_frame ⇒ Fixnum^?

Get starting frame of all data recorded.

Returns:

• (Fixnum, nil)

Since:

• 1.0.0

.stop ⇒ Boolean

Stop replay animation, but avoid reseting entity positions.

Returns:

• (Boolean) —

  success

Since:

• 1.0.0

.toggle_play ⇒ Boolean

Pause/Resume replay animation.

Returns:

• (Boolean) —

  success

Since:

• 1.0.0