nebula-webclient 8.0.10286 → 8.0.10290

data/.yardopts

@@ -0,0 +1 @@
+--no-private

data/lib/nebula/webclient/setting.rb

@@ -4,6 +4,7 @@ require 'erb'
 module Nebula
 	module WebClient
 
+		# @private
 		class Encoder
 
 			def self.str(s)
@@ -27,13 +28,20 @@ module Nebula
 			end
 		end
 
+		# Border setting of the Nebula Viewer.
 		class Border
-			def initialize(s = 'solid', w = 0, c = '#000')
-				@style = s
-				@width = w
-				@color = c
+			# @param args [Hash]
+			#   * :style => (String) The HTML style of the border, e.g., "solid", "dashed".
+			#   * :width => (String) or [Fixnum] The width of the border in pixels.
+			#   * :color => (String) The color of the border, e.g., "#302903".
+			def initialize(args = {})
+				@style = args[:style] || 'solid'
+				@width = args[:width] || 0
+				@color = args[:color] || '#000'
 			end
 			
+			# Convert the border setting to HTML string, e.g., "solid 1px #302903".
+			# @return [String] A HTML string like "solid 1px #303902".
 			def to_s
 				'' << style.to_s << ' ' << width.to_s << 'px ' << color.to_s
 			end
@@ -43,35 +51,52 @@ module Nebula
 			attr(:color, true)
 		end
 
+		# The configuration of the Nebula Viewer, including its scale, the border and some other advanced configurations.
 		class Setting
-			def initialize
-				@width = 640
-				@height = 480
-				@border = Border.new
-				@menu_docking = :bottom
-				@render_mode = :default
-				@language = :english
+			# @param args [Hash]
+			#   * :width => [String] or [Fixnum] Width of the viewer.
+			#   * :height => [String] or [Fixnum] Height of the viewer.
+			#   * :border => [Border] Border setting of the viewer.
+			#   * :menu_docking => [Symbol] Docking position of the main menu, one of :bottom, :right.
+			#   * :render_mode => [Symbol] Default rendering mode of the viewer, one of :realistic, :fantastic, :technical.
+			#       realistic:  Realistic rendering mode, with global shadow and lights.
+			#       fanstastic: Fantastic rendering mode, with realistic shadows and multiple texture-mapping.
+			#       technical:  Technical rendering mode, with triangles in different colors.
+			#   * :language => Language package to be loaded, one of :english, :french, :simplified_chinese, :traditional_chinese, :japanese.
+			def initialize(args = {})
+				@width = args[:width] || 640
+				@height = args[:height] || 480
+				@border = args[:border] || Border.new
+				@menu_docking = args[:menu_docking] || :bottom
+				@render_mode = args[:render_mode] || :realistic
+				@language = args[:language] || :english
 			end
 
-			def parameters(uri)
+			# Generate the url parameters to describe the settings.
+			# @param uri [String] Uri of the model to be loaded, empty for nothing.
+			# @return [String] A encoded string as a url parameter (query).
+			def to_url_parameters(uri = nil)
 				s = ''
 				s << '?w=' << Encoder.str(width)
 				s << '&h=' << Encoder.str(height)
 				s << '&b=' << Encoder.url(border) if border.width > 0
 				s << '&m=' << Encoder.str(menu_docking) if menu_docking != :bottom
-				s << '&r=' << Encoder.str(render_mode) if render_mode != :default
+				s << '&r=' << Encoder.str(RenderModes[render_mode]) if render_mode != :default
 				s << '&l=' << Encoder.str(Languages[language]) if language != :english
 				s << '&u=' << Encoder.url(uri) if uri
 				s
 			end
 
-			def json(uri)
+			# Generate the JSON code of the setting.
+			# @param uri [String] Uri of the model to be loaded, empty for nothing.
+			# @return [String] A JSON string.
+			def to_json(uri = nil)
 				s = ''
 				s << '{width:' << Encoder.str(width)
 				s << ',height:' << Encoder.str(height)
 				s << ',border:' << Encoder.str(border) if border.width > 0
 				s << ',menuDocking:' << Encoder.str(menu_docking) if menu_docking != :bottom
-				s << ',renderMode:' << Encoder.str(render_mode) if render_mode != :default
+				s << ',renderMode:' << Encoder.str(RenderModes[render_mode]) if render_mode != :realistic
 				s << ',language:' << Encoder.str(Languages[language]) if language != :english
 				s << ',uri' << Encoder.js(uri) if uri
 				s << '}'
@@ -85,14 +110,22 @@ module Nebula
 			attr(:render_mode, true)
 			attr(:language, true)
 
+			# @private
 			Languages = {:english => 'en-us',
 						 :french => 'fr',
 						 :simplified_chinese => 'zh-cn',
 						 :traditional_chinese => 'zh-tw',
 						 :japanese => 'jp'
 			}
+
+			# @private
+			RenderModes = {:realistic => 'default',
+						   :fantastic => 'realistic',
+						   :technical => 'diagnostic'
+			}
 		end
 
+		# @private
 		class RenderSetting
 			def initialize(w, h, mode = :default, set = '', view = '', version = '1.0')
 				@width = w
@@ -103,7 +136,7 @@ module Nebula
 				@version = version
 			end
 
-			def json
+			def to_json
 				s = ''
 				s << '{screenWidth:' << Encoder.str(width)
 				s << ',screenHeight:' << Encoder.str(height)

data/lib/nebula/webclient/viewer.rb

@@ -1,10 +1,30 @@
 
 module Nebula
+	# The main module that contains code generating classes of the Nebula Viewer.
 	module WebClient
 
+		# The main class of generating HTML code for Nebula Viewer.
 		class Viewer
+
+			# @private
 			ServiceHostAddress = 'http://nebula.gems8.com/__nebulaviewerv100__'
 
+			# An address of a sample model.
+			SampleModel = 'http://nebula.gems8.com/Home/Sample/Apple'
+
+			# Generate code of an iframe containing the viewer of the specified model.
+			# @param args [Hash]
+			#   * :uri => (String) Address of the 3D model, required.
+			#   * :width => (String) or (Fixnum) Width in pixels of the viewer.
+			#   * :height => (String) or (Fixnum) Height in pixels of the viewer.
+			#   * :id => (String) Id of the HTML element.
+			#   * :class_name => (String) Class name of the HTML element.
+			#   * :selector => (String) Id or the class name of the HTML element.
+			#     If the selector starts with "#", it means an id.
+			#     If starts with ".", it means the class name.
+			#     Or, id by default.
+			#   * "setting => (Setting) Advanced setting of the viewer
+			# @return [String] Html code of the embedded Nebula Viewer.
 			def self.html(args)
 				uri = args[:uri]
 				id, klass = selector(args)
@@ -12,7 +32,7 @@ module Nebula
 
 				s = ''
 				s << '<iframe src="' << ServiceHostAddress << '/EmbeddedViewer'
-				s << setting.parameters(uri)
+				s << setting.to_url_parameters(uri)
 				s << '" width="' << Encoder.str(setting.width)
 				s << '" height="' << Encoder.str(setting.height)
 				s << '" class="' << Encoder.str(klass) if !klass.blank?
@@ -20,6 +40,9 @@ module Nebula
 				s << '" scrolling="no" frameBorder="0"></iframe>'
 			end
 
+			# Generate a javascript statement to load the viewer to the specified HTML element container, with the specified model address and advanced settings.
+			# @param (see .html)
+			# @return (String) Html code of the JavaScript code.
 			def self.javascript(args)
 				uri = args[:uri]
 				selector = args[:selector]
@@ -28,14 +51,20 @@ module Nebula
 				s << 'new NebulaViewer('
 				s << Encoder.js(selector)
 				s << ','
-				s << setting(args).json(uri)
+				s << setting(args).to_json(uri)
 				s << ');'
 			end
 
-			def self.jssection(args)
+			# Generate a javascript tag to load the viewer to the specified HTML element container, with the specified model address and advanced settings.
+			# @param (see .html)
+			# @return (String) Html code of the JavaScript section.
+			def self.javascript_section(args)
 				'<script type="text/javascript">' << javascript(args) << '</script>'
 			end
 
+			# Create a img tag of a thumbnail to preview a 3D model.
+			# @param (see .html)
+			# @return A HTML string of the thumbnail.
 			def self.thumbnail(args)
 				uri = args[:uri]
 				id, klass = selector(args)
@@ -51,21 +80,23 @@ module Nebula
 				s << '" />'
 			end
 
+			# Create a unescaped url of a thumbnail to preview a 3D model.
+			# @param (see .html)
+			# @return An url string of the thumbnail.
 			def self.thumbnail_url(args)
 				uri = args[:uri]
-				id, klass = selector(args)
-				render = RenderSetting.new(args[:width], args[:height])
-
 				uri = 'image/jpeg@' << uri if !uri.index('@')
+				render = RenderSetting.new(args[:width], args[:height])
 
 				s = ''
 				s << ServiceHostAddress
 				s << '/Render?u=' << Encoder.url(uri)
 				s << '&c=d'
-				s << '&s=' << Encoder.url(render.json)
+				s << '&s=' << Encoder.url(render.to_json)
 				s << '&timestamp=thumbnail'
 			end
 
+			# @private
 			def self.setting(args)
 				setting = args[:setting] || Setting.new
 				setting.width = args[:width] if args[:width]
@@ -73,10 +104,11 @@ module Nebula
 				setting
 			end
 
+			# @private
 			def self.selector(args)
-				selector = args[:selecor]
+				selector = args[:selector]
 				if selector.blank?
-					return args[:id], args[:klass]
+					return args[:id], args[:class_name]
 				else
 					selector.strip!
 					if selector.start_with?('#')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nebula-webclient
 version: !ruby/object:Gem::Version
-  version: 8.0.10286
+  version: 8.0.10290
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-13 00:00:00.000000000 Z
+date: 2013-05-17 00:00:00.000000000 Z
 dependencies: []
 description: The library of Nebula Viewer web client.
 email: nebula@gems8.com
@@ -21,6 +21,7 @@ files:
 - lib/nebula/webclient/viewer.rb
 - lib/nebula/webclient.rb
 - lib/nebula-webclient.rb
+- .yardopts
 homepage: http://nebula.gems8.com
 licenses: []
 post_install_message: 
@@ -46,3 +47,4 @@ signing_key:
 specification_version: 3
 summary: The library of Nebula Viewer web client.
 test_files: []
+has_rdoc: