fxruby 1.6.13-mswin32

data/rdoc-sources/FXGIFCursor.rb

@@ -0,0 +1,50 @@
+module Fox
+  #
+  # GIF Cursor class.
+  #
+  class FXGIFCursor < FXCursor
+    #
+    # Return the suggested file extension for this image type ("gif").
+    #
+    def FXGIFCursor.fileExt; end
+
+    #
+    # Return an initialized FXGIFCursor instance.
+    #
+    def initialize(a, pix, hx=-1, hy=-1) # :yields: theGIFCursor
+    end
+  end  
+  
+  #
+  # Save a GIF (Graphics Interchange Format) image to a stream.
+  # If _fast_ is +true+, the faster Floyd-Steinberg dither method will be used
+  # instead of the slower Wu quantization algorithm.
+  # Returns +true+ on success, +false+ on failure.
+  #
+  # ==== Parameters:
+  #
+  # +store+::	stream to which to write the image data [FXStream]
+  # +data+::	the image pixel data [Array of FXColor]
+  # +width+::	width [Integer]
+  # +height+::	height [Integer]
+  # +fast+::	if +true+, use faster Floyd-Steinberg algorithm [Boolean]
+  #
+  def Fox.fxsaveGIF(store, data, width, height, fast=true); end
+  
+  #
+  # Load a GIF 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.fxloadGIF(store); end
+
+  #
+  # Return +true+ if _store_ (an FXStream instance) contains a GIF image.
+  #
+  def Fox.fxcheckGIF(store); end
+end

data/rdoc-sources/FXGIFIcon.rb

@@ -0,0 +1,31 @@
+module Fox
+  #
+  # GIF Icon class.
+  #
+  class FXGIFIcon < FXIcon
+    #
+    # Return the suggested file extension for this image type ("bmp").
+    #
+    def FXGIFIcon.fileExt; end
+
+    #
+    # Return the suggested MIME type for this image type
+    #
+    def FXGIFIcon.mimeType; end
+
+    #
+    # Return an initialized FXGIFIcon instance.
+    #
+    # ==== Parameters:
+    #
+    # +a+::	an application instance [FXApp]
+    # +pix+::	a memory buffer formatted in GIF 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: theGIFIcon
+    end
+  end
+end

data/rdoc-sources/FXGIFImage.rb

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

data/rdoc-sources/FXGLCanvas.rb

@@ -0,0 +1,45 @@
+module Fox
+  #
+  # FXGLCanvas is an area drawn by another object.
+  #
+  class FXGLCanvas < FXCanvas
+    #
+    # Construct an OpenGL-capable canvas, with its own private display list.
+    #
+    def initialize(parent, vis, target=nil, selector=0, opts=0, x=0, y=0, width=0, height=0) # :yields: theGLCanvas
+    end
+  
+    #
+    # Construct an OpenGL-capable canvas that shares its display
+    # list with another GL canvas.  This canvas becomes a member
+    # of a display list share group.  All members of the display
+    # list share group have to have the same visual.
+    #
+    def initialize(parent, vis, sharegroup, target=nil, selector=0, opts=0, x=0, y=0, width=0, height=0) # :yields: theGLCanvas
+    end
+
+    # Return +true+ if sharing display lists.
+    def shared? ; end
+
+    #
+    # Return an integer handle to the underlying OpenGL context.
+    # On Unix/Linux systems, this is the GLX rendering context
+    # returned by a call to glXCreateContext(). On Microsoft Windows
+    # systems, it is the value returns by wglCreateContext().
+    #
+    def context; end
+
+    # Make OpenGL context current prior to performing OpenGL commands
+    def makeCurrent(); end
+  
+    # Make OpenGL context non-current
+    def makeNonCurrent(); end
+
+    # Return +true+ if this canvas' context is the current context.
+    def current? ; end
+
+    # Swap front and back buffer
+    def swapBuffers(); end
+  end
+end
+

data/rdoc-sources/FXGLContext.rb

@@ -0,0 +1,40 @@
+module Fox
+  #
+  # A GL context is an object representing the OpenGL state information.
+  # Multiple GL context may share display lists to conserve memory.
+  # When drawing multiple windows, it may be advantageous to share not only
+  # display lists, but also GL contexts.  Since the GL context is created
+  # for a certain frame-buffer configuration, sharing of GL contexts is
+  # only possible if the windows sharing the GL context all have the same
+  # GL visual.
+  # However, display lists may be shared between different GL contexts.
+  #
+  class FXGLContext < FXId
+  
+    # The visual [FXGLVisual]
+    attr_reader :visual
+
+    # Construct an OpenGL context.
+    # If _other_ is a reference to an existing FXGLContext, this context will
+    # share display lists with that other context.
+    # Otherwise, this context will use its own private display list.
+    def initialize(app, visual, other=nil) # :yields: theGLContext
+    end
+  
+    # Return +true+ if it is sharing display lists.
+    def shared?; end
+    
+    # Make this OpenGL context current prior to performing OpenGL commands.
+    def begin(drawable); end
+    
+    # Make this OpenGL context non-current.
+    def end(); end
+    
+    # Swap front and back buffer
+    def swapBuffers(); end
+    
+    # Copy part of backbuffer to front buffer [Mesa]
+    def swapSubBuffers(x, y, w, h); end
+  end
+end
+

data/rdoc-sources/FXGLObject.rb

@@ -0,0 +1,75 @@
+module Fox
+  #
+  # Basic OpenGL object.
+  #
+  class FXGLObject < FXObject
+    #
+    # Return an initialized FXGLObject instance.
+    #
+    def initialize # :yields: theGLObject
+    end
+
+    #
+    # Return a new object which is a copy (i.e. a "clone") of this one.
+    #
+    def copy; end
+    
+    #
+    # Return a bounding box (an FXRangef instance) for this object.
+    #
+    def bounds; end
+    
+    #
+    # Draw this object in a viewer.
+    #
+    # ==== Parameters:
+    #
+    # +viewer+::	the viewer window into which we're drawing [FXGLViewer]
+    #
+    def draw(viewer); end
+    
+    #
+    # Draw this object for hit-testing purposes.
+    #
+    # ==== Parameters:
+    #
+    # +viewer+::	the viewer window into which we're drawing [FXGLViewer]
+    #
+    def hit(viewer); end
+    
+    #
+    # Return +true+ if this object can be dragged around.
+    #
+    def canDrag; end
+    
+    #
+    # Return +true+ if this object can be deleted from the scene.
+    #
+    def canDelete; end
+    
+    #
+    # Drag this object from one position to another. Returns +true+
+    # if the drag was successful.
+    #
+    # ==== Parameters:
+    #
+    # +viewer+::	the viewer window in which we're dragging [FXGLViewer]
+    # +fx+::		x-coordinate for position we're dragging from [Integer]
+    # +fy+::		y-coordinate for position we're dragging from [Integer]
+    # +tx+::		x-coordinate for position we're dragging to [Integer]
+    # +ty+::		y-coordinate for position we're dragging to [Integer]
+    #
+    def drag(viewer, fx, fy, tx, ty); end
+
+    #
+    # Identify sub-object given path, where _path_ is a list of integer
+    # names pushed onto the stack during hit testing.
+    #
+    # ==== Parameters:
+    #
+    # +path+::	an array of integers [Array]
+    #
+    def identify(path); end
+  end
+end
+

data/rdoc-sources/FXGLShape.rb

@@ -0,0 +1,69 @@
+module Fox
+  #
+  # OpenGL shape object.
+  #
+  # === Shape drawing options
+  #
+  # +SURFACE_SINGLESIDED+::	Single-sided [both sides same]
+  # +SURFACE_DUALSIDED+::	Dual-sided surface
+  # +SHADING_NONE+::		No light source
+  # +SHADING_SMOOTH+::		Smooth shaded
+  # +SHADING_FLAT+::		Flag shaded
+  # +FACECULLING_OFF+::		No face culling
+  # +FACECULLING_ON+::		Cull backward facing surfaces
+  # +STYLE_SURFACE+::		Draw filled surfaces
+  # +STYLE_WIREFRAME+::		Draw wire frame
+  # +STYLE_POINTS+::		Draw as points
+  # +STYLE_BOUNDBOX+::		Draw bounding box
+  #
+  # === Message identifiers
+  #
+  # +ID_SHADEOFF+::		x
+  # +ID_SHADEON+::		x
+  # +ID_SHADESMOOTH+::		x
+  # +ID_TOGGLE_SIDED+::		x
+  # +ID_TOGGLE_CULLING+::	x
+  # +ID_STYLE_POINTS+::		x
+  # +ID_STYLE_WIREFRAME+::	x
+  # +ID_STYLE_SURFACE+::	x
+  # +ID_STYLE_BOUNDINGBOX+::	x
+  # +ID_FRONT_MATERIAL+::	x
+  # +ID_BACK_MATERIAL+::	x
+  #
+  class FXGLShape < FXGLObject
+  
+    # Tool tip message for this shape [String]
+    attr_accessor :tipText
+
+    # Position [FXVec3f]
+    attr_accessor :position
+    
+    #
+    # Draws the shape in this GL viewer.
+    #
+    def drawshape(viewer); end
+
+    #
+    # Construct with specified origin, options and front and back materials.
+    #
+    def initialize(x, y, z, opts, front=nil, back=nil) # :yields: theGLShape
+    end
+
+    #
+    # Set the material for specified side, where _side_ = 0 or 1
+    # and _mtl_ is an FXMaterial instance.
+    #
+    def setMaterial(side, mtl); end
+
+    #
+    # Get the material for specified side (where _side_ = 0 or 1).
+    #
+    def getMaterial(side); end
+    
+    #
+    # Set the range (an FXRangef instance) for this shape.
+    #
+    def setRange(box); end
+  end
+end
+

data/rdoc-sources/FXGLViewer.rb

@@ -0,0 +1,332 @@
+module Fox
+  # OpenGL Viewer Viewport
+  class FXViewport
+    # Viewport width [Integer]
+    attr_accessor :w
+    
+    # Viewport height
+    attr_accessor :h
+    
+    # World left [Float]
+    attr_accessor :left
+
+    # World right [Float]
+    attr_accessor :right
+
+    # World bottom [Float]
+    attr_accessor :bottom
+
+    # World top [Float]
+    attr_accessor :top
+
+    # World hither [Float]
+    attr_accessor :hither
+
+    # World yon [Float]
+    attr_accessor :yon
+    
+    # Returns an initialized FXViewport instance
+    def initialize; end
+  end
+
+  # OpenGL Light Source
+  class FXLight
+    # Ambient light color [FXVec4f]
+    attr_accessor :ambient
+
+    # Diffuse light color [FXVec4f]
+    attr_accessor :diffuse
+
+    # Specular light color [FXVec4f]
+    attr_accessor :specular
+
+    # Light position [FXVec4f]
+    attr_accessor :position
+
+    # Spot direction [FXVec3f]
+    attr_accessor :direction
+
+    # Spotlight exponent [Float]
+    attr_accessor :exponent
+
+    # Spotlight cutoff angle [Float]
+    attr_accessor :cutoff
+
+    # Constant attenuation factor [Float]
+    attr_accessor :c_attn
+
+    # Linear attenuation factor [Float]
+    attr_accessor :l_attn
+
+    # Quadratic attenuation factor [Float]
+    attr_accessor :q_attn
+    
+    # Returns an initialized FXLight instance
+    def initialize; end
+  end
+
+  # OpenGL Material Description
+  class FXMaterial
+    # Ambient material color [FXVec4f]
+    attr_accessor :ambient
+    
+    # Diffuse material color [FXVec4f]
+    attr_accessor :diffuse
+    
+    # Specular material color [FXVec4f]
+    attr_accessor :specular
+    
+    # Emissive material color [FXVec4f]
+    attr_accessor :emission
+    
+    # Specular shininess [Float]
+    attr_accessor :shininess
+    
+    # Returns an initialized FXMaterial instance
+    def initialize; end
+  end
+
+  #
+  # Canvas, an area drawn by another object
+  #
+  # === Events
+  #
+  # The following messages are sent by FXGLViewer to its message target:
+  #
+  # +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.
+  # +SEL_MIDDLEBUTTONPRESS+::	sent when the middle mouse button goes down; the message data is an FXEvent instance.
+  # +SEL_MIDDLEBUTTONRELEASE+::	sent when the middle mouse button goes up; the message data is an FXEvent instance.
+  # +SEL_RIGHTBUTTONPRESS+::	sent when the right mouse button goes down; the message data is an FXEvent instance.
+  # +SEL_RIGHTBUTTONRELEASE+::	sent when the right mouse button goes up; the message data is an FXEvent instance.
+  # +SEL_MOTION+::		sent when the mouse pointer is moved; the message data is an FXEvent instance.
+  # +SEL_MOUSEWHEEL+::		sent when the mouse wheel is spun; the message data is an FXEvent instance.
+  # +SEL_CLICKED+::		sent when the mouse is single-clicked somewhere in the widget; the message data is a reference to the clicked object (possibly +nil+)
+  # +SEL_DOUBLECLICKED+::	sent when the mouse is double-clicked somewhere in the widget; the message data is a reference to the clicked object (possibly +nil+)
+  # +SEL_TRIPLECLICKED+::	sent when the mouse is triple-clicked somewhere in the widget; the message data is a reference to the clicked object (possibly +nil+)
+  # +SEL_PICKED+::		sent when an object is picked; the message data is an FXEvent instance.
+  # +SEL_SELECTED+::		sent when object(s) are selected in the viewer; the message data is an array of references to the selected objects.
+  # +SEL_DESELECTED+::		sent when object(s) are deselected in the viewer; the message data is an array of references to the deselected objects.
+  # +SEL_LASSOED+::		sent when a lasso-selection has been completed; the message data is an FXEvent instance.
+  # +SEL_INSERTED+::		sent when the viewer receives a +SEL_INSERTED+ message.
+  # +SEL_DELETED+::		sent when the viewer receives a +SEL_COMMAND+ message with the +ID_DELETE_SEL+ identifier; the message data is an array of references to the selected object(s).
+  # +SEL_DRAGGED+::		sent when the selected object is dragged around in the viewer; the message data is a reference to the selected object.
+  # +SEL_COMMAND+::		sent when the mouse is clicked somewhere in the widget; the message data is a reference to the clicked object (possibly +nil+)
+  # +SEL_CHANGED+::		sent when the selection changes; the message data is a reference to the newly selected object (or +nil+).
+  # 
+  # === FXGLViewer options
+  #
+  # +VIEWER_LIGHTING+::	Lighting is on
+  # +VIEWER_FOG+::	Fog mode on
+  # +VIEWER_DITHER+::	Dithering
+  #
+  # === Projection modes (class constants)
+  #
+  # +PARALLEL+::	Parallel projection
+  # +PERSPECTIVE+::	Perspective projection
+  #
+  # === Message identifiers
+  #
+  # +ID_PERSPECTIVE+::		x
+  # +ID_PARALLEL+::		x
+  # +ID_FRONT+:: x
+  # +ID_BACK+:: x
+  # +ID_LEFT+:: x
+  # +ID_RIGHT+:: x
+  # +ID_TOP+:: x
+  # +ID_BOTTOM+:: x
+  # +ID_RESETVIEW+:: x
+  # +ID_FITVIEW+:: x
+  # +ID_TIPTIMER+:: x
+  # +ID_TOP_COLOR+:: x
+  # +ID_BOTTOM_COLOR+:: x
+  # +ID_BACK_COLOR+:: x    
+  # +ID_AMBIENT_COLOR+:: x
+  # +ID_LIGHT_AMBIENT+:: x
+  # +ID_LIGHT_DIFFUSE+:: x
+  # +ID_LIGHT_SPECULAR+:: x
+  # +ID_LIGHTING+:: x
+  # +ID_TURBO+:: x
+  # +ID_FOG+:: x
+  # +ID_DITHER+:: x
+  # +ID_SCALE_X+:: x
+  # +ID_SCALE_Y+:: x
+  # +ID_SCALE_Z+:: x
+  # +ID_DIAL_X+:: x
+  # +ID_DIAL_Y+:: x
+  # +ID_DIAL_Z+:: x
+  # +ID_ROLL+:: x
+  # +ID_PITCH+:: x
+  # +ID_YAW+:: x
+  # +ID_FOV+:: x
+  # +ID_ZOOM+:: x
+  # +ID_CUT_SEL+:: x
+  # +ID_COPY_SEL+:: x
+  # +ID_PASTE_SEL+:: x
+  # +ID_DELETE_SEL+:: x
+  # +ID_PRINT_IMAGE+:: x
+  # +ID_PRINT_VECTOR+:: x
+  # +ID_LASSO_ZOOM+:: x
+  # +ID_LASSO_SELECT+:: x
+  #
+  class FXGLViewer < FXGLCanvas
+  
+    # Size of pixel in world coordinates [Float]
+    attr_reader :worldPix
+    
+    # Size of pixel in model coordinates [Float]
+    attr_reader :modelPix
+    
+    # The viewport for this viewer [FXViewport]
+    attr_reader :viewport
+    
+    # Default object material setting [FXMaterial]
+    attr_accessor :material
+
+    # Camera field of view angle (in degrees) [Float]
+    attr_accessor :fieldOfView    
+
+    # Camera zoom factor [Float]
+    attr_accessor :zoom
+
+    # Target point distance [Float]
+    attr_accessor :distance
+    
+    # Current scaling factors [FXVec3f]
+    attr_accessor :scale
+    
+    # Camera orientation [FXQuatf]
+    attr_accessor :orientation
+    
+    # Object center [FXVec3f]
+    attr_accessor :center
+    
+    # Eyesight vector [FXVec3f]
+    attr_reader :eyeVector
+    
+    # Eye position [FXVec3f] 
+    attr_reader :eyePosition
+    
+    # Status line help text [String]
+    attr_accessor :helpText
+    
+    # Tool tip text [String]
+    attr_accessor :tipText
+
+    # The current transformation matrix [FXMat4f]
+    attr_reader :transform
+  
+    # The inverse of the current transformation matrix [FXMat4f]
+    attr_reader :invTransform
+  
+    # The current scene object [FXGLObject]
+    attr_accessor :scene
+  
+    # The selection [FXGLObject]
+    attr_accessor :selection
+  
+    # The projection mode (either +FXGLViewer::PERSPECTIVE+ or +FXGLViewer::PARALLEL+)
+    attr_accessor :projection
+    
+    # Global ambient light color [FXMat4f]
+    attr_accessor :ambientColor
+  
+    # The maximum hits, i.e. the maximum size of the pick buffer [Integer].
+    # When less than or equal to zero, picking is essentially turned off.
+    attr_accessor :maxHits
+  
+    # Set turbo mode [Boolean]
+    attr_writer :turboMode
+    
+    # Light source settings [FXLight]
+    attr_accessor :light
+    
+    # Returns the FXDragType for FXGLObject
+    def FXGLViewer.objectType; end
+  
+    # Returns the drag type name
+    def FXGLViewer.objectTypeName; end
+  
+    #
+    # Construct GL viewer widget
+    #
+    def initialize(p, vis, target=nil, selector=0, opts=0, x=0, y=0, width=0, height=0) # :yields: theGLViewer
+    end
+    
+    #
+    # Construct GL viewer widget sharing display list with another GL viewer
+    #
+    def initialize(p, vis, sharegroup, target=nil, selector=0, opts=0, x=0, y=0, width=0, height=0) # :yields: theGLViewer
+    end
+  
+    # Return an array of all objects in the given rectangle
+    def lasso(x1, y1, x2, y2); end
+  
+    # Change the model bounding box; this adjusts the viewer
+    def setBounds(box); end
+    
+    # Fit viewer to the given bounding box
+    def fitToBounds(box); end
+    
+    #
+    # Translate eye-coordinate to screen coordinate.
+    # Returns a 2-element array [sx, sy] containing the screen coordinate.
+    #
+    def eyeToScreen(e); end
+  
+    # Translate screen coordinate to eye coordinate at the given depth.
+    def screenToEye(sx, sy, eyez=0.0); end
+    
+    # Translate screen coordinate to eye coordinate at the target point depth
+    def screenToTarget(sx, sy); end
+    
+    # Translate world coordinate to eye coordinate
+    def worldToEye(w); end
+    
+    # Translate world coordinate to eye coordinate depth
+    def worldToEyeZ(w); end
+    
+    # Translate eye coordinate to eye coordinate
+    def eyeToWorld(e); end 
+    
+    # Calculate world coordinate vector from screen movement
+    def worldVector(fx, fy, tx, ty); end
+    
+    # Translate object center
+    def translate(vec); end
+    
+    # Return boresight vector (an array of two arrays)
+    def getBoreVector(sx, sy); end
+    
+    # Returns +true+ if the viewer is locked
+    def locked?; end
+    
+    # Read the pixels off the screen as R,G,B tuples.
+    def readPixels(x, y, w, h); end
+    
+    # Read the feedback buffer containing the current scene.
+    def readFeedback(x, y, w, h); end
+    
+    #
+    # When drawing a GL object, if doesTurbo? returns +true+, the object
+    # may choose to perform a reduced complexity drawing as the user is
+    # interactively manipulating; another update will be done later when
+    # the full complexity drawing can be performed again.
+    #
+    def doesTurbo?; end
+    
+    # Returns +true+ if turbo mode is enabled
+    def turboMode?; end
+
+    #
+    # Change top, bottom or both background colors.
+    #
+    def setBackgroundColor(clr, bottom=MAYBE); end
+
+    # Return top or bottom window background color.
+    def getBackgroundColor(bottom=false); end
+  end
+end
+