RUIC 0.4.6 → 0.5.0

data/lib/ruic.rb

@@ -1,176 +1,183 @@
-#encoding:utf-8
-
-class RUIC; end
-module UIC; end
-
-require 'nokogiri'
-require_relative 'ruic/version'
-require_relative 'ruic/attributes'
-require_relative 'ruic/assets'
-require_relative 'ruic/interfaces'
-require_relative 'ruic/application'
-require_relative 'ruic/behaviors'
-require_relative 'ruic/statemachine'
-require_relative 'ruic/presentation'
-
-# The `RUIC` class provides the interface for running scripts using the special DSL,
-# and for running the interactive REPL.
-# See the {file:README.md README} file for description of the DSL.
-class RUIC
-	DEFAULTMETADATA = 'C:/Program Files (x86)/NVIDIA Corporation/UI Composer 8.0/res/DataModelMetadata/en-us/MetaData.xml'
-
-	# Execute a script and/or launch the interactive REPL.
-	#
-	# If you both run a `:script` and then enter the `:repl` all local variables created
-	# by the script will be available in the REPL.
-	#
-	#     # Just run a script
-	#     RUIC.run script:'my.ruic'
-	#
-	#     # Load an application and then enter the REPL
-	#     RUIC.run uia:'my.uia', repl:true
-	#
-	#     # Run a script and then drop into the REPL
-	#     RUIC.run script:'my.ruic', repl:true
-	#
-	# The working directory for scripts is set to the directory of the script.
-	#
-	# The working directory for the repl is set to the directory of the first
-	# loaded application (if any);
-	# failing that, the directory of the script (if any);
-	# failing that, the current directory.
-	#
-	# @option opts [String] :script A path to a `.ruic` script to run _(optional)_.
-	# @option opts [String] :uia An `.uia` file to load (before running the script and/or REPL) _(optional)_.
-	# @option opts [Boolean] :repl Pass `true` to enter the command-line REPL after executing the script (if any).
-	# @return [nil]
-	def self.run(opts={})
-		opts = opts
-		ruic = nil
-		if opts[:script]
-			script = File.read(opts[:script],encoding:'utf-8')
-			Dir.chdir(File.dirname(opts[:script])) do
-				ruic = self.new
-				ruic.uia(opts[:uia]) if opts[:uia]
-				ruic.env.eval(script,opts[:script])
-			end
-		end
-
-		if opts[:repl]
-			location = (ruic && ruic.app && ruic.app.respond_to?(:file) && ruic.app.file) || opts[:uia] || opts[:script] || '.'
-			Dir.chdir( File.dirname(location) ) do
-				ruic ||= self.new.tap{ |r| r.uia(opts[:uia]) if opts[:uia] }
-				require 'ripl/irb'
-				require 'ripl/multi_line'
-				require 'ripl/multi_line/live_error.rb'
-				require_relative 'ruic/ripl-after-result'
-				Ripl::MultiLine.engine = Ripl::MultiLine::LiveError
-				Ripl::Shell.include Ripl::MultiLine.engine
-				Ripl::Shell.include Ripl::AfterResult
-				Ripl.config.merge! prompt:"", result_prompt:'#=> ', multi_line_prompt:'  ', irb_verbose:false, after_result:"\n"
-				ARGV.clear # So that RIPL doesn't try to interpret the options
-				puts "(RUIC v#{RUIC::VERSION} interactive session; 'quit' or ctrl-d to end)"
-				ruic.instance_eval{ puts @apps.map{ |n,app| "(#{n} is #{app.inspect})" } }
-				puts "" # blank line before first input
-				Ripl.start binding:ruic.env
-			end
-		end
-	end
-
-	# Creates a new environment for executing a RUIC script.
-	# @param metadata [String] Path to the `MetaData.xml` file to use.
-	def initialize( metadata=DEFAULTMETADATA )
-		@metadata = metadata
-		@apps = {}
-	end
-
-	# Set the metadata to use; generally called from the RUIC DSL.
-	# @param path [String] Path to the `MetaData.xml` file, either absolute or relative to the working directory.
-	def metadata(path)
-		@metadata = path
-	end
-
-	# Load an application, making it available as `app`, `app2`, etc.
-	# @param path [String] Path to the `*.uia` application file.
-	# @return [UIC::Application] The new application loaded.
-	def uia(path)
-		meta = UIC.MetaData @metadata
-		name = @apps.empty? ? :app : :"app#{@apps.length+1}"
-		@apps[name] = UIC.Application(meta,path)
-	end
-
-	# @return [Binding] the shared binding used for evaluating the script and REPL
-	def env
-		@env ||= binding
-	end
-
-	# @private used as a one-off
-	module SelfInspecting; def inspect; to_s; end; end
-
-	# Used to resolve bare `app` and `app2` calls to a loaded {UIC::Application Application}.
-	# @return [UIC::Application] the new application loaded.
-	def method_missing(name,*a)
-		@apps[name] || (name=~/^app\d*/ ? "(no #{name} loaded)".extend(SelfInspecting) : super)
-	end
-
-	# Simple assertion mechanism to be used within scripts.
-	#
-	# @example 1) simple call syntax
-	#     # Provides a generic failure message
-	#     assert a==b
-	#     #=> assertion failed (my.ruic line 17)
-	#
-	#     # Provides a custom failure message
-	#     assert a==b, "a should equal b"
-	#     #=> a should equal b : assertion failed (my.ruic line 17)
-	#
-	# @example 2) block with string syntax
-	#     # The code in the string to eval is also the failure message
-	#     assert{ "a==b" }
-	#     #=> a==b : assertion failed (my.ruic line 17)
-	#
-	# @param condition [Boolean] the value to evaluate.
-	# @param msg [String] the nice error message to display.
-	# @yieldreturn [String] the code to evaluate as a condition.
-	def assert(condition=:CONDITIONNOTSUPPLIED,msg=nil,&block)
-		if block && condition==:CONDITIONNOTSUPPLIED
-			msg = yield
-			condition = msg.is_a?(String) ? eval(msg,block.binding) : msg
-		end
-		condition || begin
-			file, line, _ = caller.first.split(':')
-			puts "#{"#{msg} : " unless msg.nil?}assertion failed (#{file} line #{line})"
-			exit 1
-		end
-	end
-
-	# Nicer name for `puts` to be used in the DSL, printing the
-	# 'nice' string equivalent for all supplied arguments.
-	def show(*a); puts *a.map(&:to_s); end
-
-	def inspect
-		"<RUIC #{@apps.empty? ? "(no app loaded)" : Hash[ @apps.map{ |id,app| [id,File.basename(app.file)] } ]}>"
-	end
-end
-
-# Run a series of commands inside the RUIC DSL.
-#
-# @example
-#   require 'ruic'
-#   RUIC do
-#     uia 'test/MyProject/MyProject.uia'
-#     show app
-#     #=>UIC::Application 'MyProject.uia'>
-#   end
-#
-# If no block is supplied, this is the same as {RUIC.run RUIC.run(opts)}.
-# @option opts [String] :uia Optionally load an application before running the script.
-def RUIC(opts={},&block)
-	if block
-		Dir.chdir(File.dirname($0)) do
-			RUIC.new.tap{ |r| r.uia(opts[:uia]) if opts[:uia] }.instance_eval(&block)
-		end
-	else
-		RUIC.run(opts)
-	end
+#encoding:utf-8
+
+class RUIC; end
+module UIC; end
+
+require 'nokogiri'
+require_relative 'ruic/version'
+require_relative 'ruic/attributes'
+require_relative 'ruic/assets'
+require_relative 'ruic/interfaces'
+require_relative 'ruic/application'
+require_relative 'ruic/behaviors'
+require_relative 'ruic/statemachine'
+require_relative 'ruic/presentation'
+
+# The `RUIC` class provides the interface for running scripts using the special DSL,
+# and for running the interactive REPL.
+# See the {file:README.md README} file for description of the DSL.
+class RUIC
+	DEFAULTMETADATA = 'C:/Program Files (x86)/NVIDIA Corporation/UI Composer 8.0/res/DataModelMetadata/en-us/MetaData.xml'
+
+	# Execute a script and/or launch the interactive REPL.
+	#
+	# If you both run a `:script` and then enter the `:repl` all local variables created
+	# by the script will be available in the REPL.
+	#
+	#     # Just run a script
+	#     RUIC.run script:'my.ruic'
+	#
+	#     # Load an application and then enter the REPL
+	#     RUIC.run uia:'my.uia', repl:true
+	#
+	#     # Run a script and then drop into the REPL
+	#     RUIC.run script:'my.ruic', repl:true
+	#
+	# The working directory for scripts is set to the directory of the script.
+	#
+	# The working directory for the repl is set to the directory of the first
+	# loaded application (if any);
+	# failing that, the directory of the script (if any);
+	# failing that, the current directory.
+	#
+	# @option opts [String] :script A path to a `.ruic` script to run _(optional)_.
+	# @option opts [String] :uia An `.uia` file to load (before running the script and/or REPL) _(optional)_.
+	# @option opts [Boolean] :repl Pass `true` to enter the command-line REPL after executing the script (if any).
+	# @return [nil]
+	def self.run(opts={})
+		opts = opts
+		ruic = nil
+		if opts[:script]
+			script = File.read(opts[:script],encoding:'utf-8')
+			Dir.chdir(File.dirname(opts[:script])) do
+				ruic = self.new
+				ruic.metadata opts[:metadata] if opts[:metadata]
+				ruic.uia      opts[:uia]      if opts[:uia]
+				ruic.env.eval(script,opts[:script])
+			end
+		end
+
+		if opts[:repl]
+			location = (ruic && ruic.app && ruic.app.respond_to?(:file) && ruic.app.file) || opts[:uia] || opts[:script] || '.'
+			Dir.chdir( File.dirname(location) ) do
+				ruic ||= self.new.tap do |r|
+					r.metadata opts[:metadata] if opts[:metadata]
+					r.uia      opts[:uia]      if opts[:uia]
+				end
+				require 'ripl/irb'
+				require 'ripl/multi_line'
+				require 'ripl/multi_line/live_error.rb'
+				require_relative 'ruic/ripl-after-result'
+				Ripl::MultiLine.engine = Ripl::MultiLine::LiveError
+				Ripl::Shell.include Ripl::MultiLine.engine
+				Ripl::Shell.include Ripl::AfterResult
+				Ripl.config.merge! prompt:"", result_prompt:'#=> ', multi_line_prompt:'  ', irb_verbose:false, after_result:"\n"
+				ARGV.clear # So that RIPL doesn't try to interpret the options
+				puts "(RUIC v#{RUIC::VERSION} interactive session; 'quit' or ctrl-d to end)"
+				ruic.instance_eval{ puts @apps.map{ |n,app| "(#{n} is #{app.inspect})" } }
+				puts "" # blank line before first input
+				Ripl.start binding:ruic.env
+			end
+		end
+	end
+
+	# Creates a new environment for executing a RUIC script.
+	# @param metadata [String] Path to the `MetaData.xml` file to use.
+	def initialize( metadata=DEFAULTMETADATA )
+		@metadata = metadata
+		@apps = {}
+	end
+
+	# Set the metadata to use; generally called from the RUIC DSL.
+	# @param path [String] Path to the `MetaData.xml` file, either absolute or relative to the working directory.
+	def metadata(path)
+		@metadata = path
+	end
+
+	# Load an application, making it available as `app`, `app2`, etc.
+	# @param path [String] Path to the `*.uia` application file.
+	# @return [UIC::Application] The new application loaded.
+	def uia(path)
+		meta = UIC.MetaData @metadata
+		name = @apps.empty? ? :app : :"app#{@apps.length+1}"
+		@apps[name] = UIC.Application(meta,path)
+	end
+
+	# @return [Binding] the shared binding used for evaluating the script and REPL
+	def env
+		@env ||= binding
+	end
+
+	# @private used as a one-off
+	module SelfInspecting; def inspect; to_s; end; end
+
+	# Used to resolve bare `app` and `app2` calls to a loaded {UIC::Application Application}.
+	# @return [UIC::Application] the new application loaded.
+	def method_missing(name,*a)
+		@apps[name] || (name=~/^app\d*/ ? "(no #{name} loaded)".extend(SelfInspecting) : super)
+	end
+
+	# Simple assertion mechanism to be used within scripts.
+	#
+	# @example 1) simple call syntax
+	#     # Provides a generic failure message
+	#     assert a==b
+	#     #=> assertion failed (my.ruic line 17)
+	#
+	#     # Provides a custom failure message
+	#     assert a==b, "a should equal b"
+	#     #=> a should equal b : assertion failed (my.ruic line 17)
+	#
+	# @example 2) block with string syntax
+	#     # The code in the string to eval is also the failure message
+	#     assert{ "a==b" }
+	#     #=> a==b : assertion failed (my.ruic line 17)
+	#
+	# @param condition [Boolean] the value to evaluate.
+	# @param msg [String] the nice error message to display.
+	# @yieldreturn [String] the code to evaluate as a condition.
+	def assert(condition=:CONDITIONNOTSUPPLIED,msg=nil,&block)
+		if block && condition==:CONDITIONNOTSUPPLIED
+			msg = yield
+			condition = msg.is_a?(String) ? eval(msg,block.binding) : msg
+		end
+		condition || begin
+			file, line, _ = caller.first.split(':')
+			puts "#{"#{msg} : " unless msg.nil?}assertion failed (#{file} line #{line})"
+			exit 1
+		end
+	end
+
+	# Nicer name for `puts` to be used in the DSL, printing the
+	# 'nice' string equivalent for all supplied arguments.
+	def show(*a); puts *a.map(&:to_s); end
+
+	def inspect
+		"<RUIC #{@apps.empty? ? "(no app loaded)" : Hash[ @apps.map{ |id,app| [id,File.basename(app.file)] } ]}>"
+	end
+end
+
+# Run a series of commands inside the RUIC DSL.
+#
+# @example
+#   require 'ruic'
+#   RUIC do
+#     uia 'test/MyProject/MyProject.uia'
+#     show app
+#     #=>UIC::Application 'MyProject.uia'>
+#   end
+#
+# If no block is supplied, this is the same as {RUIC.run RUIC.run(opts)}.
+# @option opts [String] :uia Optionally load an application before running the script.
+def RUIC(opts={},&block)
+	if block
+		Dir.chdir(File.dirname($0)) do
+			RUIC.new.tap do |r|
+				r.metadata opts[:metadata] if opts[:metadata]
+				r.uia      opts[:uia]      if opts[:uia]
+			end.instance_eval(&block)
+		end
+	else
+		RUIC.run(opts)
+	end
 end

data/lib/ruic/application.rb

@@ -80,8 +80,8 @@ class UIC::Application
 	def referenced_files
 		# TODO: state machines can reference external scripts
 		# TODO: behaviors can reference external scripts
-		assets.map{ |asset| path_to(asset.src) }
-		+ presentations.flat_map{ |pres| pres.presentation.referenced_files }
+		assets.map{ |asset| resolve_file_path(asset.src) }
+		+ presentations.flat_map{ |pres| pres.referenced_files }
 	end
 
 	# @return [Array] all assets referenced by the application. Ordered by the order they appear in the `.uia`.

data/lib/ruic/assets.rb

@@ -1,422 +1,437 @@
-#encoding: utf-8
-class UIC::MetaData
-
-	# The base class for all assets. All other classes are dynamically created when a `MetaData.xml` file is loaded.
-	class AssetBase
-		@properties = {}
-		@name = "AssetBase"
-
-		class << self
-			# @return [String] The scene graph name of the asset.
-			attr_reader :name
-
-			# @return [Hash] a hash mapping attribute names to {Property} instances.
-			def properties
-				(ancestors[1].respond_to?(:properties) ? ancestors[1].properties : {}).merge(@properties)
-			end
-
-			# @private
-			def inspect
-				"<#{@name}>"
-			end
-		end
-
-		# @return [Hash] a hash mapping attribute names to {Property} instances.
-		def properties
-			self.class.properties
-		end
-
-		# Find an asset by relative scripting path.
-		#
-		# @example
-		#  preso = app.main
-		#  layer = preso/"Scene.Layer"
-		#  cam1  = app/"main:Scene.Layer.Camera"
-		#  cam2  = preso/"Scene.Layer.Camera"
-		#  cam3  = layer/"Camera"
-		#  cam4  = cam1/"parent.Camera"
-		#
-		#  assert cam1==cam2 && cam2==cam3 && cam3==cam4
-		#
-		# @return [MetaData::AssetBase] The found asset, or `nil` if it cannot be found.
-		#
-		# @see Application#at
-		# @see Presentation#at
-		def at(sub_path)
-			presentation.at(sub_path,@el)
-		end
-		alias_method :/, :at
-
-		# @return [Presentation] the presentation that this asset is part of.
-		attr_accessor :presentation
-
-		# @return [Nokogiri::XML::Element] the internal XML element in the scene graph of the presentation.
-		attr_accessor :el
-
-		# Create a new asset. This is called for you automatically; you likely should not be using it.
-		# @param presentation [Presentation] the presentation owning this asset.
-		# @param element [Nokogiri::XML::Element] the internal XML element in the scene graph of the presentation.
-		def initialize( presentation, element )
-			@presentation = presentation
-			@el = element
-		end
-
-		# @return [String] the type of this asset. For example: `"Model"`, `"Material"`, `"ReferencedMaterial"`, `"PathAnchorPoint"`, etc.
-		def type
-			self.class.name
-		end
-
-		# @return [AssetBase] the parent of this asset in the scene graph.
-		# @see Presentation#parent_asset
-		def parent
-			presentation.parent_asset(self)
-		end
-
-		# @return [Array<AssetBase>] array of child assets in the scene graph. Children are in scene graph order.
-		# @see Presentation#child_assets
-		def children
-			presentation.child_assets(self)
-		end
-
-		# Find descendant assets matching criteria.
-		# This method is the same as (but more convenient than) {Presentation#find} using the `:_under` criteria.
-		# See that method for documentation of the `criteria`.
-		#
-		# @example
-		#  preso = app.main
-		#  group = preso/"Scene.Layer.Vehicle"
-		#  tires = group.find name:/^Tire/
-		#
-		#  # alternative
-		#  tires = preso.find name:/^Tire/, _under:group
-		#
-		# @return [Array<AssetBase>]
-		#
-		# @see Presentation#find
-		def find(criteria={},&block)
-			criteria[:_under] ||= self
-			presentation.find(criteria,&block)
-		end
-
-		# @return [AssetBase] the component or scene that owns this asset.
-		#         If this asset is a component, does not return itself.
-		# @see Presentation#owning_component
-		def component
-			presentation.owning_component(self)
-		end
-
-		# @return [Boolean] `true` if this asset is a component or Scene.
-		def component?
-			@el.name=='Component' || @el.name=='Scene'
-		end
-
-		# @return [Boolean] `true` if this asset is on the master slide.
-		# @see Presentation#master?
-		def master?
-			presentation.master?(self)
-		end
-
-		# @return [Boolean] `true` if this asset is a Slide.
-		def slide?
-			false
-		end
-
-		# @param slide_name_or_index [Integer,String] the slide number of name to check for presence on.
-		# @return [Boolean] `true` if this asset is present on the specified slide.
-		# @see Presentation#has_slide?
-		def has_slide?(slide_name_or_index)
-			presentation.has_slide?(self,slide_name_or_index)
-		end
-
-		# @return [SlideCollection] an array-like collection of all slides that the asset is available on.
-		# @see Presentation#slides_for
-		def slides
-			presentation.slides_for(self)
-		end
-
-		# @example
-		#  logo = app/"main:Scene.UI.Logo"
-		#  assert logo.master?             # It's a master object
-		#
-		#  show logo['endtime'].values     #=> [10000,500,1000,750]
-		#  show logo['opacity'].values     #=> [100,0,0,100]
-		#  logo1 = logo.on_slide(1)
-		#  logo2 = logo.on_slide(2)
-		#  show logo1['endtime']           #=> 500
-		#  show logo2['endtime']           #=> 1000
-		#  show logo1['opacity']           #=> 0
-		#  show logo2['opacity']           #=> 0
-		#
-		#  logo2['opacity'] = 66
-		#  show logo['opacity'].values     #=> [100,0,66,100]
-		#
-		# @param slide_name_or_index [Integer,String] the slide number or name to create the proxy for.
-		# @return [SlideValues] a proxy that yields attribute values for a specific slide.
-		def on_slide(slide_name_or_index)
-			if has_slide?(slide_name_or_index)
-				UIC::SlideValues.new( self, slide_name_or_index )
-			end
-		end
-
-		# @return [String] the script path to this asset.
-		# @see #path_to
-		# @see Presentation#path_to
-		def path
-			@path ||= @presentation.path_to(self)
-		end
-
-		# @param other_asset [AssetBase] the asset to find the relative path to.
-		# @return [String] the script path to another asset, relative to this one.
-		# @see #path
-		# @see Presentation#path_to
-		def path_to(other_asset)
-			@presentation.path_to(other_asset,self)
-		end
-
-		# @return [String] the name of this asset in the scene graph.
-		def name
-			properties['name'].get( self, presentation.slide_index(self) )
-		end
-
-		# Change the name of the asset in the scene graph.
-		# @param new_name [String] the new name for this asset.
-		# @return [String] the new name.
-		def name=( new_name )
-			@path = nil # invalidate the memoization
-			properties['name'].set( self, new_name, presentation.slide_index(self) )
-		end
-
-		# Get the value(s) of an attribute.
-		# If `slide_name_or_index` is omitted, creates a ValuesPerSlide proxy for the specified attribute.
-		# @example
-		#  logo = app/"main:Scene.UI.Logo"
-		#  show logo.master?               #=> true  (it's a master object)
-		#  show logo['endtime'].linked?    #=> false (the endtime property is unlinked)
-		#  show logo['endtime'].values     #=> [10000,500,1000,750]
-		#  show logo['endtime',0]          #=> 10000 (the master slide value)
-		#  show logo['endtime',"Slide 1"]  #=> 500
-		#  show logo['endtime',2]          #=> 1000
-		#
-		# @param attribute_name [String,Symbol] the name of the attribute.
-		# @param slide_name_or_index [Integer,String] the slide number or name to find the value on.
-		# @return [Object] the value of the property on the given slide.
-		# @return [ValuesPerSlide] if no slide is specified.
-		# @see #on_slide
-		# @see Presentation#get_attribute
-		def [](attribute_name, slide_name_or_index=nil)
-			if property = properties[attribute_name.to_s]
-				if slide_name_or_index
-					property.get( self, slide_name_or_index ) if has_slide?(slide_name_or_index)
-				else
-					UIC::ValuesPerSlide.new(@presentation,self,property)
-				end
-			end
-		end
-
-		# Set the value of an attribute, either across all slides, or on a particular slide.
-		#
-		# @example
-		#  logo = app/"main:Scene.UI.Logo"
-		#  show logo.master?               #=> true  (it's a master object)
-		#  show logo['endtime'].linked?    #=> false (the endtime property is unlinked)
-		#  show logo['endtime'].values     #=> [10000,500,1000,750]
-		#
-		#  logo['endtime',1] = 99
-		#  show logo['endtime'].values     #=> [10000,99,1000,750]
-		#
-		#  logo['endtime'] = 42
-		#  show logo['endtime'].values     #=> [42,42,42,42]
-		#  show logo['endtime'].linked?    #=> false (the endtime property is still unlinked)
-		#
-		# @param attribute_name [String,Symbol] the name of the attribute.
-		# @param slide_name_or_index [Integer,String] the slide number or name to set the value on.
-		# @param new_value [Numeric,String] the new value for the attribute.
-		# @see Presentation#set_attribute
-		def []=( attribute_name, slide_name_or_index=nil, new_value )
-			if property = properties[attribute_name.to_s] then
-				property.set(self,new_value,slide_name_or_index)
-			end
-		end
-
-		# @return [String] the XML representation of the scene graph element.
-		def to_xml
-			@el.to_xml
-		end
-
-		# @private no need to document this
-		def inspect
-			"<asset #{@el.name}##{@el['id']}>"
-		end
-
-		# @private no need to document this
-		def to_s
-			"<#{type} #{path}>"
-		end
-
-		# @private no need to document this
-		def ==(other)
-			(self.class==other.class) && (el==other.el)
-		end
-		alias_method :eql?, :==
-	end
-
-	attr_reader :by_name
-
-	HIER = {}
-
-	%w[Asset Slide Scene].each{ |s| HIER[s] = 'AssetBase' }
-	%w[Node Behavior Effect Image Layer MaterialBase PathAnchorPoint RenderPlugin].each{ |s| HIER[s]='Asset' }
-	%w[Alias Camera Component Group Light Model Text Path].each{ |s| HIER[s]='Node' }
-	%w[Material ReferencedMaterial].each{ |s| HIER[s]='MaterialBase' }
-
-	def initialize(xml)
-
-		@by_name = {'AssetBase'=>AssetBase}
-
-		doc = Nokogiri.XML(xml)
-		hack_in_slide_names!(doc)
-
-		HIER.each do |class_name,parent_class_name|
-			parent_class = @by_name[parent_class_name]
-			el = doc.root.at(class_name)
-			@by_name[class_name] = create_class(el,parent_class,el.name)
-		end
-
-		# Extend well-known classes with script interfaces after they are created
-		@by_name['State'] = @by_name['Slide']
-		@by_name['Slide'].instance_eval do
-			attr_accessor :index, :name
-			define_method :inspect do
-				"<slide ##{index} of #{@el['component'] || @el.parent['component']}>"
-			end
-			define_method(:slide?){ true }
-		end
-
-		refmat = @by_name['ReferencedMaterial']
-		@by_name['MaterialBase'].instance_eval do
-			define_method :replace_with_referenced_material do
-				type=='ReferencedMaterial' ? self : presentation.replace_asset( self, 'ReferencedMaterial', name:name )
-			end
-		end
-
-		@by_name['Path'].instance_eval do
-			define_method(:anchors){ find _type:'PathAnchorPoint' }
-		end
-
-	end
-
-	# Creates a class from MetaData.xml with accessors for the <Property> listed.
-	# Instances of the class are associated with a presentation and know how to
-	# get/set values in that XML based on value types, slides, defaults.
-	# Also used to create classes from effects, materials, and behavior preambles.
-	def create_class(el,parent_class,name='CustomAsset')
-		Class.new(parent_class) do
-			@name = name.to_s
-			@properties = Hash[ el.css("Property").map do |e|
-				type = e['type'] || (e['list'] ? 'String' : 'Float')
-				type = "Float" if type=="float"
-				property = UIC::Property.const_get(type).new(e)
-				[ property.name, UIC::Property.const_get(type).new(e) ]
-			end ]
-			def self.inspect
-				@name
-			end
-		end
-	end
-
-	def new_instance(presentation,el)
-		klass = @by_name[el.name] || create_class(el,@by_name['Asset'],el.name)
-		klass.new(presentation,el)
-	end
-
-	def hack_in_slide_names!(doc)
-		doc.at('Slide') << '<Property name="name" formalName="Name" type="String" default="Slide" hidden="True" />'
-	end
-end
-
-def UIC.MetaData(metadata_path)
-	UIC::MetaData.new(File.read(metadata_path,encoding:'utf-8'))
-end
-
-class UIC::SlideCollection
-	include Enumerable
-	attr_reader :length
-	def initialize(slides)
-		@length = slides.length-1
-		@slides = slides
-		@lookup = {}
-		slides.each do |s|
-			@lookup[s.index] = s
-			@lookup[s.name]  = s
-		end
-	end
-	def each
-		@slides.each{ |s| yield(s) }
-	end
-	def [](index_or_name)
-		@lookup[ index_or_name ]
-	end
-	def inspect
-		"[ #{@slides.map(&:inspect).join ', '} ]"
-	end
-	def to_ary
-		@slides
-	end
-end
-
-class UIC::ValuesPerSlide
-	def initialize(presentation,asset,property)
-		raise unless presentation.is_a?(UIC::Presentation)
-
-		raise unless asset.is_a?(UIC::MetaData::AssetBase)
-		raise unless property.is_a?(UIC::Property)
-		@preso    = presentation
-		@asset    = asset
-		@el       = asset.el
-		@property = property
-	end
-	def value
-		values.first
-	end
-	def [](slide_name_or_index)
-		@property.get( @asset, slide_name_or_index )
-	end
-	def []=(slide_name_or_index,new_value)
-		@property.set( @asset, new_value, slide_name_or_index )
-	end
-	def linked?
-		@preso.attribute_linked?( @asset, @property.name )
-	end
-	def unlink
-		@preso.unlink_attribute( @asset, @property.name )
-	end
-	def link
-		@preso.link_attribute( @asset, @property.name )
-	end
-	def values
-		@asset.slides.map{ |s| self[s.name] }
-	end
-	def inspect
-		"<Values of '#{@asset.name}.#{@property.name}' across slides>"
-	end
-	alias_method :to_s, :inspect
-end
-
-class UIC::SlideValues
-	def initialize( asset, slide )
-		@asset = asset
-		@slide = slide
-	end
-	def [](attribute_name)
-		@asset[attribute_name,@slide]
-	end
-	def []=( attribute_name, new_value )
-		@asset[attribute_name,@slide] = new_value
-	end
-	def method_missing( name, *args, &blk )
-		asset.send(name,*args,&blk)
-	end
-	def inspect
-		"<#{@asset.inspect} on slide #{@slide.inspect}>"
-	end
+#encoding: utf-8
+class UIC::MetaData
+
+	# The base class for all assets. All other classes are dynamically created when a `MetaData.xml` file is loaded.
+	class AssetBase
+		@properties = {}
+		@name = "AssetBase"
+
+		class << self
+			# @return [String] The scene graph name of the asset.
+			attr_reader :name
+
+			# @return [Hash] a hash mapping attribute names to {Property} instances.
+			def properties
+				(ancestors[1].respond_to?(:properties) ? ancestors[1].properties : {}).merge(@properties)
+			end
+
+			# @private
+			def inspect
+				"<#{@name}>"
+			end
+		end
+
+		# @return [Hash] a hash mapping attribute names to {Property} instances.
+		def properties
+			self.class.properties
+		end
+
+		# Find an asset by relative scripting path.
+		#
+		# @example
+		#  preso = app.main
+		#  layer = preso/"Scene.Layer"
+		#  cam1  = app/"main:Scene.Layer.Camera"
+		#  cam2  = preso/"Scene.Layer.Camera"
+		#  cam3  = layer/"Camera"
+		#  cam4  = cam1/"parent.Camera"
+		#
+		#  assert cam1==cam2 && cam2==cam3 && cam3==cam4
+		#
+		# @return [MetaData::AssetBase] The found asset, or `nil` if it cannot be found.
+		#
+		# @see Application#at
+		# @see Presentation#at
+		def at(sub_path)
+			presentation.at(sub_path,@el)
+		end
+		alias_method :/, :at
+
+		# @return [Presentation] the presentation that this asset is part of.
+		attr_accessor :presentation
+
+		# @return [Nokogiri::XML::Element] the internal XML element in the scene graph of the presentation.
+		attr_accessor :el
+
+		# Create a new asset. This is called for you automatically; you likely should not be using it.
+		# @param presentation [Presentation] the presentation owning this asset.
+		# @param element [Nokogiri::XML::Element] the internal XML element in the scene graph of the presentation.
+		def initialize( presentation, element )
+			@presentation = presentation
+			@el = element
+		end
+
+		# @return [String] the type of this asset. For example: `"Model"`, `"Material"`, `"ReferencedMaterial"`, `"PathAnchorPoint"`, etc.
+		def type
+			self.class.name
+		end
+
+		# @return [AssetBase] the parent of this asset in the scene graph.
+		# @see Presentation#parent_asset
+		def parent
+			presentation.parent_asset(self)
+		end
+
+		# @return [Array<AssetBase>] array of child assets in the scene graph. Children are in scene graph order.
+		# @see Presentation#child_assets
+		def children
+			presentation.child_assets(self)
+		end
+
+		# @return [String] the hierarchy under the element (for debugging purposes).
+		def hierarchy
+			presentation.hierarchy(self)
+		end
+
+		# Find descendant assets matching criteria.
+		# This method is the same as (but more convenient than) {Presentation#find} using the `:_under` criteria.
+		# See that method for documentation of the `criteria`.
+		#
+		# @example
+		#  preso = app.main
+		#  group = preso/"Scene.Layer.Vehicle"
+		#  tires = group.find name:/^Tire/
+		#
+		#  # alternative
+		#  tires = preso.find name:/^Tire/, _under:group
+		#
+		# @return [Array<AssetBase>]
+		#
+		# @see Presentation#find
+		def find(criteria={},&block)
+			criteria[:_under] ||= self
+			presentation.find(criteria,&block)
+		end
+
+		# @return [AssetBase] the component or scene that owns this asset.
+		#         If this asset is a component, does not return itself.
+		# @see Presentation#owning_component
+		def component
+			presentation.owning_component(self)
+		end
+
+		# @return [Boolean] `true` if this asset is a component or Scene.
+		def component?
+			@el.name=='Component' || @el.name=='Scene'
+		end
+
+		# @return [Boolean] `true` if this asset is on the master slide.
+		# @see Presentation#master?
+		def master?
+			presentation.master?(self)
+		end
+
+		# @return [Boolean] `true` if this asset is a Slide.
+		def slide?
+			false
+		end
+
+		# @param slide_name_or_index [Integer,String] the slide number of name to check for presence on.
+		# @return [Boolean] `true` if this asset is present on the specified slide.
+		# @see Presentation#has_slide?
+		def has_slide?(slide_name_or_index)
+			presentation.has_slide?(self,slide_name_or_index)
+		end
+
+		# @return [SlideCollection] an array-like collection of all slides that the asset is available on.
+		# @see Presentation#slides_for
+		def slides
+			presentation.slides_for(self)
+		end
+
+		# @example
+		#  logo = app/"main:Scene.UI.Logo"
+		#  assert logo.master?             # It's a master object
+		#
+		#  show logo['endtime'].values     #=> [10000,500,1000,750]
+		#  show logo['opacity'].values     #=> [100,0,0,100]
+		#  logo1 = logo.on_slide(1)
+		#  logo2 = logo.on_slide(2)
+		#  show logo1['endtime']           #=> 500
+		#  show logo2['endtime']           #=> 1000
+		#  show logo1['opacity']           #=> 0
+		#  show logo2['opacity']           #=> 0
+		#
+		#  logo2['opacity'] = 66
+		#  show logo['opacity'].values     #=> [100,0,66,100]
+		#
+		# @param slide_name_or_index [Integer,String] the slide number or name to create the proxy for.
+		# @return [SlideValues] a proxy that yields attribute values for a specific slide.
+		def on_slide(slide_name_or_index)
+			if has_slide?(slide_name_or_index)
+				UIC::SlideValues.new( self, slide_name_or_index )
+			end
+		end
+
+		# @return [String] the script path to this asset.
+		# @see #path_to
+		# @see Presentation#path_to
+		def path
+			@path ||= @presentation.path_to(self)
+		end
+
+		# @param other_asset [AssetBase] the asset to find the relative path to.
+		# @return [String] the script path to another asset, relative to this one.
+		# @see #path
+		# @see Presentation#path_to
+		def path_to(other_asset)
+			@presentation.path_to(other_asset,self)
+		end
+
+		# @return [String] the name of this asset in the scene graph.
+		def name
+			properties['name'] ? properties['name'].get( self, presentation.slide_index(self) ) : type
+		end
+
+		# Change the name of the asset in the scene graph.
+		# @param new_name [String] the new name for this asset.
+		# @return [String] the new name.
+		def name=( new_name )
+			@path = nil # invalidate the memoization
+			properties['name'].set( self, new_name, presentation.slide_index(self) )
+		end
+
+		# Get the value(s) of an attribute.
+		# If `slide_name_or_index` is omitted, creates a ValuesPerSlide proxy for the specified attribute.
+		# @example
+		#  logo = app/"main:Scene.UI.Logo"
+		#  show logo.master?               #=> true  (it's a master object)
+		#  show logo['endtime'].linked?    #=> false (the endtime property is unlinked)
+		#  show logo['endtime'].values     #=> [10000,500,1000,750]
+		#  show logo['endtime',0]          #=> 10000 (the master slide value)
+		#  show logo['endtime',"Slide 1"]  #=> 500
+		#  show logo['endtime',2]          #=> 1000
+		#
+		# @param attribute_name [String,Symbol] the name of the attribute.
+		# @param slide_name_or_index [Integer,String] the slide number or name to find the value on.
+		# @return [Object] the value of the property on the given slide.
+		# @return [ValuesPerSlide] if no slide is specified.
+		# @see #on_slide
+		# @see Presentation#get_attribute
+		def [](attribute_name, slide_name_or_index=nil)
+			if property = properties[attribute_name.to_s]
+				if slide_name_or_index
+					property.get( self, slide_name_or_index ) if has_slide?(slide_name_or_index)
+				else
+					UIC::ValuesPerSlide.new(@presentation,self,property)
+				end
+			end
+		end
+
+		# Set the value of an attribute, either across all slides, or on a particular slide.
+		#
+		# @example
+		#  logo = app/"main:Scene.UI.Logo"
+		#  show logo.master?               #=> true  (it's a master object)
+		#  show logo['endtime'].linked?    #=> false (the endtime property is unlinked)
+		#  show logo['endtime'].values     #=> [10000,500,1000,750]
+		#
+		#  logo['endtime',1] = 99
+		#  show logo['endtime'].values     #=> [10000,99,1000,750]
+		#
+		#  logo['endtime'] = 42
+		#  show logo['endtime'].values     #=> [42,42,42,42]
+		#  show logo['endtime'].linked?    #=> false (the endtime property is still unlinked)
+		#
+		# @param attribute_name [String,Symbol] the name of the attribute.
+		# @param slide_name_or_index [Integer,String] the slide number or name to set the value on.
+		# @param new_value [Numeric,String] the new value for the attribute.
+		# @see Presentation#set_attribute
+		def []=( attribute_name, slide_name_or_index=nil, new_value )
+			if property = properties[attribute_name.to_s] then
+				property.set(self,new_value,slide_name_or_index)
+			end
+		end
+
+		# @return [String] the XML representation of the scene graph element.
+		def to_xml
+			@el.to_xml
+		end
+
+		# @private no need to document this
+		def to_s
+			"<#{type} #{path}>"
+		end
+		alias_method :inspect, :to_s
+
+		# @private no need to document this
+		def ==(other)
+			(self.class==other.class) && (el==other.el)
+		end
+		alias_method :eql?, :==
+	end
+
+	attr_reader :by_name
+
+	HIER = {}
+
+	%w[Asset Slide Scene].each{ |s| HIER[s] = 'AssetBase' }
+	%w[Node Behavior Effect Image Layer MaterialBase PathAnchorPoint RenderPlugin].each{ |s| HIER[s]='Asset' }
+	%w[Alias Camera Component Group Light Model Text Path].each{ |s| HIER[s]='Node' }
+	%w[Material ReferencedMaterial].each{ |s| HIER[s]='MaterialBase' }
+
+	def initialize(xml)
+		@by_name = {'AssetBase'=>AssetBase}
+
+		doc = Nokogiri.XML(xml)
+		hack_in_slide_names!(doc)
+
+		HIER.each do |class_name,parent_class_name|
+			parent_class = @by_name[parent_class_name]
+			el = doc.root.at(class_name)
+			@by_name[class_name] = create_class(el,parent_class,el.name)
+		end
+
+		# Extend well-known classes with script interfaces after they are created
+		@by_name['State'] = @by_name['Slide']
+		@by_name['Slide'].instance_eval do
+			attr_accessor :index, :name
+			define_method :inspect do
+				"<slide ##{index} of #{@el['component'] || @el.parent['component']}>"
+			end
+			define_method(:slide?){ true }
+		end
+
+		refmat = @by_name['ReferencedMaterial']
+		@by_name['MaterialBase'].instance_eval do
+			define_method :replace_with_referenced_material do
+				type=='ReferencedMaterial' ? self : presentation.replace_asset( self, 'ReferencedMaterial', name:name )
+			end
+		end
+
+		@by_name['Path'].instance_eval do
+			define_method(:anchors){ find _type:'PathAnchorPoint' }
+		end
+
+	end
+
+	# Creates a class from MetaData.xml with accessors for the <Property> listed.
+	# Instances of the class are associated with a presentation and know how to
+	# get/set values in that XML based on value types, slides, defaults.
+	# Also used to create classes from effects, materials, and behavior preambles.
+	# @param el [Nokogiri::XML::Element] the element in MetaData.xml representing this class.
+	# @param parent_class [Class] the asset class to inherit from.
+	# @param name [String] the name of this class.
+	# @param new_defaults [Hash] hash mapping attribute name to a custom default value (as string) for this class.
+	def create_class(el,parent_class,name,new_defaults={})
+		Class.new(parent_class) do
+			@name = name.to_s
+			@properties = Hash[ el.css("Property").map do |e|
+				type = e['type'] || (e['list'] ? 'String' : 'Float')
+				type = "Float" if type=="float"
+				property = UIC::Property.const_get(type).new(e)
+				new_defaults.delete(property.name)
+				[ property.name, property ]
+			end ]
+
+			new_defaults.each do |name,value|
+				if prop=properties[name] # look in ancestor classes
+					@properties[name] = prop.dup
+					@properties[name].default = value
+				end
+			end
+
+			def self.inspect
+				@name
+			end
+		end
+	end
+
+	def new_instance(presentation,el)
+		klass = @by_name[el.name] || create_class(el,@by_name['Asset'],el.name)
+		klass.new(presentation,el)
+	end
+
+	def hack_in_slide_names!(doc)
+		doc.at('Slide') << '<Property name="name" formalName="Name" type="String" default="Slide" hidden="True" />'
+	end
+end
+
+def UIC.MetaData(metadata_path)
+	raise %Q{Cannot find MetaData.xml at "#{metadata_path}"} unless File.exist?(metadata_path)
+	UIC::MetaData.new(File.read(metadata_path,encoding:'utf-8'))
+end
+
+class UIC::SlideCollection
+	include Enumerable
+	attr_reader :length
+	def initialize(slides)
+		@length = slides.length-1
+		@slides = slides
+		@lookup = {}
+		slides.each do |s|
+			@lookup[s.index] = s
+			@lookup[s.name]  = s
+		end
+	end
+	def each
+		@slides.each{ |s| yield(s) }
+	end
+	def [](index_or_name)
+		@lookup[ index_or_name ]
+	end
+	def inspect
+		"[ #{@slides.map(&:inspect).join ', '} ]"
+	end
+	def to_ary
+		@slides
+	end
+end
+
+class UIC::ValuesPerSlide
+	def initialize(presentation,asset,property)
+		raise unless presentation.is_a?(UIC::Presentation)
+
+		raise unless asset.is_a?(UIC::MetaData::AssetBase)
+		raise unless property.is_a?(UIC::Property)
+		@preso    = presentation
+		@asset    = asset
+		@el       = asset.el
+		@property = property
+	end
+	def value
+		values.first
+	end
+	def [](slide_name_or_index)
+		@property.get( @asset, slide_name_or_index )
+	end
+	def []=(slide_name_or_index,new_value)
+		@property.set( @asset, new_value, slide_name_or_index )
+	end
+	def linked?
+		@preso.attribute_linked?( @asset, @property.name )
+	end
+	def unlink
+		@preso.unlink_attribute( @asset, @property.name )
+	end
+	def link
+		@preso.link_attribute( @asset, @property.name )
+	end
+	def values
+		@asset.slides.map{ |s| self[s.name] }
+	end
+	def inspect
+		"<Values of '#{@asset.name}.#{@property.name}' across slides>"
+	end
+	alias_method :to_s, :inspect
+end
+
+class UIC::SlideValues
+	attr_reader :asset
+	def initialize( asset, slide )
+		@asset = asset
+		@slide = slide
+	end
+	def [](attribute_name)
+		@asset[attribute_name,@slide]
+	end
+	def []=( attribute_name, new_value )
+		@asset[attribute_name,@slide] = new_value
+	end
+	def method_missing( name, *args, &blk )
+		asset.send(name,*args,&blk)
+	end
+	def inspect
+		"<#{@asset.inspect} on slide #{@slide.inspect}>"
+	end
 end