###############################################################################
#                                                                             #
#  Copyright © 1989-1991 by Artificial Horizons®, Inc.  All rights reserved.  #
#                                                                             #
#      This material  constitutes  the trade  secrets  and confidential,      #
#      proprietary information of Bruce Factor and Curtis Priem,  and is      #
#      under license  to Artificial Horizons, Inc.   The material is not      #
#      to be disclosed,  reproduced,  copied,  or used in any manner not      #
#      permitted under license from Artificial Horizons, Inc.   For more      #
#      information email "ahi-interest@ahi.com".                              #
#                                                                             #
###############################################################################

LINE(3GC)             AVIATOR GRAPHICS INTERFACE CLASSES              LINE(3GC)



NAME
        FB_CLASS__LINE_2DS, FB_CLASS__LINE_2DX, FB_CLASS__LINE_3DX,
        FB_CLASS__LINE_4DX - line classes

SYNOPSIS
        #include <agi.h>
        register Fbuffer fbp;

        fbstart(fbp, FB_CLASS__LINE_2DS)  {
        }  fbend(fbp);

        fbstart(fbp, FB_CLASS__LINE_2DX)  {
        }  fbend(fbp);

        fbstart(fbp, FB_CLASS__LINE_3DX)  {
        }  fbend(fbp);

        fbstart(fbp, FB_CLASS__LINE_4DX)  {
        }  fbend(fbp);

DESCRIPTION
        The class FB_CLASS__LINE_2DS is used for rendering lines and polylines
        in two dimensional screen coordinates with no matrix transform
        applied.  Legal members for this class are:
                X, Y

        The class FB_CLASS__LINE_2DX is used for rendering 2 dimensional lines
        and polylines with the current matrix transform applied.  Legal
        members for this class are:
                X, Y

        The class FB_CLASS__LINE_3DX is used for rendering 3 dimensional lines
        and polylines with the current matrix transform applied.  Legal
        members for this class are:
                X, Y, Z

        The class FB_CLASS__LINE_4DX is used for rendering 4 dimensional lines
        and polylines with the current matrix transform applied.  Legal
        members for this class are:
                X, Y, Z, W

MEMBERS
        The following public members can be accessed by using routines
        fbput(3G) and fbget(3G).  These 32 bit numbers can be signed integer,
        signed 16.16 fixed point, or IEEE single precision floating point
        format.  The coordinate (0,0) is the upper left corner of the paint
        canvas, or the upper left corner of the frame buffer when running
        without a windowing system.

        FB_MEMBER__X__INTEGER
        FB_MEMBER__X__FIXED
        FB_MEMBER__X__FLOAT
                X is the x component of the end point of the line currently
                being defined.
        FB_MEMBER__Y__INTEGER
        FB_MEMBER__Y__FIXED
        FB_MEMBER__Y__FLOAT
                Y is the y component of the end point of the line currently
                being defined.
        FB_MEMBER__Z__INTEGER
        FB_MEMBER__Z__FIXED
        FB_MEMBER__Z__FLOAT
                Z is the z component of the end point of the line currently
                being defined.
        FB_MEMBER__W__INTEGER
        FB_MEMBER__W__FIXED
        FB_MEMBER__W__FLOAT
                W is the w component of the end point of the line currently
                being defined.

FUNCTIONS
        The following public functions can be called by using the fbcall(3G)
        routine:

        FB_FUNCTION__STORE_INCREMENT
                The STORE function stores the current point (X, Y, Z, and W)
                into the frame buffer.  The point reference is then
                incremented to reference the next point on the polyline.
        FB_FUNCTION__RENDER
                The RENDER function causes the frame buffer to render the
                line.

SEE ALSO
        fbcall(3G), fbend(3G), fbget(3G), fbput(3G), fbstart(3G)

PERFORMANCE
        INTEGER is the fastest format for FB_CLASS__LINE_2DS.



AGI Release 1.8         Last change: 25 December 1991