fxruby 1.6.20-x86-linux

data/rdoc-sources/FXQuatf.rb

@@ -0,0 +1,173 @@
+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]
+    # +width+::		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 and
+    # return reference to self.
+    #
+    # ==== Parameters:
+    #
+    # +a+::	[FXVec3f]
+    # +b+::	[FXVec3f]
+    #
+    def arc!(a, b); end
+    
+    #
+    # Spherical lerp, return reference to self.
+    #
+    # ==== Parameters:
+    #
+    # +u+::	[FXQuatf]
+    # +v+::	[FXQuatf]
+    # +f+:: 	[Float]
+    #
+    def lerp!(u, v, f); end
+  end
+end

data/rdoc-sources/FXRGBIcon.rb

@@ -0,0 +1,64 @@
+module Fox
+  #
+  # Iris RGB Icon
+  #
+  class FXRGBIcon < FXIcon
+    #
+    # Return the suggested file extension for this image type ("rgb").
+    #
+    def FXRGBIcon.fileExt; end
+    
+    #
+    # Return the MIME type for this image type
+    #
+    def FXRGBIcon.mimeType; end
+
+    #
+    # Return an initialized FXRGBIcon instance.
+    #
+    # ==== Parameters:
+    #
+    # +a+::	an application instance [FXApp]
+    # +pix+::	a memory buffer formatted in IRIS RGB file format [String]
+    # +clr+::	transparency color [FXColor]
+    # +opts+::	options [Integer]
+    # +width+::	width [Integer]
+    # +height+::	height [Integer]
+    #
+    def initialize(a, pix=nil, clr=0, opts=0, width=1, height=1) # :yields: theRGBIcon
+    end
+  end
+  
+  #
+  # Load a RGB file from a stream.
+  # If successful, returns an array containing the image pixel data (as a
+  # String), the transparency color, the image width and the image height.
+  # If it fails, the function returns +nil+.
+  #
+  # ==== Parameters:
+  #
+  # +store+::	stream from which to read the file data [FXStream]
+  #
+  def Fox.fxloadRGB(store); end
+
+  #
+  # Save a RGB image to a stream.
+  # Returns +true+ on success, +false+ on failure.
+  #
+  # ==== Parameters:
+  #
+  # +store+::	stream to which to write the file data [FXStream]
+  # +data+::	the image pixel data [String]
+  # +transp+::	transparency color [FXColor]
+  # +opts+::	options [Integer]
+  # +width+::	width [Integer]
+  # +height+::	height [Integer]
+  #
+  def Fox.fxsaveRGB(store, data, transp, width, height); end
+  
+  #
+  # Return +true+ if _store_ (an FXStream instance) contains a RGB image.
+  #
+  def Fox.fxcheckRGB(store); end
+end
+

data/rdoc-sources/FXRGBImage.rb

@@ -0,0 +1,31 @@
+module Fox
+  #
+  # Iris RGB Image
+  #
+  class FXRGBImage < FXImage
+    #
+    # Return the suggested file extension for this image type ("rgb").
+    #
+    def FXRGBImage.fileExt; end
+    
+    #
+    # Return the MIME type for this image type
+    #
+    def FXRGBImage.mimeType; end
+
+    #
+    # Return an initialized FXRGBImage instance.
+    #
+    # ==== Parameters:
+    #
+    # +a+::	an application instance [FXApp]
+    # +pix+::	a memory buffer formatted in IRIS RGB file format [String]
+    # +opts+::	options [Integer]
+    # +width+::	width [Integer]
+    # +height+::	height [Integer]
+    #
+    def initialize(a, pix=nil, opts=0, width=1, height=1) # :yields: theRGBImage
+    end
+  end
+end
+

data/rdoc-sources/FXRadioButton.rb

@@ -0,0 +1,70 @@
+module Fox
+  #
+  # A radio button is a tri-state button.  Normally, it is either
+  # +TRUE+ or +FALSE+; a third state +MAYBE+ may be set to indicate that no selection
+  # has been made yet by the user, or that the state is ambiguous.
+  # When pressed, the radio button sets its state to +TRUE+ and sends a +SEL_COMMAND+
+  # message to its target, with the message data set to the state of the radio button.
+  # A group of radio buttons can be made mutually exclusive by linking them
+  # to a common data target (i.e. an instance of FXDataTarget).
+  # Alternatively, an application can implement a common +SEL_UPDATE+ handler to
+  # check and uncheck radio buttons as appropriate.
+  #
+  # === Events
+  #
+  # The following messages are sent by FXRadioButton to its target:
+  #
+  # +SEL_COMMAND+::		sent when the radio button is pressed.
+  # +SEL_KEYPRESS+::		sent when a key goes down; the message data is an FXEvent instance.
+  # +SEL_KEYRELEASE+::		sent when a key goes up; the message data is an FXEvent instance.
+  # +SEL_LEFTBUTTONPRESS+::	sent when the left mouse button goes down; the message data is an FXEvent instance.
+  # +SEL_LEFTBUTTONRELEASE+::	sent when the left mouse button goes up; the message data is an FXEvent instance.
+  #
+  # === RadioButton flags
+  #
+  # +RADIOBUTTON_AUTOGRAY+::	Automatically gray out when not updated
+  # +RADIOBUTTON_AUTOHIDE+::	Automatically hide when not updated
+  # +RADIOBUTTON_NORMAL+::	<tt>JUSTIFY_NORMAL|ICON_BEFORE_TEXT</tt>
+  #
+  class FXRadioButton < FXLabel
+
+    # Radio button state, one of +TRUE+, +FALSE+ or +MAYBE+ [Integer]
+    attr_accessor :checkState
+    
+    # Radio button style [Integer]
+    attr_accessor :radioButtonStyle
+    
+    # Radio ball color [FXColor]
+    attr_accessor :radioColor
+    
+    # Radio disk color [FXColor]
+    attr_accessor :diskColor
+
+    #
+    # Construct new radio button
+    #
+    def initialize(parent, text, target=nil, selector=0, opts=RADIOBUTTON_NORMAL, x=0, y=0, width=0, height=0, padLeft=DEFAULT_PAD, padRight=DEFAULT_PAD, padTop=DEFAULT_PAD, padBottom=DEFAULT_PAD) # :yields: theRadioButton
+    end
+
+    #
+    # Return +true+ if the radio button state is +TRUE+
+    #
+    def checked?
+      self.checkState == Fox::TRUE
+    end
+    
+    #
+    # Return +true+ if the radio button state is +FALSE+
+    #
+    def unchecked?
+      self.checkState == Fox::FALSE
+    end
+
+    #
+    # Return +true+ if the radio button state is +MAYBE+
+    #
+    def maybe?
+      self.checkState == Fox::MAYBE
+    end
+  end
+end

data/rdoc-sources/FXRanged.rb

@@ -0,0 +1,100 @@
+module Fox
+  #
+  # Represents a range in 3-D space.
+  #
+  class FXRanged
+  
+    # Lower corner of range [FXVec3d]
+    attr_accessor :lower
+
+    # Upper corner of range [FXVec3d]
+    attr_accessor :upper
+
+    # Default constructor
+    def initialize(xlo=0.0, xhi=0.0, ylo=0.0, yhi=0.0, zlo=0.0, zhi=0.0) ; end
+
+    # Initialize this FXRanged instance from another instance
+    def initialize(bounds); end
+
+    # Initialize box to fully contain the given sphere (an FXSphered instance)
+    def initialize(sphere); end
+
+    # Return the width of the box
+    def width; end
+
+    # Return the height of the box
+    def height; end
+
+    # Return the depth of the box
+    def depth; end
+
+    # Return the length of the longest side of the box
+    def longest; end
+
+    # Return the length of the shortest side of the box
+    def shortest; end
+
+    # Return the length of the diagonal of the box
+    def diameter; end
+
+    # Return the radius of the box
+    def radius; end
+
+    # Return the diagonal vector for the box (an FXVec3d instance).
+    def diagonal; end
+
+    # Return the center of the box (a point, as an FXVec3d instance).
+    def center; end
+
+    # Returns +true+ if this is an empty range (i.e. if any of the side
+    # lengths is zero or less).
+    def empty?() ; end
+
+    # Returns +true+ if this range contains the point (_x_, _y_, _z_).
+    def contains?(x, y, z) ; end
+
+    # Returns +true+ if this range contains the point _p_ (an FXVec3d instance)
+    def contains?(p) ; end
+
+    # Returns +true+ if this box properly contains _aRange_ (another FXRanged
+    # instance)
+    def contains?(aRange) ; end
+
+    # Returns +true+ if this box properly contains _aSphere_ (an FXSphered
+    # instance)
+    def contains?(aSphere) ; end
+
+    #
+    # Include the given range or point into this range and return a reference
+    # to self. Valid forms are:
+    #
+    #     range.include!(aRange)  -> range
+    #     range.include!(x, y, z) -> range
+    #     range.include!(vec)     -> range
+    #     range.include!(sphere)  -> range
+    #
+    def include!(*args) ; end
+
+    # Intersect box with a plane <em>ax+by+cz+w</em>; returns -1, 0 or 1.
+    def intersect(plane); end
+
+    # Return true if the ray from _u_ to _v_ (both FXVec3d instances
+    # representing the ray endpoints) intersects this box.
+    def intersects?(u, v) ; end
+
+    # Returns +true+ if any part of this range overlaps the _other_ range.
+    def overlaps?(other) ; end
+
+    # Return the _c_th corner of this box (an FXVec3d instance).
+    # Raises IndexError if _c_ is less than zero or greater than 7.
+    def corner(c); end
+
+    # Return a new FXRanged instance which is the union of this box and
+    # another box.
+    def union(other); end
+
+    # Return a new FXRanged instance which is the intersection of this box
+    # and another box.
+    def intersection(other); end
+  end
+end

data/rdoc-sources/FXRangef.rb

@@ -0,0 +1,100 @@
+module Fox
+  #
+  # Represents a range in 3-D space.
+  #
+  class FXRangef
+  
+    # Lower corner of range [FXVec3f]
+    attr_accessor :lower
+
+    # Upper corner of range [FXVec3f]
+    attr_accessor :upper
+
+    # Default constructor
+    def initialize(xlo=0.0, xhi=0.0, ylo=0.0, yhi=0.0, zlo=0.0, zhi=0.0) ; end
+
+    # Initialize this FXRangef instance from another instance
+    def initialize(bounds); end
+
+    # Initialize box to fully contain the given sphere (an FXSpheref instance)
+    def initialize(sphere); end
+
+    # Return the width of the box
+    def width; end
+
+    # Return the height of the box
+    def height; end
+
+    # Return the depth of the box
+    def depth; end
+
+    # Return the length of the longest side of the box
+    def longest; end
+
+    # Return the length of the shortest side of the box
+    def shortest; end
+
+    # Return the length of the diagonal of the box
+    def diameter; end
+
+    # Return the radius of the box.
+    def radius; end
+
+    # Return the diagonal vector for the box (an FXVec3f instance).
+    def diagonal; end
+
+    # Return the center of the box (a point, as an FXVec3f instance).
+    def center; end
+
+    # Returns +true+ if this is an empty range (i.e. if any of the side
+    # lengths is zero or less).
+    def empty?() ; end
+
+    # Returns +true+ if this range contains the point (_x_, _y_, _z_).
+    def contains?(x, y, z) ; end
+
+    # Returns +true+ if this range contains the point _p_ (an FXVec3f instance)
+    def contains?(p) ; end
+
+    # Returns +true+ if this box properly contains _aRange_ (another FXRangef
+    # instance)
+    def contains?(aRange) ; end
+
+    # Returns +true+ if this box properly contains _aSphere_ (an FXSpheref
+    # instance)
+    def contains?(aSphere) ; end
+
+    #
+    # Include the given range or point into this range and return a reference
+    # to self. Valid forms are:
+    #
+    #     range.include!(aRange)  -> range
+    #     range.include!(x, y, z) -> range
+    #     range.include!(vec)     -> range
+    #     range.include!(sphere)  -> range
+    #
+    def include!(*args) ; end
+
+    # Intersect box with a plane <em>ax+by+cz+w</em>; returns -1, 0 or 1.
+    def intersect(plane); end
+
+    # Return true if the ray from _u_ to _v_ (both FXVec3f instances
+    # representing the ray endpoints) intersects this box.
+    def intersects?(u, v) ; end
+
+    # Returns +true+ if any part of this range overlaps the _other_ range.
+    def overlaps?(other) ; end
+
+    # Return the _c_th corner of this box (an FXVec3f instance).
+    # Raises IndexError if _c_ is less than zero or greater than 7.
+    def corner(c); end
+
+    # Return a new FXRangef instance which is the union of this box and
+    # another box.
+    def union(other); end
+
+    # Return a new FXRangef instance which is the intersection of this box
+    # and another box.
+    def intersection(other); end
+  end
+end