Class: MSPhysics::SceneData

Inherits:

Entity

• Object
• Entity
• MSPhysics::SceneData

Defined in:

RubyExtension/MSPhysics/scene_data.rb

Overview

Since:

• 1.0.0

Instance Method Summary

• #axes ⇒ Geom::Transformation

  Get scene axes.

• #camera ⇒ Sketchup::Camera

  Get scene camera.

• #hidden_entities ⇒ Array<Sketchup::Entity>

  Get scene hidden entities.

• #hidden_layers ⇒ Array<Sketchup::Layer>

  Get scene hidden layers.

• #initialize(*args) ⇒ SceneData constructor

  A new instance of SceneData.

• #rendering_options ⇒ Hash

  Get scene rendering options.

• #shadow_info ⇒ Hash

  Get scene shadow info.

• #style ⇒ Sketchup::Style

  Get scene style.

• #transition(scene_data, ratio) ⇒ void

  Transition between this and the desired scene data.

• #use_axes=(state) ⇒ Object

  Enable/disable axes transitioning for this scene.

• #use_axes? ⇒ Boolean

  Determine if axes transitioning is enabled.

• #use_camera=(state) ⇒ Object

  Enable/disable camera transitioning for this scene.

• #use_camera? ⇒ Boolean

  Determine if camera transitioning is enabled.

• #use_hidden_entities=(state) ⇒ Object

  Enable/disable hidden entities transitioning for this scene.

• #use_hidden_entities? ⇒ Boolean

  Determine if hidden entities transitioning is enabled.

• #use_hidden_layers=(state) ⇒ Object

  Enable/disable hidden layers transitioning for this scene.

• #use_hidden_layers? ⇒ Boolean

  Determine if hidden layers transitioning is enabled.

• #use_rendering_options=(state) ⇒ Object

  Enable/disable rendering options transitioning for this scene.

• #use_rendering_options? ⇒ Boolean

  Determine if rendering options transitioning is enabled.

• #use_shadow_info=(state) ⇒ Object

  Enable/disable shadow transitioning for this scene.

• #use_shadow_info? ⇒ Boolean

  Determine if shadow transitioning is enabled.

• #use_style=(state) ⇒ Object

  Enable/disable style transitioning for this scene.

• #use_style? ⇒ Boolean

  Determine if style transitioning is enabled.

Methods inherited from Entity

#inspect, #to_s

Constructor Details

#initialize ⇒ SceneData #initialize(page) ⇒ SceneData

Returns a new instance of SceneData

Overloads:

• #initialize ⇒ SceneData

  Create scene data from current model.
• #initialize(page) ⇒ SceneData

  Create scene data from page.

  Parameters:

  • page (Sketchup::Page)

Since:

• 1.0.0

Instance Method Details

#axes ⇒ Geom::Transformation

Get scene axes.

Returns:

• (Geom::Transformation)

Since:

• 1.0.0

#camera ⇒ Sketchup::Camera

Get scene camera.

Returns:

• (Sketchup::Camera)

Since:

• 1.0.0

#hidden_entities ⇒ Array<Sketchup::Entity>

Get scene hidden entities.

Returns:

• (Array<Sketchup::Entity>)

Since:

• 1.0.0

#hidden_layers ⇒ Array<Sketchup::Layer>

Get scene hidden layers.

Returns:

• (Array<Sketchup::Layer>)

Since:

• 1.0.0

#rendering_options ⇒ Hash

Get scene rendering options.

Returns:

• (Hash)

Since:

• 1.0.0

#shadow_info ⇒ Hash

Get scene shadow info.

Returns:

• (Hash)

Since:

• 1.0.0

#style ⇒ Sketchup::Style

Get scene style.

Returns:

• (Sketchup::Style)

Since:

• 1.0.0

#transition(scene_data, ratio) ⇒ void

Note:

Manually wrap the operation.

This method returns an undefined value.

Transition between this and the desired scene data.

Parameters:

• scene_data (SceneData) —

  Other scene data

• ratio (Numeric) —

  A value between 0.0 and 1.0.

Since:

• 1.0.0

#use_axes=(state) ⇒ Object

Enable/disable axes transitioning for this scene.

Parameters:

• state (Boolean)

Since:

• 1.0.0

#use_axes? ⇒ Boolean

Determine if axes transitioning is enabled.

Returns:

• (Boolean)

Since:

• 1.0.0

#use_camera=(state) ⇒ Object

Enable/disable camera transitioning for this scene.

Parameters:

• state (Boolean)

Since:

• 1.0.0

#use_camera? ⇒ Boolean

Determine if camera transitioning is enabled.

Returns:

• (Boolean)

Since:

• 1.0.0

#use_hidden_entities=(state) ⇒ Object

Enable/disable hidden entities transitioning for this scene.

Parameters:

• state (Boolean)

Since:

• 1.0.0

#use_hidden_entities? ⇒ Boolean

Determine if hidden entities transitioning is enabled.

Returns:

• (Boolean)

Since:

• 1.0.0

#use_hidden_layers=(state) ⇒ Object

Enable/disable hidden layers transitioning for this scene.

Parameters:

• state (Boolean)

Since:

• 1.0.0

#use_hidden_layers? ⇒ Boolean

Determine if hidden layers transitioning is enabled.

Returns:

• (Boolean)

Since:

• 1.0.0

#use_rendering_options=(state) ⇒ Object

Enable/disable rendering options transitioning for this scene.

Parameters:

• state (Boolean)

Since:

• 1.0.0

#use_rendering_options? ⇒ Boolean

Determine if rendering options transitioning is enabled.

Returns:

• (Boolean)

Since:

• 1.0.0

#use_shadow_info=(state) ⇒ Object

Enable/disable shadow transitioning for this scene.

Parameters:

• state (Boolean)

Since:

• 1.0.0

#use_shadow_info? ⇒ Boolean

Determine if shadow transitioning is enabled.

Returns:

• (Boolean)

Since:

• 1.0.0

#use_style=(state) ⇒ Object

Enable/disable style transitioning for this scene.

Parameters:

• state (Boolean)

Since:

• 1.0.0

#use_style? ⇒ Boolean

Determine if style transitioning is enabled.

Returns:

• (Boolean)

Since:

• 1.0.0