fxruby 1.2.6 → 1.4.0

data/rdoc-sources/FXQuatd.rb

@@ -1 +1 @@
-module Fox
  class FXQuatd < FXVec4d
    # Return an initialized FXQuatd instance.
    def initialize; end
    
    #
    # Construct an FXQuatd instance from a rotation axis and angle.
    #
    # ==== Parameters:
    #
    # +axis+::		the rotation axis [FXVec3d]
    # +angle+::		the rotation angle (in radians) [Float]
    #
    def initialize(axis, phi=0.0); end
    
    #
    # Construct an FXQuatd from components.
    #
    # ==== Parameters:
    #
    # +x+::		x [Float]
    # +y+::		y [Float]
    # +z+::		z [Float]
    # +w+::		w [Float]
    #
    def initialize(x, y, z, w); end
    
    #
    # Construct from Euler angles yaw (z), pitch (y) and roll (x).
    #
    # ==== Parameters:
    #
    # +roll+::		roll angle in radians [Float]
    # +pitch+::		pitch angle in radians [Float]
    # +yaw+::		yaw angle in radians [Float]
    #
    def initialize(roll, pitch, yaw); end
    
    # Adjust quaternion length; returns a reference to self.
    def adjust!; end
    
    #
    # Set quaternion from rotation axis and angle.
    #
    # ==== Parameters:
    #
    # +axis+::		the rotation axis [FXVec3d]
    # +angle+::		the rotation angle (in radians) [Float]
    #
    def setAxisAngle(axis, phi=0.0); end
    
    #
    # Return the rotation axis and angle for this quaternion, i.e.
    #
    #     axis, angle = aQuaternion.getAxisAngle()
    #
    # where _axis_ is an FXVec3d instance and _angle_ is the angle
    # of rotation in radians.
    #
    def getAxisAngle(); end
    
    #
    # Set quaternion from yaw (z), pitch (y) and roll (x).
    #
    # ==== Parameters:
    #
    # +roll+::		roll angle in radians [Float]
    # +pitch+::		pitch angle in radians [Float]
    # +yaw+::		yaw angle in radians [Float]
    #
    def setRollPitchYaw(roll, pitch, yaw); end
    
    #
    # Obtain roll, pitch and yaw angles (in radians) from quaternion, e.g.
    #
    #     roll, pitch, yaw = aQuaternion.getRollPitchYaw()
    #
    def getRollPitchYaw(); end
    
    #
    # Return the exponentiation of this quaternion (a new FXQuatd instance).
    #
    def exp; end
    
    #
    # Return the logarithm of this quaternion (a new FXQuatd instance).
    #
    def log; end
    
    #
    # Return the inverse of this quaternion (a new FXQuatd instance).
    #
    def invert; end
    
    #
    # Invert unit quaternion (returns a new FXQuatd instance).
    #
    def unitinvert; end
    
    #
    # Return the conjugate of this quaternion (a new FXQuatd instance).
    #
    def conj; end
    
    #
    # Return the product of this quaternion and _other_ (another FXQuatd instance).
    #
    def *(other); end
    
    #
    # Compute the rotation of a vector _vec_ by this quaternion; returns the
    # rotated vector (a new FXVec3d instance).
    #
    # ==== Parameters:
    #
    # +vec+::		the vector to be rotated [FXVec3d]
    #
    def *(vec); end
    
    #
    # Construct a quaternion from arc a->b on unit sphere.
    #
    # ==== Parameters:
    #
    # +a+::	[FXVec3d]
    # +b+::	[FXVec3d]
    #
    def FXQuatd.arc(a, b); end
    
    #
    # Spherical lerp.
    #
    # ==== Parameters:
    #
    # +u+::	[FXQuatd]
    # +v+::	[FXQuatd]
    # +f+:: [Float]
    #
    def FXQuatd.lerp(u, v, f); end
  end
+module Fox
  class FXQuatd < FXVec4d
    # Return an initialized FXQuatd instance.
    def initialize; end
    
    #
    # Construct an FXQuatd instance from a rotation axis and angle.
    #
    # ==== Parameters:
    #
    # +axis+::		the rotation axis [FXVec3d]
    # +angle+::		the rotation angle (in radians) [Float]
    #
    def initialize(axis, phi=0.0); end
    
    #
    # Construct an FXQuatd from components.
    #
    # ==== Parameters:
    #
    # +x+::		x [Float]
    # +y+::		y [Float]
    # +z+::		z [Float]
    # +w+::		w [Float]
    #
    def initialize(x, y, z, w); end
    
    # Construct an FXQuatd from an array of Floats.
    def initialize(floats); end
    #
    # Construct from Euler angles yaw (z), pitch (y) and roll (x).
    #
    # ==== Parameters:
    #
    # +roll+::		roll angle in radians [Float]
    # +pitch+::		pitch angle in radians [Float]
    # +yaw+::		yaw angle in radians [Float]
    #
    def initialize(roll, pitch, yaw); end
    
    # Construct quaternion from axes; _ex_, _ey_ and _ez_ are all FXVec3d
    # instances.
    def initialize(ex, ey, ez); end
    #
    # Construct quaternion from 3x3 matrix; _mat_ is an FXMat3d instance.
    #
    def FXQuatd.fromMatrix(mat); end
    # Adjust quaternion length; returns a reference to self.
    def adjust!; end
    
    #
    # Set quaternion from rotation axis and angle.
    #
    # ==== Parameters:
    #
    # +axis+::		the rotation axis [FXVec3d]
    # +angle+::		the rotation angle (in radians) [Float]
    #
    def setAxisAngle(axis, phi=0.0); end
    
    #
    # Return the rotation axis and angle for this quaternion, i.e.
    #
    #     axis, angle = aQuaternion.getAxisAngle()
    #
    # where _axis_ is an FXVec3d instance and _angle_ is the angle
    # of rotation in radians.
    #
    def getAxisAngle(); end
    
    #
    # Set quaternion from yaw (z), pitch (y) and roll (x).
    #
    # ==== Parameters:
    #
    # +roll+::		roll angle in radians [Float]
    # +pitch+::		pitch angle in radians [Float]
    # +yaw+::		yaw angle in radians [Float]
    #
    def setRollPitchYaw(roll, pitch, yaw); end
    
    #
    # Obtain roll, pitch and yaw angles (in radians) from quaternion, e.g.
    #
    #     roll, pitch, yaw = aQuaternion.getRollPitchYaw()
    #
    def getRollPitchYaw(); end
    
    # Set quaternion from axes; _ex_, _ey_ and _ez_ are all FXVec3d instances.
    def setAxes(ex, ey, ez); end
    # Get quaternion axes; returns a 3-element array of FXVec3d instances.
    def getAxes(); end
    # Obtain local x axis (an FXVec3d instance).
    def getXAxis(); end
    # Obtain local y axis (an FXVec3d instance).
    def getYAxis(); end
    # Obtain local z axis (an FXVec3d instance).
    def getZAxis(); end
    #
    # Return the exponentiation of this quaternion (a new FXQuatd instance).
    #
    def exp; end
    
    #
    # Return the logarithm of this quaternion (a new FXQuatd instance).
    #
    def log; end
    
    #
    # Return the inverse of this quaternion (a new FXQuatd instance).
    #
    def invert; end
    
    #
    # Invert unit quaternion (returns a new FXQuatd instance).
    #
    def unitinvert; end
    
    #
    # Return the conjugate of this quaternion (a new FXQuatd instance).
    #
    def conj; end
    
    #
    # Return the product of this quaternion and _other_ (another FXQuatd instance).
    #
    def *(other); end
    
    #
    # Compute the rotation of a vector _vec_ by this quaternion; returns the
    # rotated vector (a new FXVec3d instance).
    #
    # ==== Parameters:
    #
    # +vec+::		the vector to be rotated [FXVec3d]
    #
    def *(vec); end
    
    #
    # Construct a quaternion from arc a->b on unit sphere.
    #
    # ==== Parameters:
    #
    # +a+::	[FXVec3d]
    # +b+::	[FXVec3d]
    #
    def FXQuatd.arc(a, b); end
    
    #
    # Spherical lerp.
    #
    # ==== Parameters:
    #
    # +u+::	[FXQuatd]
    # +v+::	[FXQuatd]
    # +f+:: [Float]
    #
    def FXQuatd.lerp(u, v, f); end
    
    # Convert to matrix (returns an FXMat3d instance).
    def toMatrix; end
  end

data/rdoc-sources/FXQuatf.rb

@@ -1 +1 @@
-module Fox
  class FXQuatf < FXVec4f
    # Return an initialized FXQuatf instance.
    def initialize; end
    
    #
    # Construct an FXQuatf instance from a rotation axis and angle.
    #
    # ==== Parameters:
    #
    # +axis+::		the rotation axis [FXVec3f]
    # +angle+::		the rotation angle (in radians) [Float]
    #
    def initialize(axis, phi=0.0); end
    
    #
    # Construct from Euler angles yaw (z), pitch (y) and roll (x).
    #
    # ==== Parameters:
    #
    # +roll+::		roll angle in radians [Float]
    # +pitch+::		pitch angle in radians [Float]
    # +yaw+::		yaw angle in radians [Float]
    #
    def initialize(roll, pitch, yaw); end
    #
    # Construct an FXQuatf from components.
    #
    # ==== Parameters:
    #
    # +x+::		x [Float]
    # +y+::		y [Float]
    # +z+::		z [Float]
    # +w+::		w [Float]
    #
    def initialize(x, y, z, w); end
    
    # Adjust quaternion length; returns a reference to self.
    def adjust!; end
    
    #
    # Set quaternion from rotation axis and angle.
    #
    # ==== Parameters:
    #
    # +axis+::		the rotation axis [FXVec3f]
    # +angle+::		the rotation angle (in radians) [Float]
    #
    def setAxisAngle(axis, phi=0.0); end
    
    #
    # Return the rotation axis and angle for this quaternion, i.e.
    #
    #     axis, angle = aQuaternion.getAxisAngle()
    #
    # where _axis_ is an FXVec3f instance and _angle_ is the angle
    # of rotation in radians.
    #
    def getAxisAngle(); end
    
    #
    # Set quaternion from yaw (z), pitch (y) and roll (x).
    #
    # ==== Parameters:
    #
    # +roll+::		roll angle in radians [Float]
    # +pitch+::		pitch angle in radians [Float]
    # +yaw+::		yaw angle in radians [Float]
    #
    def setRollPitchYaw(roll, pitch, yaw); end
    
    #
    # Obtain roll, pitch and yaw angles (in radians) from quaternion, e.g.
    #
    #     roll, pitch, yaw = aQuaternion.getRollPitchYaw()
    #
    def getRollPitchYaw(); end
    
    #
    # Return the exponentiation of this quaternion (a new FXQuatf instance).
    #
    def exp; end
    
    #
    # Return the logarithm of this quaternion (a new FXQuatf instance).
    #
    def log; end
    
    #
    # Return the inverse of this quaternion (a new FXQuatf instance).
    #
    def invert; end
    
    #
    # Invert unit quaternion (returns a new FXQuatf instance).
    #
    def unitinvert; end
    
    #
    # Return the conjugate of this quaternion (a new FXQuatf instance).
    #
    def conj; end
    
    #
    # Return the product of this quaternion and _other_ (another FXQuatf instance).
    #
    def *(other); end
    
    #
    # Compute the rotation of a vector _vec_ by this quaternion; returns the
    # rotated vector (a new FXVec3f instance).
    #
    # ==== Parameters:
    #
    # +vec+::		the vector to be rotated [FXVec3f]
    #
    def *(vec); end
    
    #
    # Construct a quaternion from arc a->b on unit sphere.
    #
    # ==== Parameters:
    #
    # +a+::	[FXVec3f]
    # +b+::	[FXVec3f]
    #
    def FXQuatf.arc(a, b); end
    
    #
    # Spherical lerp.
    #
    # ==== Parameters:
    #
    # +u+::	[FXQuatf]
    # +v+::	[FXQuatf]
    # +f+:: [Float]
    #
    def FXQuatf.lerp(u, v, f); end
  end
+module Fox
  class FXQuatf < FXVec4f
    # Return an initialized FXQuatf instance.
    def initialize; end
    
    #
    # Construct an FXQuatf instance from a rotation axis and angle.
    #
    # ==== Parameters:
    #
    # +axis+::		the rotation axis [FXVec3f]
    # +angle+::		the rotation angle (in radians) [Float]
    #
    def initialize(axis, phi=0.0); end
    
    #
    # Construct from Euler angles yaw (z), pitch (y) and roll (x).
    #
    # ==== Parameters:
    #
    # +roll+::		roll angle in radians [Float]
    # +pitch+::		pitch angle in radians [Float]
    # +yaw+::		yaw angle in radians [Float]
    #
    def initialize(roll, pitch, yaw); end
    #
    # Construct quaternion from axes
    #
    # ==== Parameters:
    #
    # +ex+::	x-axis [FXVec3f]
    # +ey+::	y-axis [FXVec3f]
    # +ez+::	z-axis [FXVec3f]
    #
    def initialize(ex, ey, ez); end
   
    #
    # Construct quaternion from 3x3 matrix (where _mat_ is an FXMat3f instance).
    #
    def initialize(mat); end
    #
    # Construct an FXQuatf from components.
    #
    # ==== Parameters:
    #
    # +x+::		x [Float]
    # +y+::		y [Float]
    # +z+::		z [Float]
    # +w+::		w [Float]
    #
    def initialize(x, y, z, w); end
    
    # Adjust quaternion length; returns a reference to self.
    def adjust!; end
    
    #
    # Set quaternion from rotation axis and angle.
    #
    # ==== Parameters:
    #
    # +axis+::		the rotation axis [FXVec3f]
    # +angle+::		the rotation angle (in radians) [Float]
    #
    def setAxisAngle(axis, phi=0.0); end
    
    #
    # Return the rotation axis and angle for this quaternion, i.e.
    #
    #     axis, angle = aQuaternion.getAxisAngle()
    #
    # where _axis_ is an FXVec3f instance and _angle_ is the angle
    # of rotation in radians.
    #
    def getAxisAngle(); end
    
    #
    # Set quaternion from yaw (z), pitch (y) and roll (x).
    #
    # ==== Parameters:
    #
    # +roll+::		roll angle in radians [Float]
    # +pitch+::		pitch angle in radians [Float]
    # +yaw+::		yaw angle in radians [Float]
    #
    def setRollPitchYaw(roll, pitch, yaw); end
    
    #
    # Obtain roll, pitch and yaw angles (in radians) from quaternion, e.g.
    #
    #     roll, pitch, yaw = aQuaternion.getRollPitchYaw()
    #
    def getRollPitchYaw(); end
    
    # Set quaternion from axes (where _ex_, _ey_ and _ez_ are FXVec3f instances).
    def setAxes(ex, ey, ez); end
    
    # Get quaternion axes as a 3-element array of FXVec3f instances.
    def getAxes(); end
    # Return the local x-axis as an FXVec3f instance.
    def getXAxis(); end
    # Return the local y-axis as an FXVec3f instance.
    def getYAxis(); end
    # Return the local z-axis as an FXVec3f instance.
    def getZAxis(); end
    #
    # Return the exponentiation of this quaternion (a new FXQuatf instance).
    #
    def exp; end
    
    #
    # Return the logarithm of this quaternion (a new FXQuatf instance).
    #
    def log; end
    
    #
    # Return the inverse of this quaternion (a new FXQuatf instance).
    #
    def invert; end
    
    #
    # Invert unit quaternion (returns a new FXQuatf instance).
    #
    def unitinvert; end
    
    #
    # Return the conjugate of this quaternion (a new FXQuatf instance).
    #
    def conj; end
    
    #
    # Return the product of this quaternion and _other_ (another FXQuatf instance).
    #
    def *(other); end
    
    #
    # Compute the rotation of a vector _vec_ by this quaternion; returns the
    # rotated vector (a new FXVec3f instance).
    #
    # ==== Parameters:
    #
    # +vec+::		the vector to be rotated [FXVec3f]
    #
    def *(vec); end
    
    #
    # Construct a quaternion from arc a->b on unit sphere.
    #
    # ==== Parameters:
    #
    # +a+::	[FXVec3f]
    # +b+::	[FXVec3f]
    #
    def FXQuatf.arc(a, b); end
    
    #
    # Spherical lerp.
    #
    # ==== Parameters:
    #
    # +u+::	[FXQuatf]
    # +v+::	[FXQuatf]
    # +f+:: 	[Float]
    #
    def FXQuatf.lerp(u, v, f); end
    
    # Convert to a 3x3 matrix; returns an FXMat3f instance.
    def toMatrix; end
  end