rubysketch 0.9.4 → 0.10.0

data/lib/rubysketch/sprite.rb

@@ -54,8 +54,7 @@ module RubySketch
     #  @param [Shape]   shp shape of the sprite for physics calculations
     #
     def initialize(
-      x = 0, y = 0, w = nil, h = nil, image: nil, offset: nil, shape: nil,
-      physics: true, context: nil)
+      x = 0, y = 0, w = nil, h = nil, image: nil, offset: nil, shape: nil, physics: true)
 
       w ||= (image&.width  || shape&.width  || 0)
       h ||= (image&.height || shape&.height || 0)
@@ -63,7 +62,7 @@ module RubySketch
       raise 'invalid image' if image && !image.getInternal__.is_a?(Rays::Image)
       raise 'invalid shape' if shape && !shape.getInternal__.is_a?(Reflex::Shape)
 
-      @context__ = context || Context.current__
+      @world__   = nil
       @shape__   = shape
       @view__    = View.new(
         self, x: x, y: y, w: w, h: h,
@@ -162,7 +161,6 @@ module RubySketch
     #
     def x=(n)
       @view__.x = n
-      n
     end
 
     # Returns the y-coordinate position of the sprite.
@@ -181,7 +179,6 @@ module RubySketch
     #
     def y=(n)
       @view__.y = n
-      n
     end
 
     # Returns the z-coordinate position of the sprite.
@@ -200,7 +197,6 @@ module RubySketch
     #
     def z=(n)
       @view__.z = n
-      n
     end
 
     alias pos  position
@@ -222,7 +218,6 @@ module RubySketch
     #
     def left=(n)
       @view__.left = n
-      n
     end
 
     # Returns the top position of the sprite.
@@ -311,7 +306,7 @@ module RubySketch
       @view__.size.toVector
     end
 
-    # Returns the size of the sprite.
+    # Sets the size of the sprite.
     #
     # @return [Vector] size
     #
@@ -366,7 +361,7 @@ module RubySketch
     # @return [Numeric] radians or degrees depending on angleMode()
     #
     def angle()
-      @context__.fromDegrees__ @view__.angle
+      getContext__.fromDegrees__ @view__.angle
     end
 
     # Sets the rotation angle of the sprite.
@@ -376,7 +371,7 @@ module RubySketch
     # @return [Numeric] angle
     #
     def angle=(angle)
-      @view__.angle = @context__.toDegrees__ angle
+      @view__.angle = getContext__.toDegrees__ angle
       angle
     end
 
@@ -458,7 +453,6 @@ module RubySketch
     #
     def vx=(n)
       @view__.velocity = @view__.velocity.tap {|v| v.x = n}
-      n
     end
 
     # Returns the y-axis velocity of the sprite.
@@ -477,7 +471,6 @@ module RubySketch
     #
     def vy=(n)
       @view__.velocity = @view__.velocity.tap {|v| v.y = n}
-      n
     end
 
     alias vel  velocity
@@ -546,7 +539,6 @@ module RubySketch
     #
     def ox=(x)
       self.offset = [x, oy]
-      x
     end
 
     # Returns the y-axis offset of the sprite image.
@@ -565,7 +557,6 @@ module RubySketch
     #
     def oy=(y)
       self.offset = [ox, y]
-      y
     end
 
     # Returns whether the sprite is movable by the physics engine.
@@ -584,7 +575,6 @@ module RubySketch
     #
     def dynamic=(bool)
       @view__.dynamic = bool
-      bool
     end
 
     # Returns the density of the sprite.
@@ -603,7 +593,6 @@ module RubySketch
     #
     def density=(n)
       @view__.density = n
-      n
     end
 
     # Returns the friction of the sprite.
@@ -622,7 +611,6 @@ module RubySketch
     #
     def friction=(n)
       @view__.friction = n
-      n
     end
 
     # Returns the restitution of the sprite.
@@ -641,7 +629,6 @@ module RubySketch
     #
     def restitution=(n)
       @view__.restitution = n
-      n
     end
 
     alias dens  density
@@ -688,16 +675,90 @@ module RubySketch
 
     # @deprecated Use {#gravityScale=} instead.
     def gravity_scale=(scale)
-      warn "Sprite#gravity_scale= is deprecated, use #gravityScale= instead", uniq: true
+      Xot.warn "Sprite#gravity_scale= is deprecated, use #gravityScale= instead", uniq: true
       self.gravityScale = scale
     end
 
     # @deprecated Use {#gravityScale} instead.
     def gravity_scale()
-      warn "Sprite#gravity_scale is deprecated, use #gravityScale instead", uniq: true
+      Xot.warn "Sprite#gravity_scale is deprecated, use #gravityScale instead", uniq: true
       gravityScale
     end
 
+    # Creates a pin that fastens a point on the sprite.
+    #
+    # @overload pin()
+    #  a pin at the center of the sprite
+    # @overload pin(x, y)
+    #  @param [Numeric] x x of the sprite-local position
+    #  @param [Numeric] y y of the sprite-local position
+    #
+    # @return [Pin] a new pin
+    #
+    def pin(x = nil, y = nil)
+      Pin.new self, x, y
+    end
+
+    # Creates a constraint that makes the center of the sprite and the
+    # target point coincide.
+    #
+    # @param [Sprite, Pin, Vector, Array<Numeric>, nil] target
+    #  the center of a sprite, a pin, or a point in the world.
+    #  snaps to the world when target is omitted
+    #
+    # @return [SnapConstraint] a new constraint
+    #
+    def snap(*args, **options, &block)
+      pin.snap(*args, **options, &block)
+    end
+
+    # Creates a constraint that keeps the distance between the center of
+    # the sprite and the target point.
+    #
+    # @param [Sprite, Pin, Vector, Array<Numeric>, nil] target
+    #  the center of a sprite, a pin, or a point in the world.
+    #  links to the world when target is omitted
+    #
+    # @return [LinkConstraint] a new constraint
+    #
+    def link(*args, **options, &block)
+      pin.link(*args, **options, &block)
+    end
+
+    # Creates a constraint that makes the sprite ride on the target like
+    # a wheel: it slides along an axis for the suspension and spins freely.
+    #
+    # @param [Sprite, Pin, Vector, Array<Numeric>, nil] target
+    #  the center of a sprite, a pin, or a point in the world.
+    #  rides on the world when target is omitted
+    #
+    # @return [WheelConstraint] a new constraint
+    #
+    def wheel(*args, **options, &block)
+      pin.wheel(*args, **options, &block)
+    end
+
+    # Creates a constraint that moves the sprite toward the target every
+    # frame.
+    #
+    # @param [Sprite, Pin, Vector, Array<Numeric>, nil] target
+    #  the center of a sprite, a pin, or a point in the world.
+    #  chases nothing when target is omitted
+    #
+    # @return [ChaseConstraint] a new constraint
+    #
+    def chase(*args, **options, &block)
+      pin.chase(*args, **options, &block)
+    end
+
+    # Returns the constraints fastened to the sprite.
+    #
+    # @return [Array<Constraint>] constraints
+    #
+    def constraints()
+      @view__.constraints.map {|c| Constraint.wrap__ c}
+    end
+
     # Converts a vector from the screen coordinate
     #
     # @param [Vector] vec screen coordinate vector
@@ -943,6 +1004,34 @@ module RubySketch
       nil
     end
 
+    # Defines mouseOver block.
+    #
+    # @example Highlight the sprite while hovered
+    #  sprite.mouseOver do
+    #    $hovered = true
+    #  end
+    #
+    # @return [Boolean] is the mouse over the sprite or not
+    #
+    def mouseOver(&block)
+      setViewBlock__ :mouseOver, block if block
+      @view__.mouseOver?
+    end
+
+    # Defines mouseOut block.
+    #
+    # @example Unhighlight the sprite on unhover
+    #  sprite.mouseOut do
+    #    $hovered = false
+    #  end
+    #
+    # @return [nil] nil
+    #
+    def mouseOut(&block)
+      setViewBlock__ :mouseOut, block if block
+      nil
+    end
+
     # Defines mouseWheel block.
     #
     # @example Print wheel states on mouse wheel
@@ -1046,6 +1135,21 @@ module RubySketch
       @view__
     end
 
+    # @private
+    def setWorld__(world)
+      @world__ = world
+    end
+
+    # @private
+    def getWorld__()
+      @world__
+    end
+
+    # @private
+    def getContext__()
+      @world__&.getContext__ || Processing.context
+    end
+
     # @private
     def drawSprite__(c)
       return if hidden?
@@ -1086,9 +1190,9 @@ module RubySketch
 
     # @private
     def setViewBlock__(name, block)
-      c = @context__
+      self_ = self
       @view__.__send__ "#{name}=", block && (proc do |*a, **k, &b|
-        prev, $processing_context__ = $processing_context__, c
+        prev, $processing_context__ = $processing_context__, self_.getContext__
         block.call(*a, **k, &b)
       ensure
         $processing_context__       = prev
@@ -1105,7 +1209,8 @@ module RubySketch
     # Create a new physics world.
     #
     def initialize(pixelsPerMeter: 0)
-      @view, @debug = View.new(pixelsPerMeter: pixelsPerMeter), false
+      @context, @sprites, @debug = nil, [], false
+      @view                      = View.new pixelsPerMeter: pixelsPerMeter
     end
 
     # Creates a new sprite and add it to physics engine.
@@ -1156,35 +1261,48 @@ module RubySketch
     #
     # @return [Sprite] the new sprite object
     #
-    def createSprite(*args, klass: nil, context: nil, **kwargs)
-      klass   ||= RubySketch::Sprite
-      context ||= Context.current__
-      addSprite klass.new(*args, context: context, **kwargs)
+    def createSprite(*args, klass: nil, **kwargs)
+      klass ||= RubySketch::Sprite
+      addSprite klass.new(*args, **kwargs)
     end
 
     # Adds sprite to the physics engine.
     #
-    # @param [Array]  array user array to store the sprite
     # @param [Sprite] sprite sprite object
+    # @param [Array]  to     user array to store the sprite
     #
     # @return [Sprite] the added sprite
     #
-    def addSprite(array = nil, sprite)
+    def addSprite(sprite, deprecatedSprite__ = nil, to: nil)
+      if sprite.is_a?(Array)
+        Xot.warn "addSprite(array, sprite) is deprecated; use addSprite(sprite, to: array) instead", uniq: true
+        sprite, to = deprecatedSprite__, sprite
+      end
+      raise ArgumentError if sprite.getWorld__
       @view.add sprite.getInternal__
-      array&.push sprite
+      @sprites.push sprite
+      to.push sprite if to
+      sprite.setWorld__ self
       sprite
     end
 
     # Removes sprite from the physics engine.
     #
-    # @param [Array]  array user array to remove the sprite
     # @param [Sprite] sprite sprite object
+    # @param [Array]  from   user array to remove the sprite
     #
     # @return [Sprite] the removed sprite
     #
-    def removeSprite(array = nil, sprite)
+    def removeSprite(sprite, deprecatedSprite__ = nil, from: nil)
+      if sprite.is_a?(Array)
+        Xot.warn "removeSprite(array, sprite) is deprecated; use removeSprite(sprite, from: array) instead", uniq: true
+        sprite, from = deprecatedSprite__, sprite
+      end
+      raise ArgumentError if sprite.getWorld__ != self
       @view.remove sprite.getInternal__
-      array&.delete sprite
+      @sprites.delete sprite
+      from.delete sprite if from
+      sprite.setWorld__ nil
       sprite
     end
 
@@ -1213,16 +1331,250 @@ module RubySketch
       nil
     end
 
-    # Returns the offset of the sprite world.
+    # Returns the position of the world.
+    #
+    # @return [Vector] position
+    #
+    def position()
+      @view.position.toVector
+    end
+
+    # Sets the position of the world.
+    #
+    # @overload position=(vec)
+    #  @param [Vector] vec position vector
+    #
+    # @overload position=(ary)
+    #  @param [Array<Numeric>] ary an array of positionX and positionY
+    #
+    # @return [Vector] position
+    #
+    def position=(arg)
+      @view.position = arg.is_a?(Vector) ? arg.getInternal__ : arg
+      arg
+    end
+
+    # Returns the x-coordinate position of the world.
+    #
+    # @return [Numeric] world position x
+    #
+    def x()
+      @view.x
+    end
+
+    # Set the x-coordinate position of the world.
+    #
+    # @param [Numeric] n world position x
+    #
+    # @return [Numeric] world position x
+    #
+    def x=(n)
+      @view.x = n
+    end
+
+    # Returns the y-coordinate position of the world.
+    #
+    # @return [Numeric] world position y
+    #
+    def y()
+      @view.y
+    end
+
+    # Set the y-coordinate position of the world.
+    #
+    # @param [Numeric] n world position y
+    #
+    # @return [Numeric] world position y
+    #
+    def y=(n)
+      @view.y = n
+    end
+
+    # Returns the z-coordinate position of the world.
+    #
+    # @return [Numeric] world position z
+    #
+    def z()
+      @view.z
+    end
+
+    # Set the z-coordinate position of the world.
+    #
+    # @param [Numeric] n world position z
+    #
+    # @return [Numeric] world position z
+    #
+    def z=(n)
+      @view.z = n
+    end
+
+    alias pos  position
+    alias pos= position=
+
+    # Returns the left position of the world.
+    #
+    # @return [Numeric] left position
+    #
+    def left()
+      @view.left
+    end
+
+    # Set the left position of the world.
+    #
+    # @param [Numeric] n world left position
+    #
+    # @return [Numeric] world left position
+    #
+    def left=(n)
+      @view.left = n
+    end
+
+    # Returns the top position of the world.
+    #
+    # @return [Numeric] top position
+    #
+    def top()
+      @view.top
+    end
+
+    # Set the top position of the world.
+    #
+    # @param [Numeric] n world top position
+    #
+    # @return [Numeric] world top position
+    #
+    def top=(n)
+      @view.top = n
+    end
+
+    # Returns the right position of the world.
+    #
+    # @return [Numeric] right position
+    #
+    def right()
+      @view.right
+    end
+
+    # Set the right position of the world.
     #
-    # @return [Vector] offset of the sprite world
+    # @param [Numeric] n world right position
+    #
+    # @return [Numeric] world right position
+    #
+    def right=(n)
+      @view.right = n
+    end
+
+    # Returns the bottom position of the world.
+    #
+    # @return [Numeric] bottom
+    #
+    def bottom()
+      @view.bottom
+    end
+
+    # Set the bottom position of the world.
+    #
+    # @param [Numeric] n world bottom position
+    #
+    # @return [Numeric] world bottom position
+    #
+    def bottom=(n)
+      @view.bottom = n
+    end
+
+    # Returns the center position of the world.
+    #
+    # @return [Vector] center position
+    #
+    def center()
+      Vector.new(x + w / 2, y + h / 2, z)
+    end
+
+    # Sets the center position of the world.
+    #
+    # @overload center=(vec)
+    #  @param [Vector] vec center position
+    #
+    # @overload center=(ary)
+    #  @param [Array<Numeric>] ary an array of centerX and centerY
+    #
+    # @return [Vector] center position
+    #
+    def center=(arg)
+      x, y = *(arg.is_a?(Vector) ? arg.getInternal__.to_a : arg)
+      self.pos = [x - w / 2, y - h / 2, z]
+      self.center
+    end
+
+    # Returns the size of the world.
+    #
+    # @return [Vector] size
+    #
+    def size()
+      @view.size.toVector
+    end
+
+    # Sets the size of the world.
+    #
+    # @return [Vector] size
+    #
+    def size=(arg)
+      @view.size = arg.is_a?(Vector) ? arg.getInternal__ : arg
+      arg
+    end
+
+    # Returns the width of the world.
+    #
+    # @return [Numeric] width
+    #
+    def width()
+      @view.width
+    end
+
+    # Sets the width of the world.
+    #
+    # @param [Numeric] w width
+    #
+    # @return [Numeric] width
+    #
+    def width=(w)
+      @view.width = w
+    end
+
+    # Returns the height of the world.
+    #
+    # @return [Numeric] height
+    #
+    def height()
+      @view.height
+    end
+
+    # Sets the height of the world.
+    #
+    # @param [Numeric] h height
+    #
+    # @return [Numeric] height
+    #
+    def height=(h)
+      @view.height = h
+    end
+
+    alias w  width
+    alias w= width=
+    alias h  height
+    alias h= height=
+
+    # Returns the offset of the world.
+    #
+    # @return [Vector] offset of the world
     #
     def offset()
       s, z = @view.scroll, zoom
       Vector.new(-s.x / z, -s.y / z, -s.z / z)
     end
 
-    # Sets the offset of the sprite world.
+    # Sets the offset of the world.
     #
     # @overload offset=(vec)
     #  @param [Vector] vec offset
@@ -1230,7 +1582,7 @@ module RubySketch
     # @overload offset=(ary)
     #  @param [Array<Numeric>] ary an array of offsetX and offsetY
     #
-    # @return [Vector] offset of the sprite world
+    # @return [Vector] offset of the world
     #
     def offset=(arg)
       zoom_   = zoom
@@ -1245,7 +1597,7 @@ module RubySketch
       offset
     end
 
-    # Returns the x-axis offset of the sprite world.
+    # Returns the x-axis offset of the world.
     #
     # @return [Numeric] offset.x
     #
@@ -1253,7 +1605,7 @@ module RubySketch
       offset.x
     end
 
-    # Sets the x-axis offset of the sprite world.
+    # Sets the x-axis offset of the world.
     #
     # @param [Numeric] x x-axis offset
     #
@@ -1263,10 +1615,9 @@ module RubySketch
       o           = offset
       o.x         = x
       self.offset = o
-      x
     end
 
-    # Returns the y-axis offset of the sprite world.
+    # Returns the y-axis offset of the world.
     #
     # @return [Numeric] offset.y
     #
@@ -1274,20 +1625,19 @@ module RubySketch
       offset.y
     end
 
-    # Sets the y-axis offset of the sprite world.
+    # Sets the y-axis offset of the world.
     #
-    # @param [Numeric] x y-axis offset
+    # @param [Numeric] y y-axis offset
     #
     # @return [Numeric] offset.y
     #
-    def oy=(x)
+    def oy=(y)
       o           = offset
       o.y         = y
       self.offset = o
-      y
     end
 
-    # Returns the zoom value of the sprite world.
+    # Returns the zoom value of the world.
     #
     # @return [Numeric] zoom
     #
@@ -1295,7 +1645,7 @@ module RubySketch
       @view.zoom
     end
 
-    # Sets the zoom value of the sprite world.
+    # Sets the zoom value of the world.
     #
     # @return [Numeric] zoom
     #
@@ -1309,11 +1659,38 @@ module RubySketch
 
     def debug? = @view.debug?
 
+    # @private
+    def attached__()
+      @context = @view.window.context
+    end
+
+    # @private
+    def detached__()
+      @context = nil
+    end
+
     # @private
     def getInternal__()
       @view
     end
 
+    # @private
+    def getContext__()
+      @context
+    end
+
+    # @private
+    def drawSprite__(c)
+      o, z_ = offset, zoom
+      c.push do
+        c.clip x, y, w, h
+        c.translate x, y, z
+        c.scale z_, z_
+        c.translate(-o.x, -o.y, -o.z)
+        c.sprite(*@sprites)
+      end
+    end
+
   end# SpriteWorld
 
 
@@ -1333,6 +1710,7 @@ module RubySketch
       @pointerPrev      = nil
       @pointersPressed  = []
       @pointersReleased = []
+      @pointerOver      = false
       @touches          = []
 
       self.shape  = shape.getInternal__ if shape
@@ -1341,7 +1719,8 @@ module RubySketch
 
     attr_accessor :update,
       :mousePressed, :mouseReleased, :mouseMoved, :mouseDragged,
-      :mouseClicked, :mouseWheel, :touchStarted, :touchEnded, :touchMoved,
+      :mouseClicked, :mouseOver, :mouseOut, :mouseWheel,
+      :touchStarted, :touchEnded, :touchMoved,
       :keyPressed, :keyReleased, :keyTyped,
       :contact, :contactEnd, :willContact
 
@@ -1375,6 +1754,10 @@ module RubySketch
       ((@pointersPressed + @pointersReleased) & MOUSE_BUTTONS).last
     end
 
+    def mouseOver?()
+      @pointerOver
+    end
+
     def clickCount()
       mouseClicked? ? 1 : 0
     end
@@ -1420,6 +1803,17 @@ module RubySketch
       on_pointer_up e
     end
 
+    def on_pointer_enter(e)
+      updatePointerStates e
+      @pointerOver = true
+      callBlock @mouseOver
+    end
+
+    def on_pointer_leave(e)
+      @pointerOver = false
+      callBlock @mouseOut
+    end
+
     def on_wheel(e)
       callBlock @mouseWheel, WheelEvent.new(e)
     end