Development/Tutorials/Qt4 Ruby Tutorial/Chapter 12: Difference between revisions

    From KDE TechBase
    m (Text replace - "</code>" to "</syntaxhighlight>")
    (add translate tags)
    Line 1: Line 1:
    <languages />
    {{Template:I18n/Language Navigation Bar|Development/Tutorials/Qt4 Ruby Tutorial/Chapter 12}}
    {{Template:I18n/Language Navigation Bar|Development/Tutorials/Qt4 Ruby Tutorial/Chapter 12}}


    {{TutorialBrowser|
    {{<translate>TutorialBrowser</translate>|
     
    series=[[Special:myLanguage/Development/Tutorials/Qt4_Ruby_Tutorial|<translate>Qt4 Ruby Tutorial</translate>]]|
    series=[[Development/Tutorials/Qt4_Ruby_Tutorial|Qt4 Ruby Tutorial]]|
    name=<translate>Hanging in the Air the Way Bricks Don't</translate>|
     
    pre=[[Special:myLanguage/Development/Tutorials/Qt4_Ruby_Tutorial/Chapter_11|<translate>Tutorial 11 - Giving It a Shot</translate>]]|
    name=Hanging in the Air the Way Bricks Don't|
    next=[[Special:myLanguage/Development/Tutorials/Qt4_Ruby_Tutorial/Chapter_13|<translate>Tutorial 13 - Game Over</translate>]]
     
    pre=[[Development/Tutorials/Qt4_Ruby_Tutorial/Chapter_11|Tutorial 11 - Giving It a Shot]]|
     
    next=[[Development/Tutorials/Qt4_Ruby_Tutorial/Chapter_13|Tutorial 13 - Game Over]]
    }}
    }}
    <translate>
    == Hanging in the Air the Way Bricks Don't ==
    == Hanging in the Air the Way Bricks Don't ==
    </translate>
    <translate>
    [[Image:Qt4_Ruby_Tutorial_Screenshot_12.png|center]]
    [[Image:Qt4_Ruby_Tutorial_Screenshot_12.png|center]]
    </translate>
    <translate>
    Files:
    Files:
    </translate>
    * [http://www.darshancomputing.com/qt4-qtruby-tutorial/tutorial/t12/lcdrange.rb lcdrange.rb]
    * [http://www.darshancomputing.com/qt4-qtruby-tutorial/tutorial/t12/lcdrange.rb lcdrange.rb]
    * [http://www.darshancomputing.com/qt4-qtruby-tutorial/tutorial/t12/t12.rb t12.rb]
    * [http://www.darshancomputing.com/qt4-qtruby-tutorial/tutorial/t12/t12.rb t12.rb]
    * [http://www.darshancomputing.com/qt4-qtruby-tutorial/tutorial/t12/cannon.rb cannon.rb]
    * [http://www.darshancomputing.com/qt4-qtruby-tutorial/tutorial/t12/cannon.rb cannon.rb]


    <translate>
    === Overview ===
    === Overview ===
    In this example, we extend our '''<tt>LCDRange</tt>''' class to include a text label. We also provide something to shoot at.   
    In this example, we extend our '''<tt>LCDRange</tt>''' class to include a text label. We also provide something to shoot at.   


    === Line by Line Walkthrough ===
    === Line by Line Walkthrough ===
    </translate>
    '''[http://www.darshancomputing.com/qt4-qtruby-tutorial/tutorial/t12/lcdrange.rb lcdrange.rb]'''
    '''[http://www.darshancomputing.com/qt4-qtruby-tutorial/tutorial/t12/lcdrange.rb lcdrange.rb]'''


    Line 32: Line 39:
    </syntaxhighlight>
    </syntaxhighlight>


    <translate>
    This constructor first calls '''<tt>init()</tt>''' and then sets the label text. '''<tt>init()</tt>''' is a separate function performing initialization mosty because of function overloading matters in the original C++ version.
    This constructor first calls '''<tt>init()</tt>''' and then sets the label text. '''<tt>init()</tt>''' is a separate function performing initialization mosty because of function overloading matters in the original C++ version.
    </translate>


    <syntaxhighlight lang="ruby">
    <syntaxhighlight lang="ruby">
    Line 61: Line 70:
    </syntaxhighlight>
    </syntaxhighlight>


    <translate>
    The setup of '''<tt>lcd</tt>''' and '''<tt>slider</tt>''' is the same as in the previous chapter. Next we create a [http://doc.qt.nokia.com/latest/qlabel.html Qt::Label] and tell it to align the contents centered horizontally and to the top vertically. The [http://doc.qt.nokia.com/latest/qobject.html#connect Qt::Object::connect()] calls have also been taken from the previous chapter.
    The setup of '''<tt>lcd</tt>''' and '''<tt>slider</tt>''' is the same as in the previous chapter. Next we create a [http://doc.qt.nokia.com/latest/qlabel.html Qt::Label] and tell it to align the contents centered horizontally and to the top vertically. The [http://doc.qt.nokia.com/latest/qobject.html#connect Qt::Object::connect()] calls have also been taken from the previous chapter.
    </translate>


    <syntaxhighlight lang="ruby">
    <syntaxhighlight lang="ruby">
    Line 69: Line 80:
    </syntaxhighlight>
    </syntaxhighlight>


    <translate>
    This function sets the label text.
    This function sets the label text.
    </translate>


    '''[http://www.darshancomputing.com/qt4-qtruby-tutorial/tutorial/t12/cannon.rb cannon.rb]'''
    '''[http://www.darshancomputing.com/qt4-qtruby-tutorial/tutorial/t12/cannon.rb cannon.rb]'''


    <translate>
    The '''<tt>CannonField</tt>''' now has two new signals: '''<tt>hit()</tt>''' and '''<tt>missed()</tt>'''. In addition, it contains a target.
    The '''<tt>CannonField</tt>''' now has two new signals: '''<tt>hit()</tt>''' and '''<tt>missed()</tt>'''. In addition, it contains a target.
    </translate>


    <syntaxhighlight lang="ruby">
    <syntaxhighlight lang="ruby">
    Line 79: Line 94:
    </syntaxhighlight>
    </syntaxhighlight>


    <translate>
    The '''<tt>hit()</tt>''' signal is emitted when a shot hits the target. The '''<tt>missed()</tt>''' signal is emitted when the shot moves beyond the right or bottom edge of the widget (i.e., it is certain that it has not and will not hit the target).
    The '''<tt>hit()</tt>''' signal is emitted when a shot hits the target. The '''<tt>missed()</tt>''' signal is emitted when the shot moves beyond the right or bottom edge of the widget (i.e., it is certain that it has not and will not hit the target).
    </translate>


    <syntaxhighlight lang="ruby">
    <syntaxhighlight lang="ruby">
    Line 85: Line 102:
    </syntaxhighlight>
    </syntaxhighlight>


    <translate>
    This line has been added to the constructor. It creates a "random" position for the target. In fact, the '''<tt>newTarget()</tt>''' function will try to paint the target. Because we are in a constructor, the '''<tt>CannonField</tt>''' widget is invisible. Qt guarantees that no harm is done when calling [http://doc.qt.nokia.com/latest/qwidget.html#update Qt::Widget::update()] on a hidden widget.
    This line has been added to the constructor. It creates a "random" position for the target. In fact, the '''<tt>newTarget()</tt>''' function will try to paint the target. Because we are in a constructor, the '''<tt>CannonField</tt>''' widget is invisible. Qt guarantees that no harm is done when calling [http://doc.qt.nokia.com/latest/qwidget.html#update Qt::Widget::update()] on a hidden widget.
    </translate>


    <syntaxhighlight lang="ruby">
    <syntaxhighlight lang="ruby">
    Line 102: Line 121:
    </syntaxhighlight>
    </syntaxhighlight>


    <translate>
    This function creates a target center point at a new random position.
    This function creates a target center point at a new random position.


    Line 109: Line 129:


    By experimentation we have found this to always be in reach of the shot.
    By experimentation we have found this to always be in reach of the shot.
    </translate>


    <syntaxhighlight lang="ruby">
    <syntaxhighlight lang="ruby">
    Line 118: Line 139:
    </syntaxhighlight>
    </syntaxhighlight>


    <translate>
    This part of the timer event has not changed from the previous chapter.
    This part of the timer event has not changed from the previous chapter.
    </translate>


    <syntaxhighlight lang="ruby">
    <syntaxhighlight lang="ruby">
    Line 126: Line 149:
    </syntaxhighlight>
    </syntaxhighlight>


    <translate>
    This '''<tt>if</tt>''' statement checks whether the shot rectangle intersects the target rectangle. If it does, the shot has hit the target (ouch!). We stop the shoot timer and emit the '''<tt>hit()</tt>''' signal to tell the outside world that a target was destroyed, and return. Note that we could have created a new target on the spot, but because the '''<tt>CannonField</tt>''' is a component we leave such decisions to the user of the component.
    This '''<tt>if</tt>''' statement checks whether the shot rectangle intersects the target rectangle. If it does, the shot has hit the target (ouch!). We stop the shoot timer and emit the '''<tt>hit()</tt>''' signal to tell the outside world that a target was destroyed, and return. Note that we could have created a new target on the spot, but because the '''<tt>CannonField</tt>''' is a component we leave such decisions to the user of the component.
    </translate>


    <syntaxhighlight lang="ruby">
    <syntaxhighlight lang="ruby">
    Line 134: Line 159:
    </syntaxhighlight>
    </syntaxhighlight>


    <translate>
    This is the same as in the previous chapter, except that it now emits the '''<tt>missed()</tt>''' signal to tell the outside world about the failure.
    This is the same as in the previous chapter, except that it now emits the '''<tt>missed()</tt>''' signal to tell the outside world about the failure.
    </translate>


    <syntaxhighlight lang="ruby">
    <syntaxhighlight lang="ruby">
    Line 145: Line 172:
    </syntaxhighlight>
    </syntaxhighlight>


    <translate>
    And the rest of the function is as before.
    And the rest of the function is as before.


    '''<tt>CannonField::paintEvent()</tt>''' is as before, except that this has been added:
    '''<tt>CannonField::paintEvent()</tt>''' is as before, except that this has been added:
    </translate>


    <syntaxhighlight lang="ruby">
    <syntaxhighlight lang="ruby">
         paintTarget(painter)
         paintTarget(painter)
    </syntaxhighlight>
    </syntaxhighlight>
    <translate>
    This line makes sure that the target is also painted when necessary.
    This line makes sure that the target is also painted when necessary.
    </translate>


    <syntaxhighlight lang="ruby">
    <syntaxhighlight lang="ruby">
    Line 162: Line 194:
    </syntaxhighlight>
    </syntaxhighlight>


    <translate>
    This function paints the target; a rectangle filled with red and with a black outline.
    This function paints the target; a rectangle filled with red and with a black outline.
    </translate>


    <syntaxhighlight lang="ruby">
    <syntaxhighlight lang="ruby">
    Line 172: Line 206:
    </syntaxhighlight>
    </syntaxhighlight>


    <translate>
    This private function returns the enclosing rectangle of the target. Remember from '''<tt>newTarget()</tt>''' that the '''<tt>target</tt>''' point uses y coordinate 0 at the bottom of the widget. We calculate the point in widget coordinates before we call [http://doc.qt.nokia.com/latest/qrect.html#moveCenter Qt::Rect::moveCenter()].
    This private function returns the enclosing rectangle of the target. Remember from '''<tt>newTarget()</tt>''' that the '''<tt>target</tt>''' point uses y coordinate 0 at the bottom of the widget. We calculate the point in widget coordinates before we call [http://doc.qt.nokia.com/latest/qrect.html#moveCenter Qt::Rect::moveCenter()].


    The reason we have chosen this coordinate mapping is to fix the distance between the target and the bottom of the widget. Remember that the widget can be resized by the user or the program at any time.
    The reason we have chosen this coordinate mapping is to fix the distance between the target and the bottom of the widget. Remember that the widget can be resized by the user or the program at any time.
    </translate>


    '''[http://www.darshancomputing.com/qt4-qtruby-tutorial/tutorial/t12/t12.rb t12.rb]'''
    '''[http://www.darshancomputing.com/qt4-qtruby-tutorial/tutorial/t12/t12.rb t12.rb]'''


    <translate>
    There are no new members in the '''<tt>MyWidget</tt>''' class, but we have slightly changed the constructor to set the new '''<tt>LCDRange</tt>''' text labels.
    There are no new members in the '''<tt>MyWidget</tt>''' class, but we have slightly changed the constructor to set the new '''<tt>LCDRange</tt>''' text labels.
    </translate>


    <syntaxhighlight lang="ruby">
    <syntaxhighlight lang="ruby">
    Line 184: Line 222:
    </syntaxhighlight>
    </syntaxhighlight>


    <translate>
    We set the angle text label to "ANGLE".
    We set the angle text label to "ANGLE".
    </translate>


    <syntaxhighlight lang="ruby">
    <syntaxhighlight lang="ruby">
    Line 190: Line 230:
    </syntaxhighlight>
    </syntaxhighlight>


    <translate>
    We set the force text label to "FORCE".
    We set the force text label to "FORCE".
    </translate>


    <translate>
    === Running the Application ===
    === Running the Application ===
    The '''<tt>LCDRange</tt>''' widgets look a bit strange: When resizing '''<tt>MyWidget</tt>''', the built-in layout management in [http://doc.qt.nokia.com/latest/qvboxlayout.html Qt::VBoxLayout] gives the labels too much space and the rest not enough; making the space between the two '''<tt>LCDRange</tt>''' widgets change size. We'll fix that in the next chapter
    The '''<tt>LCDRange</tt>''' widgets look a bit strange: When resizing '''<tt>MyWidget</tt>''', the built-in layout management in [http://doc.qt.nokia.com/latest/qvboxlayout.html Qt::VBoxLayout] gives the labels too much space and the rest not enough; making the space between the two '''<tt>LCDRange</tt>''' widgets change size. We'll fix that in the next chapter


    === Exercises ===
    === Exercises ===
    Make a cheat button that, when pressed, makes the '''<tt>CannonField</tt>''' display the shot trajectory for five seconds.
    Make a cheat button that, when pressed, makes the '''<tt>CannonField</tt>''' display the shot trajectory for five seconds.


    Line 209: Line 254:


    [[Category:Ruby]]
    [[Category:Ruby]]
    </translate>

    Revision as of 23:46, 1 July 2011

    Other languages:


    Development/Tutorials/Qt4 Ruby Tutorial/Chapter 12


    Hanging in the Air the Way Bricks Don't
    Tutorial Series   Qt4 Ruby Tutorial
    Previous   Tutorial 11 - Giving It a Shot
    What's Next   Tutorial 13 - Game Over
    Further Reading   n/a

    Hanging in the Air the Way Bricks Don't

    Files:

    Overview

    In this example, we extend our LCDRange class to include a text label. We also provide something to shoot at.

    Line by Line Walkthrough

    lcdrange.rb

    def initialize(s, parent = nil)
      super(parent)
      init()
      setText(s)
    end
    

    This constructor first calls init() and then sets the label text. init() is a separate function performing initialization mosty because of function overloading matters in the original C++ version.

    def init()
      lcd = Qt::LCDNumber.new(2)
      lcd.setSegmentStyle(Qt::LCDNumber::Filled)
    
      @slider = Qt::Slider.new(Qt::Horizontal)
      @slider.setRange(0, 99)
      @slider.setValue(0)
    
      @label = Qt::Label.new()
      @label.setAlignment(Qt::AlignHCenter.to_i | Qt::AlignTop.to_i)
    
      connect(@slider, SIGNAL('valueChanged(int)'),
      lcd, SLOT('display(int)'))
      connect(@slider, SIGNAL('valueChanged(int)'),
      self, SIGNAL('valueChanged(int)'))
    
      layout = Qt::VBoxLayout.new()
      layout.addWidget(lcd)
      layout.addWidget(@slider)
      layout.addWidget(@label)
      setLayout(layout)
    
      setFocusProxy(@slider)
    end
    

    The setup of lcd and slider is the same as in the previous chapter. Next we create a Qt::Label and tell it to align the contents centered horizontally and to the top vertically. The Qt::Object::connect() calls have also been taken from the previous chapter.

    def setText(s)
      @label.setText(s)
    end
    

    This function sets the label text.

    cannon.rb

    The CannonField now has two new signals: hit() and missed(). In addition, it contains a target.

      signals 'hit()', 'missed()' #...
    

    The hit() signal is emitted when a shot hits the target. The missed() signal is emitted when the shot moves beyond the right or bottom edge of the widget (i.e., it is certain that it has not and will not hit the target).

        newTarget()
    

    This line has been added to the constructor. It creates a "random" position for the target. In fact, the newTarget() function will try to paint the target. Because we are in a constructor, the CannonField widget is invisible. Qt guarantees that no harm is done when calling Qt::Widget::update() on a hidden widget.

    @@first_time = true
    
    def newTarget()
      if @@first_time
        @@first_time = false
        midnight = Qt::Time.new(0, 0, 0)
        srand(midnight.secsTo(Qt::Time.currentTime()))
      end
    
      @target = Qt::Point.new(200 + rand(190), 10 + rand(255))
      update()
    end
    

    This function creates a target center point at a new random position.

    We create the Qt::Time object midnight, which represents the time 00:00:00. Next we fetch the number of seconds from midnight until now and use it as a random seed. See the documentation for Qt::Date, Qt::Time, and Qt::DateTime for more information.

    Finally we calculate the target's center point. We keep it within the rectangle (x = 200, y = 35, width = 190, height = 255), i.e., the possible x and y values are 200 to 389 and 35 to 289, respectively) in a coordinate system where we put y position 0 at the bottom edge of the widget and let y values increase upwards x is as normal, with 0 at the left edge and with x values increasing to the right.

    By experimentation we have found this to always be in reach of the shot.

    def moveShot()
      region = Qt::Region.new(shotRect())
      @timerCount += 1
    
      shotR = shotRect()
    

    This part of the timer event has not changed from the previous chapter.

    if shotR.intersects(targetRect()) 
      @autoShootTimer.stop()
      emit hit()
    

    This if statement checks whether the shot rectangle intersects the target rectangle. If it does, the shot has hit the target (ouch!). We stop the shoot timer and emit the hit() signal to tell the outside world that a target was destroyed, and return. Note that we could have created a new target on the spot, but because the CannonField is a component we leave such decisions to the user of the component.

    elsif shotR.x() > width() || shotR.y() > height()
      @autoShootTimer.stop()
      emit missed()
    

    This is the same as in the previous chapter, except that it now emits the missed() signal to tell the outside world about the failure.

      else
        region = region.unite(Qt::Region.new(shotR))
      end
        
      update(region)
    end
    

    And the rest of the function is as before.

    CannonField::paintEvent() is as before, except that this has been added:

        paintTarget(painter)
    

    This line makes sure that the target is also painted when necessary.

    def paintTarget(painter)
      painter.setBrush(Qt::Brush.new(Qt::red))
      painter.setPen(Qt::Pen.new(Qt::Color.new(Qt::black)))
      painter.drawRect(targetRect())
    end
    

    This function paints the target; a rectangle filled with red and with a black outline.

    def targetRect()
      result = Qt::Rect.new(0, 0, 20, 10)
      result.moveCenter(Qt::Point.new(@target.x(), height() - 1 - @target.y()))
      return result
    end
    

    This private function returns the enclosing rectangle of the target. Remember from newTarget() that the target point uses y coordinate 0 at the bottom of the widget. We calculate the point in widget coordinates before we call Qt::Rect::moveCenter().

    The reason we have chosen this coordinate mapping is to fix the distance between the target and the bottom of the widget. Remember that the widget can be resized by the user or the program at any time.

    t12.rb

    There are no new members in the MyWidget class, but we have slightly changed the constructor to set the new LCDRange text labels.

        angle = LCDRange.new(tr('ANGLE'))
    

    We set the angle text label to "ANGLE".

        force  = LCDRange.new(tr('FORCE'))
    

    We set the force text label to "FORCE".

    Running the Application

    The LCDRange widgets look a bit strange: When resizing MyWidget, the built-in layout management in Qt::VBoxLayout gives the labels too much space and the rest not enough; making the space between the two LCDRange widgets change size. We'll fix that in the next chapter

    Exercises

    Make a cheat button that, when pressed, makes the CannonField display the shot trajectory for five seconds.

    If you did the "round shot" exercise from the previous chapter, try changing the shotRect() to a shotRegion() that returns a Qt::Region so you can have really accurate collision detection.

    Make a moving target.

    Make sure that the target is always created entirely on-screen.

    Make sure that the widget cannot be resized so that the target isn't visible. [Hint: Qt::Widget::setMinimumSize() is your friend.]

    Not easy; make it possible to have several shots in the air at the same time. [Hint: Make a Shot class.]