Module: MSPhysics::Dialog

Defined in:

RubyExtension/MSPhysics/dialog.rb

Overview

Since:

• 1.0.0

Constant Summary

DEFAULT_EDITOR_THEME =

Since:

• 1.0.0

'tomorrow_night'

DEFAULT_EDITOR_FONT =

Since:

• 1.0.0

12

DEFAULT_EDITOR_WRAP =

Since:

• 1.0.0

'free'

DEFAULT_EDITOR_PRINT_MARGIN =

Since:

• 1.0.0

true

DEFAULT_EDITOR_SIZE =

Since:

• 1.0.0

[800,600]

DEFAULT_DIALOG_HELP_BOX =

Since:

• 1.0.0

true

DEFAULT_DIALOG_SCALE =

Since:

• 1.0.0

1.0

USE_HTML_DIALOG =

~ Sketchup.version.to_i > 16 ? true : false

Since:

• 1.0.0

false

PRECISION =

Since:

• 1.0.0

3

TITLE =

Since:

• 1.0.0

'MSPhysics UI'

Class Method Summary

• .add_sound(path) ⇒ String

  Add sound to UI.

• .execute_js(code) ⇒ nil

  Execute JavaScript in the UI dialog.

• .fix_numeric_value(value) ⇒ String private

  Remove uncertain decimal places.

• .format_value(value, precision = 2) ⇒ String private

  Format value into string.

• .get_joint_default_value(joint, attr_name) ⇒ Object^? private

  Get default value of a particular attribute in joint.

• .load_editor_settings ⇒ Object

  Load editor settings from registry.

• .locate_error(error) ⇒ Boolean

  Open MSPhysics UI and set pointer to the location of an error.

• .open(state) ⇒ Boolean

  Open/close MSPhysics UI.

• .open? ⇒ Boolean

  Determine if MSPhysics UI is open.

• .remove_all_sounds ⇒ Object

  Remove all sounds from UI.

• .remove_sound(name) ⇒ Object

  Remove sound from UI.

• .save_editor_settings ⇒ Object

  Save editor settings into registry.

• .update_body_state ⇒ void private

  Update UI properties tab.

• .update_dialog_style ⇒ Boolean private

  Update dialog style.

• .update_joint_state ⇒ void private

  Update UI joint tab.

• .update_simulation_sliders ⇒ void
• .update_simulation_state ⇒ void private

  Update UI simulation tab.

• .update_sound_state ⇒ void private

  Update UI sound tab.

• .update_state ⇒ void private

  Update state of all UI.

Class Method Details

.add_sound(path) ⇒ String

Add sound to UI.

Parameters:

• path (String)

Returns:

• (String) —

  Name of added file.

Raises:

• (TypeError) —

  if file path is invalid.

• (TypeError) —

  if file is over 100 megabytes.

Since:

• 1.0.0

.execute_js(code) ⇒ nil

Execute JavaScript in the UI dialog.

Parameters:

• code (String)

Returns:

• (nil)

Since:

• 1.0.0

.fix_numeric_value(value) ⇒ String

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Remove uncertain decimal places.

Parameters:

• value (Numeric)

Returns:

• (String)

Since:

• 1.0.0

.format_value(value, precision = 2) ⇒ String

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Format value into string.

Parameters:

• value (Numeric)
• precision (Fixnum) (defaults to: 2)

Returns:

• (String)

Since:

• 1.0.0

.get_joint_default_value(joint, attr_name) ⇒ Object^?

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Get default value of a particular attribute in joint.

Parameters:

• joint (Sketchup::Group, Sketchup::ComonentInstance)
• attr_name (String)

Returns:

• (Object, nil)

Since:

• 1.0.0

.load_editor_settings ⇒ Object

Load editor settings from registry.

Since:

• 1.0.0

.locate_error(error) ⇒ Boolean

Open MSPhysics UI and set pointer to the location of an error.

Parameters:

• error (MSPhysics::ScriptException)

Returns:

• (Boolean) —

  success

Since:

• 1.0.0

.open(state) ⇒ Boolean

Open/close MSPhysics UI.

Parameters:

• state (Boolean)

Returns:

• (Boolean) —

  success

Since:

• 1.0.0

.open? ⇒ Boolean

Determine if MSPhysics UI is open.

Returns:

• (Boolean)

Since:

• 1.0.0

.remove_all_sounds ⇒ Object

Remove all sounds from UI.

Since:

• 1.0.0

.remove_sound(name) ⇒ Object

Remove sound from UI.

Parameters:

• name (String)

Since:

• 1.0.0

.save_editor_settings ⇒ Object

Save editor settings into registry.

Since:

• 1.0.0

.update_body_state ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Update UI properties tab.

Since:

• 1.0.0

.update_dialog_style ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Update dialog style.

Returns:

• (Boolean) —

  success

Since:

• 1.0.0

.update_joint_state ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Update UI joint tab.

Since:

• 1.0.0

.update_simulation_sliders ⇒ void

This method returns an undefined value.

Since:

• 1.0.0

.update_simulation_state ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Update UI simulation tab.

Since:

• 1.0.0

.update_sound_state ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Update UI sound tab.

Since:

• 1.0.0

.update_state ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Update state of all UI.

Since:

• 1.0.0