processing 0.5.33 → 0.5.34

data/lib/processing/vector.rb

@@ -3,6 +3,9 @@ module Processing
 
   # Vector class.
   #
+  # @see https://processing.org/reference/PVector.html
+  # @see https://p5js.org/reference/#/p5.Vector
+  #
   class Vector
 
     include Comparable
@@ -22,6 +25,9 @@ module Processing
     # @param v [Vector]  vector object to copy
     # @param a [Array]   array like [x, y, z]
     #
+    # @see https://processing.org/reference/PVector.html
+    # @see https://p5js.org/reference/#/p5.Vector
+    #
     def initialize(x = 0, y = 0, z = 0, context: nil)
       @point = case x
         when Rays::Point then x.dup
@@ -42,6 +48,9 @@ module Processing
     #
     # @return [Vector] duplicated vector object
     #
+    # @see https://processing.org/reference/PVector_copy_.html
+    # @see https://p5js.org/reference/#/p5.Vector/copy
+    #
     alias copy dup
 
     # Sets x, y and z.
@@ -60,6 +69,9 @@ module Processing
     #
     # @return [nil] nil
     #
+    # @see https://processing.org/reference/PVector_set_.html
+    # @see https://p5js.org/reference/#/p5.Vector/set
+    #
     def set(*args)
       initialize(*args)
       self
@@ -69,6 +81,9 @@ module Processing
     #
     # @return [Numeric] x value of vector
     #
+    # @see https://processing.org/reference/PVector_x.html
+    # @see https://p5js.org/reference/#/p5.Vector/x
+    #
     def x()
       @point.x
     end
@@ -77,6 +92,9 @@ module Processing
     #
     # @return [Numeric] y value of vector
     #
+    # @see https://processing.org/reference/PVector_y.html
+    # @see https://p5js.org/reference/#/p5.Vector/y
+    #
     def y()
       @point.y
     end
@@ -85,6 +103,9 @@ module Processing
     #
     # @return [Numeric] z value of vector
     #
+    # @see https://processing.org/reference/PVector_z.html
+    # @see https://p5js.org/reference/#/p5.Vector/z
+    #
     def z()
       @point.z
     end
@@ -93,6 +114,9 @@ module Processing
     #
     # @return [Numeric] x value of vector
     #
+    # @see https://processing.org/reference/PVector_x.html
+    # @see https://p5js.org/reference/#/p5.Vector/x
+    #
     def x=(x)
       @point.x = x
     end
@@ -101,6 +125,9 @@ module Processing
     #
     # @return [Numeric] y value of vector
     #
+    # @see https://processing.org/reference/PVector_y.html
+    # @see https://p5js.org/reference/#/p5.Vector/y
+    #
     def y=(y)
       @point.y = y
     end
@@ -109,6 +136,9 @@ module Processing
     #
     # @return [Numeric] z value of vector
     #
+    # @see https://processing.org/reference/PVector_z.html
+    # @see https://p5js.org/reference/#/p5.Vector/z
+    #
     def z=(z)
       @point.z = z
     end
@@ -127,6 +157,9 @@ module Processing
     #
     # @return [Vector] interporated vector
     #
+    # @see https://processing.org/reference/PVector_lerp_.html
+    # @see https://p5js.org/reference/#/p5.Vector/lerp
+    #
     def lerp(*args, amount)
       v      = toVector__(*args)
       self.x = x + (v.x - x) * amount
@@ -143,6 +176,9 @@ module Processing
     #
     # @return [Vector] interporated vector
     #
+    # @see https://processing.org/reference/PVector_lerp_.html
+    # @see https://p5js.org/reference/#/p5.Vector/lerp
+    #
     def self.lerp(v1, v2, amount)
       v1.dup.lerp v2, amount
     end
@@ -153,6 +189,9 @@ module Processing
     #
     # @return [Array] array of x, y, z
     #
+    # @see https://processing.org/reference/PVector_array_.html
+    # @see https://p5js.org/reference/#/p5.Vector/array
+    #
     def array(n = 3)
       @point.to_a n
     end
@@ -172,6 +211,9 @@ module Processing
     #
     # @return [Vector] added vector
     #
+    # @see https://processing.org/reference/PVector_add_.html
+    # @see https://p5js.org/reference/#/p5.Vector/add
+    #
     def add(*args)
       @point += toVector__(*args).getInternal__
       self
@@ -190,6 +232,9 @@ module Processing
     #
     # @return [Vector] subtracted vector
     #
+    # @see https://processing.org/reference/PVector_sub_.html
+    # @see https://p5js.org/reference/#/p5.Vector/sub
+    #
     def sub(*args)
       @point -= toVector__(*args).getInternal__
       self
@@ -201,6 +246,9 @@ module Processing
     #
     # @return [Vector] multiplied vector
     #
+    # @see https://processing.org/reference/PVector_mult_.html
+    # @see https://p5js.org/reference/#/p5.Vector/mult
+    #
     def mult(num)
       @point *= num
       self
@@ -212,6 +260,9 @@ module Processing
     #
     # @return [Vector] divided vector
     #
+    # @see https://processing.org/reference/PVector_div_.html
+    # @see https://p5js.org/reference/#/p5.Vector/div
+    #
     def div(num)
       @point /= num
       self
@@ -223,6 +274,9 @@ module Processing
     #
     # @return [Vector] added vector
     #
+    # @see https://processing.org/reference/PVector_add_.html
+    # @see https://p5js.org/reference/#/p5.Vector/add
+    #
     def +(v)
       dup.add v
     end
@@ -233,6 +287,9 @@ module Processing
     #
     # @return [Vector] subtracted vector
     #
+    # @see https://processing.org/reference/PVector_sub_.html
+    # @see https://p5js.org/reference/#/p5.Vector/sub
+    #
     def -(v)
       dup.sub v
     end
@@ -243,6 +300,9 @@ module Processing
     #
     # @return [Vector] multiplied vector
     #
+    # @see https://processing.org/reference/PVector_mult_.html
+    # @see https://p5js.org/reference/#/p5.Vector/mult
+    #
     def *(num)
       dup.mult num
     end
@@ -253,6 +313,9 @@ module Processing
     #
     # @return [Vector] divided vector
     #
+    # @see https://processing.org/reference/PVector_div_.html
+    # @see https://p5js.org/reference/#/p5.Vector/div
+    #
     def /(num)
       dup.div num
     end
@@ -268,6 +331,9 @@ module Processing
     #
     # @return [Vector] added vector
     #
+    # @see https://processing.org/reference/PVector_add_.html
+    # @see https://p5js.org/reference/#/p5.Vector/add
+    #
     def self.add(v1, v2, target = nil)
       v = v1 + v2
       target.set v if self === target
@@ -285,6 +351,9 @@ module Processing
     #
     # @return [Vector] subtracted vector
     #
+    # @see https://processing.org/reference/PVector_sub_.html
+    # @see https://p5js.org/reference/#/p5.Vector/sub
+    #
     def self.sub(v1, v2, target = nil)
       v = v1 - v2
       target.set v if self === target
@@ -302,6 +371,9 @@ module Processing
     #
     # @return [Vector] multiplied vector
     #
+    # @see https://processing.org/reference/PVector_mult_.html
+    # @see https://p5js.org/reference/#/p5.Vector/mult
+    #
     def self.mult(v1, num, target = nil)
       v = v1 * num
       target.set v if self === target
@@ -319,6 +391,9 @@ module Processing
     #
     # @return [Vector] divided vector
     #
+    # @see https://processing.org/reference/PVector_div_.html
+    # @see https://p5js.org/reference/#/p5.Vector/div
+    #
     def self.div(v1, num, target = nil)
       v = v1 / num
       target.set v if self === target
@@ -329,6 +404,9 @@ module Processing
     #
     # @return [Numeric] length
     #
+    # @see https://processing.org/reference/PVector_mag_.html
+    # @see https://p5js.org/reference/#/p5.Vector/mag
+    #
     def mag()
       @point.length
     end
@@ -337,6 +415,9 @@ module Processing
     #
     # @return [Numeric] squared length
     #
+    # @see https://processing.org/reference/PVector_magSq_.html
+    # @see https://p5js.org/reference/#/p5.Vector/magSq
+    #
     def magSq()
       Rays::Point::dot(@point, @point)
     end
@@ -351,6 +432,9 @@ module Processing
     #
     # @return [Vector] vector with new length
     #
+    # @see https://processing.org/reference/PVector_setMag_.html
+    # @see https://p5js.org/reference/#/p5.Vector/setMag
+    #
     def setMag(target = nil, len)
       (target || self).set @point.normal * len
     end
@@ -361,6 +445,9 @@ module Processing
     #
     # @return [Vector] normalized vector
     #
+    # @see https://processing.org/reference/PVector_normalize_.html
+    # @see https://p5js.org/reference/#/p5.Vector/normalize
+    #
     def normalize(target = nil)
       (target || self).set @point.normal
     end
@@ -371,6 +458,9 @@ module Processing
     #
     # @return [Vector] new vector
     #
+    # @see https://processing.org/reference/PVector_limit_.html
+    # @see https://p5js.org/reference/#/p5.Vector/limit
+    #
     def limit(max)
       setMag max if magSq > max ** 2
       self
@@ -382,6 +472,9 @@ module Processing
     #
     # @return [Numeric] the distance
     #
+    # @see https://processing.org/reference/PVector_dist_.html
+    # @see https://p5js.org/reference/#/p5.Vector/dist
+    #
     def dist(v)
       (self - v).mag
     end
@@ -393,6 +486,9 @@ module Processing
     #
     # @return [Numeric] the distance
     #
+    # @see https://processing.org/reference/PVector_dist_.html
+    # @see https://p5js.org/reference/#/p5.Vector/dist
+    #
     def self.dist(v1, v2)
       v1.dist v2
     end
@@ -410,6 +506,9 @@ module Processing
     #
     # @return [Numeric] result of dot product
     #
+    # @see https://processing.org/reference/PVector_dot_.html
+    # @see https://p5js.org/reference/#/p5.Vector/dot
+    #
     def dot(*args)
       Rays::Point::dot getInternal__, toVector__(*args).getInternal__
     end
@@ -421,6 +520,9 @@ module Processing
     #
     # @return [Numeric] result of dot product
     #
+    # @see https://processing.org/reference/PVector_dot_.html
+    # @see https://p5js.org/reference/#/p5.Vector/dot
+    #
     def self.dot(v1, v2)
       v1.dot v2
     end
@@ -438,6 +540,9 @@ module Processing
     #
     # @return [Numeric] result of cross product
     #
+    # @see https://processing.org/reference/PVector_cross_.html
+    # @see https://p5js.org/reference/#/p5.Vector/cross
+    #
     def cross(a, *rest)
       target = self.class === rest.last ? rest.pop : nil
       v = self.class.new Rays::Point::cross getInternal__, toVector__(a, *rest).getInternal__
@@ -452,6 +557,9 @@ module Processing
     #
     # @return [Numeric] result of cross product
     #
+    # @see https://processing.org/reference/PVector_cross_.html
+    # @see https://p5js.org/reference/#/p5.Vector/cross
+    #
     def self.cross(v1, v2, target = nil)
       v1.cross v2, target
     end
@@ -462,6 +570,9 @@ module Processing
     #
     # @return [Vector] rotated this object
     #
+    # @see https://processing.org/reference/PVector_rotate_.html
+    # @see https://p5js.org/reference/#/p5.Vector/rotate
+    #
     def rotate(angle)
       deg = @context ?
         @context.toDegrees__(angle) : angle * GraphicsContext::RAD2DEG__
@@ -473,6 +584,9 @@ module Processing
     #
     # @return [Numeric] the angle in radians
     #
+    # @see https://processing.org/reference/PVector_heading_.html
+    # @see https://p5js.org/reference/#/p5.Vector/heading
+    #
     def heading()
       Math.atan2 y, x
     end
@@ -484,6 +598,9 @@ module Processing
     #
     # @return [Vector] rotated vector
     #
+    # @see https://processing.org/reference/PVector_fromAngle_.html
+    # @see https://p5js.org/reference/#/p5.Vector/fromAngle
+    #
     def self.fromAngle(angle, target = nil)
       v = self.new(1, 0, 0).rotate(angle)
       target.set v if target
@@ -497,6 +614,9 @@ module Processing
     #
     # @return [Numeric] angle in radians
     #
+    # @see https://processing.org/reference/PVector_angleBetween_.html
+    # @see https://p5js.org/reference/#/p5.Vector/angleBetween
+    #
     def self.angleBetween(v1, v2)
       x1, y1, z1 = v1.array
       x2, y2, z2 = v2.array
@@ -514,6 +634,9 @@ module Processing
     #
     # @return [Vector] a random vector
     #
+    # @see https://processing.org/reference/PVector_random2D_.html
+    # @see https://p5js.org/reference/#/p5.Vector/random2D
+    #
     def self.random2D(target = nil)
       v = self.new(1, 0, 0)
       v.getInternal__.rotate! rand 0.0...360.0
@@ -527,6 +650,9 @@ module Processing
     #
     # @return [Vector] a random vector
     #
+    # @see https://processing.org/reference/PVector_random3D_.html
+    # @see https://p5js.org/reference/#/p5.Vector/random3D
+    #
     def self.random3D(target = nil)
       angle = rand 0.0...(Math::PI * 2)
       z     = rand(-1.0..1.0)

data/lib/processing/window.rb

@@ -212,6 +212,7 @@ module Processing
   end# Window
 
 
+  # @private
   class Window::Canvas
 
     def initialize(window, width, height)
@@ -297,6 +298,7 @@ module Processing
   end# Window::Canvas
 
 
+  # @private
   class Window::CanvasView < Reflex::View
 
     def on_update(e)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: processing
 version: !ruby/object:Gem::Version
-  version: 0.5.33
+  version: 0.5.34
 platform: ruby
 authors:
 - xordog
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-06 00:00:00.000000000 Z
+date: 2024-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: xot