cosmos 3.9.2 → 4.0.0

data/lib/cosmos/gui/opengl/gl_light.rb

@@ -9,7 +9,7 @@
 # attribution addendums as found in the LICENSE.txt
 
 module Cosmos
-
+  # Captures all the parameters associated with an OpenGL light
   class GlLight
     attr_accessor :ambient
     attr_accessor :diffuse
@@ -34,6 +34,5 @@ module Cosmos
       @l_attn = 0.0
       @q_attn = 0.0
     end
-  end # class Light
-
-end # module Cosmos
+  end
+end

data/lib/cosmos/gui/opengl/gl_material.rb

@@ -9,7 +9,7 @@
 # attribution addendums as found in the LICENSE.txt
 
 module Cosmos
-
+  # Captures all the parameters associated with an OpenGL material
   class GlMaterial
     attr_accessor :ambient
     attr_accessor :diffuse
@@ -24,6 +24,5 @@ module Cosmos
       @emission = [0.0, 0.0, 0.0, 1.0]
       @shininess = 30.0;
     end
-  end # class Material
-
-end # module Cosmos
+  end
+end

data/lib/cosmos/gui/opengl/gl_scene.rb

@@ -11,13 +11,20 @@
 require 'cosmos/gui/opengl/gl_bounds'
 
 module Cosmos
-
+  # Creates an OpenGL scene with associated shapes. It defers to the shapes to
+  # draw themselves.
   class GlScene
+    # @return [Array<GlShape>] Shapes to draw in the scene
     attr_reader :shapes
+    # @return [GlBounds] Bounds of the scene
     attr_accessor :bounds
+    # @return [Integer] Zoom factor
     attr_accessor :zoom
+    # @return [Quaternion] Orientation of the scene
     attr_accessor :orientation
+    # @return [Array<Float, Float, Float>] Center of the scene
     attr_accessor :center
+    # @return [Symbol] The type of projection matrix to use :PARALLEL or :PERSPECTIVE
     attr_accessor :projection
 
     def initialize
@@ -67,6 +74,5 @@ module Cosmos
     def append(shape)
       @shapes << shape
     end
-  end # class Material
-
-end # module Cosmos
+  end
+end

data/lib/cosmos/gui/opengl/gl_shape.rb

@@ -12,7 +12,8 @@ require 'cosmos'
 require 'cosmos/gui/opengl/opengl'
 
 module Cosmos
-
+  # Defines an OpenGL shape including its color, position and how to draw it.
+  # These objects should be used within a {GlScene}.
   class GlShape
     attr_accessor :base_color
     attr_accessor :click_handler
@@ -25,7 +26,10 @@ module Cosmos
     attr_accessor :tipText
     attr_accessor :dragable
 
-    #Constructor for the StlShape class
+    # Create a OpenGL shape to be placed in a {GlScene}.
+    # @param x [Integer] Shape center X position
+    # @param y [Integer] Shape center Y position
+    # @param z [Integer] Shape center Z position
     def initialize(x, y, z)
       @color = [0.5, 0.5, 0.5, 1.0]
       @base_color = [0.5, 0.5, 0.5, 1.0]

data/lib/cosmos/gui/opengl/gl_viewer.rb

@@ -15,7 +15,9 @@ require 'cosmos/gui/qt'
 require 'cosmos/gui/opengl/opengl'
 
 module Cosmos
-
+  # Widget which paints an OpenGL scene. Handles user interaction with the
+  # scene by tracking mouse movements to drag objects and scale and pan within
+  # the scene.
   class GlViewer < Qt::GLWidget
     MAX_PICKBUF = 1024
     MAX_SELPATH = 64
@@ -706,7 +708,5 @@ module Cosmos
       @transform.trans4(-@center[0], -@center[1], -@center[2]);
       @itransform = @transform.inverse
     end
-
-  end # class OpenGLViewer
-
-end # module Cosmos
+  end
+end

data/lib/cosmos/gui/opengl/gl_viewport.rb

@@ -9,7 +9,7 @@
 # attribution addendums as found in the LICENSE.txt
 
 module Cosmos
-
+  # Captures all the attributes associated with an OpenGL viewport
   class GlViewport
     attr_accessor :left
     attr_accessor :right
@@ -21,15 +21,14 @@ module Cosmos
     attr_accessor :h
 
     def initialize
-      @left=-1.0;
-      @right=1.0;
-      @top=1.0;
-      @bottom=-1.0;
-      @hither=0.1;
-      @yon=1.0;
-      @w=100;
-      @h=100;
+      @left = -1.0
+      @right = 1.0
+      @top = 1.0
+      @bottom = -1.0
+      @hither = 0.1
+      @yon = 1.0
+      @w = 100
+      @h = 100
     end
-  end # class Viewport
-
-end # module Cosmos
+  end
+end

data/lib/cosmos/gui/opengl/moon_model.rb

@@ -12,11 +12,14 @@ require 'cosmos'
 require 'cosmos/gui/opengl/texture_mapped_sphere'
 
 module Cosmos
-
+  # Three dimensional model of the moon by mapping a picture of the moon onto
+  # a sphere.
   class MoonModel < TextureMappedSphere
+    # @param x (see TextureMappedSphere#initialize)
+    # @param y (see TextureMappedSphere#initialize)
+    # @param z (see TextureMappedSphere#initialize)
     def initialize(x, y, z)
       super(x, y, z, File.join(::Cosmos::PATH, 'data', 'moonmap1k.gif'))
     end
   end
-
-end # module Cosmos
+end

data/lib/cosmos/gui/opengl/stl_reader.rb

@@ -12,9 +12,10 @@ require 'cosmos'
 require 'cosmos/gui/opengl/opengl'
 
 module Cosmos
-
+  # Reads a STL file to build up a number of triangles (x, y, z coordinates)
+  # representing the shape. Implements a draw method to directly render the
+  # triangles into an OpenGL shape.
   class StlReader
-
     attr_accessor :triangles
     attr_accessor :use_cache
 
@@ -134,7 +135,7 @@ module Cosmos
       end
     end
 
-    #Reads up to max_triangles from the file - returns number read
+    # Reads up to max_triangles from the file - returns number read
     def read_triangles_ascii(max_triangles, scaling_factor = 1.0)
       triangle = nil
       read_count = 0
@@ -166,7 +167,7 @@ module Cosmos
       read_count = 0
 
       if @triangles.empty?
-        #Assemble Generic Packet to Read Each Triangle
+        # Assemble Generic Packet to Read Each Triangle
         @packet = Packet.new(nil, nil, :LITTLE_ENDIAN)
         @packet.append_item('normal0', 32, :FLOAT)
         @packet.append_item('normal1', 32, :FLOAT)
@@ -183,10 +184,10 @@ module Cosmos
         @packet.append_item('attribute_length', 16, :UINT)
         @packet.enable_method_missing
 
-        #Read 80 Ascii Characters at beginning of file and throw away
+        # Read 80 Ascii Characters at beginning of file and throw away
         @file.read(80)
 
-        #Read number of facets (triangles) in the file
+        # Read number of facets (triangles) in the file
         @num_facets = @file.read(4)
         @num_facets = @num_facets.unpack('V')[0]
       end
@@ -205,7 +206,5 @@ module Cosmos
 
       return read_count
     end
-
   end
-
-end # module Cosmos
+end

data/lib/cosmos/gui/opengl/stl_shape.rb

@@ -13,7 +13,8 @@ require 'cosmos/gui/opengl/stl_reader'
 require 'cosmos/gui/dialogs/progress_dialog'
 
 module Cosmos
-
+  # Uses a {StlReader} to read a STL file and create an OpenGL shape which can
+  # be rendered in a scene.
   class StlShape < GlShape
     @@splash = nil
 
@@ -122,7 +123,5 @@ module Cosmos
       # Set Pixel Storage Size
       GL.PixelStorei(GL::UNPACK_ALIGNMENT, 1)
     end
-
-  end # StlShape
-
-end # module Cosmos
+  end
+end

data/lib/cosmos/gui/opengl/texture_mapped_sphere.rb

@@ -12,15 +12,17 @@ require 'cosmos'
 require 'cosmos/gui/opengl/gl_shape'
 
 module Cosmos
-
+  # Maps an image onto a 3D sphere in OpenGl.
   class TextureMappedSphere < GlShape
-
+    # @param x (see GlShape#initialize)
+    # @param y (see GlShape#initialize)
+    # @param z (see GlShape#initialize)
+    # @param texture_filename [String] Image filename to load and apply to the
+    #   sphere
     def initialize(x, y, z, texture_filename)
       super(x, y, z)
-
       @vdata = [ [1.0, 0.0, 0.0], [0.0, 1.0, 0.0], [-1.0, 0.0, 0.0], [0.0, -1.0, 0.0],
                  [0.0, 0.0, 1.0], [0.0, 0.0, -1.0]]
-
       @tindices = [ [0,4,1], [1,4,2], [2,4,3], [3,4,0], [1,5,0],
                     [2,5,1], [3,5,2], [0,5,3] ]
 
@@ -196,7 +198,5 @@ module Cosmos
       string << "  ROTATION_Z #{@rotation_z}\n" if @rotation_z
       return string
     end
-
   end
-
-end # module Cosmos
+end

data/lib/cosmos/gui/qt.rb

@@ -805,7 +805,7 @@ end
         if item.layout
           item.removeAll
         else
-          item.widget.dispose
+          item.widget.dispose if item.widget
         end
       end
     end

data/lib/cosmos/gui/qt_tool.rb

@@ -28,11 +28,14 @@ module Cosmos
 
     @@redirect_io_thread = nil
 
-    # Create the main GUI application window. Redirect IO to prevent popups in
-    # the application. Store the options passed from the command line.
+    # Create a new application. IO is redirected such that writing to stdout or
+    # stderr will result in a popup to be displayed to the user. Thus
+    # applications should not write to stdout (i.e. puts or write) or stderr
+    # unless they want a popup titled "Unexpected STD[OUT/ERR] output". By
+    # default the title is set to the options.title and the default COSMOS icon
+    # is set.
     #
-    # @param options [OpenStruct] The command line options passed to the
-    #   application
+    # @param options [OpenStruct] Application command line options
     def initialize(options)
       # Call QT::MainWindow constructor
       super() # MUST BE FIRST - All code before super is executed twice in RubyQt Based classes
@@ -141,7 +144,12 @@ module Cosmos
       unless dirs.empty?
         menu.addSeparator()
         dirs.each do |target_name, dir|
-          action = Qt::Action.new(tr("#{target_name}/#{target_sub_dir}"), self)
+          if target_sub_dir.empty?
+            name = target_name
+          else
+            name = "#{target_name}/#{target_sub_dir}"
+          end
+          action = Qt::Action.new(tr(name), self)
           action.statusTip = status_tip if status_tip
           action.connect(SIGNAL('triggered()')) { callback.call(dir) }
           menu.addAction(action)
@@ -234,7 +242,7 @@ module Cosmos
       super(event)
     end
 
-    # Display the AboutDialog with the @about_string. The @about_string should
+    # Display the {AboutDialog} with the about_string. The about_string should
     # be set by the user in the constructor of their application.
     def about
       AboutDialog.new(self, @about_string)
@@ -245,8 +253,7 @@ module Cosmos
     # will cause the application to exit without being shown. Return true to
     # contine creating the window and execing the application.
     #
-    # @param options [OpenStruct] The application options as configured in the
-    #   command line
+    # @param (see #initialize)
     # @return [Boolean] Whether to contine running the application
     def self.post_options_parsed_hook(options)
       true
@@ -256,14 +263,17 @@ module Cosmos
     # application itself has been created. This is the last chance to execute
     # custom code before the application executes.
     #
-    # @param options [OpenStruct] The application options as configured in the
-    #   command line
+    # @param (see #initialize)
     def self.pre_window_new_hook(options)
     end
 
     # Create the default application options and parse the command line
     # options. Create the application instance and call exec on the
     # Qt::Application.
+    #
+    # @param option_parser [OptionParser] Parses the command line options
+    # @param options [OpenStruct] Stores all the command line options that are
+    #   parsed by the option_parser
     def self.run(option_parser = nil, options = nil)
       Cosmos.set_working_dir do
         option_parser, options = create_default_options() unless option_parser and options
@@ -471,6 +481,7 @@ module Cosmos
       @@redirect_io_thread = nil
     end
 
+    # Unimplemented to provide this method to all QtTools
     def self.graceful_kill
       # Just to remove warning
     end

data/lib/cosmos/gui/text/completion.rb

@@ -17,7 +17,7 @@ module Cosmos
   class Completion < Qt::Completer
     CMD_KEYWORDS = %w(cmd cmd_no_range_check cmd_no_hazardous_check cmd_no_checks
       cmd_raw cmd_raw_no_range_check cmd_raw_no_hazardous_check cmd_raw_no_checks)
-    TLM_KEYWORDS = %w(set_tlm set_tlm_raw
+    TLM_KEYWORDS = %w(set_tlm set_tlm_raw override_tlm override_tlm_raw normalize_tlm
     tlm tlm_raw tlm_formatted tlm_with_units
     limits_enabled? enable_limits disable_limits
     check check_raw check_tolerance check_tolerance_raw
@@ -289,7 +289,11 @@ module Cosmos
             if not target.ignored_parameters.include?(param.name)
               if param.states.nil? or param.states.empty? or raw
                 param.default = "'X' " if param.default.is_a? String and param.default.strip.length == 0
-                parameters << (param.name + ' ' + param.default.to_s + ', ')
+                if param.default.to_s.is_printable?
+                  parameters << (param.name + ' ' + param.default.to_s + ', ')
+                else
+                  parameters << (param.name + ' 0x' + param.default.to_s.simple_formatted + ', ')
+                end
               else
                 states = param.states.keys
                 states.sort!
@@ -338,6 +342,9 @@ module Cosmos
           widget.textCursor.deletePreviousChar
           widget.textCursor.deletePreviousChar
           widget.textCursor.insertText('")')
+        elsif current_line.rstrip =~ /with$/
+          6.times { widget.textCursor.deletePreviousChar }
+          widget.textCursor.insertText('")')
         end
         return
       end
@@ -347,6 +354,20 @@ module Cosmos
         return
       end
 
+      if event.key == Qt::Key_Return
+        # We've already processed the return and moved down a line
+        # Thus we need to move up and check the line before
+        cursor = widget.textCursor
+        cursor.movePosition(Qt::TextCursor::Up)
+        widget.setTextCursor(cursor)
+        current_line = widget.textCursor.block.text
+        indent = current_line.length - current_line.lstrip.length
+        cursor.movePosition(Qt::TextCursor::Down)
+        widget.setTextCursor(cursor)
+        widget.textCursor.insertText(' ' * indent)
+        return
+      end
+
       # Only process if we have an open paren which indicates a function
       if current_line =~ /\(/
         split_on_paren = current_line.split('(')[0]

data/lib/cosmos/gui/text/completion_text_edit.rb

@@ -15,8 +15,6 @@ require 'cosmos/gui/dialogs/splash'
 module Cosmos
 
   class CompletionTextEdit < Qt::PlainTextEdit
-    slots 'highlight_line()'
-
     TRUE_VARIANT = Qt::Variant.new(true)
     SELECTION_DETAILS_POOL = []
 
@@ -51,6 +49,28 @@ module Cosmos
       end
     end
 
+    def line_number
+      textCursor.blockNumber + 1
+    end
+
+    def column_number
+      textCursor.positionInBlock + 1
+    end
+
+    def current_line
+      textCursor.block.text
+    end
+
+    def previous_line(number = 1)
+      block = textCursor.block
+      number.times { block = block.previous }
+      block.text
+    end
+
+    def get_line(line_number)
+      textCursor.document.findBlockByLineNumber(line_number).text
+    end
+
     def dispose
       super()
       @cursor.dispose
@@ -145,24 +165,24 @@ module Cosmos
       cursor.endEditBlock
     end
 
-    def highlight_line(line, color = 'palegreen') #102, 255, 102
-      color = Cosmos::getColor(color)
-      # Store the line number in case we need to rehighlight this line
-      @last_hightlighted_line = line
-      brush = Cosmos.getBrush(color)
+    def highlight_line(color = 'palegreen') #102, 255, 102
+      brush = Cosmos.getBrush(Cosmos::getColor(color))
       @selection_details.format.setBackground(brush)
-      # Get the textCursor and move it to the specified line
-      @cursor.movePosition(Qt::TextCursor::Start)
-      # The line number is based in 1 based but the PlainTextEdit is 0 based
-      @cursor.movePosition(Qt::TextCursor::Down, Qt::TextCursor::MoveAnchor, line-1)
-      @cursor.clearSelection
-      # By setting the text cursor after moving it we ensure we can see the highlight
-      # If we just called setExtraSelections without setting the cursor we might not be able to see it
-      setTextCursor(@cursor)
       @selection_details.selection.format = @selection_details.format
-      @selection_details.selection.cursor = @cursor
+      # We can use the textCursor directly since we're not changing it
+      @selection_details.selection.cursor = textCursor
       setExtraSelections([@selection_details.selection])
-      # Center the cursor to ensure it is visible
+    end
+
+    def center_line(line_number = nil)
+      if line_number
+        # Get the textCursor and move it to the start
+        @cursor.movePosition(Qt::TextCursor::Start)
+        # Move down to the specified line number
+        # The line number is 1 based but the PlainTextEdit is 0 based
+        @cursor.movePosition(Qt::TextCursor::Down, Qt::TextCursor::MoveAnchor, line_number - 1)
+        setTextCursor(@cursor)
+      end
       centerCursor()
     end
 
@@ -170,10 +190,5 @@ module Cosmos
       # Clearing the extra selections with a nil array clears the selection
       self.setExtraSelections([])
     end
-
-    def rehighlight(color = 'palegreen')
-      highlight_line(@last_hightlighted_line, color)
-    end
   end
-
-end # module Cosmos
+end