#include <SFBViewer.h.hpp>

class SFBViewer : public SFBBase;

SFMTYPEDEFWRAPPER(SFBViewer)

[ public ]
Void Draw(
    SInt32 x   // specifies the X coordinates of the upper left corner of the destination 
               //  rectangular area where the image needs to be drawn
    SInt32 y   // specifies the Y coordinates of the upper left corner of the destination 
               // rectangular area where the image needs to be drawn
);

[ public ]
Void Draw(
    SFXGridConstRef grid   // specifies the coordinates of the upper left corner of the destination 
                           // rectangular area where the image needs to be drawn
);

[ public ]
Void DrawFrame(
    SInt32 frame   // specifies the frame that needs to be drawn. 
                   // frame numbers start from 0 (zero). 
                   // frame of -1 may be passed to draw the "current" frame, if the image is being animated
    SInt32 x       // specifies the X coordinates of the upper left corner of the destination 
                   // rectangular area where the frame needs to be drawn
    SInt32 y       // specifies the Y coordinates of the upper left corner of the destination 
                   // rectangular area where the frame needs to be drawn
);

[ public ]
Void DrawFrame(
    SInt32 frame           // specifies the frame that needs to be drawn. 
                           // frame numbers start from 0 (zero). 
                           // frame of -1 may be passed to draw the "current" frame, if the image is being animated
    SFXGridConstRef grid   // specifies the coordinates of the upper left corner of the destination 
                           // rectangular area where the frame needs to be drawn
);

[ public ]
Void DrawOffscreen(
    SInt32 offscreen = 0   // if non-zero, indicates that the image should be drawn to off-screen buffer. 
                           // if zero, indicates that the image should be drawn on the main buffer. 
                           // this feature is supported only on devices that have support for double-buffering
);

[ public ]
Void GetInfo(
    AEEImageInfo* info   // on input, this must be a valid pointer to the AEEImageInfo data structure. 
                         // on output, the data structure is filled with valid information about the image. 
                         // the member of AEEImageInfo is as below:
                         // uint16 cx;       The width of the image (in pixels) 
                         // uint16 cy;       The height of the image (in pixels) 
                         // uint16 nColors;  The number of colors in the image,
                         // uint16 nFrames;  The number of frames in the image,
                         // this is set to 1 by default
        
);

[ public ]
Bool HandleEvent(
    AEEEvent event   // event code
    UInt16 wParam    // 16-bit event data
    UInt32 dwParam   // 32-bit event data
);

[ public ]
Bool HandleEvent(
    SFXEventConstRef event   // event
);

[ public, static ]
SFBViewerSmp NewInstance(
    AEECLSID id                    // Class ID
    SFCErrorPtr exception = null   // Error
);

[ public ]
Void Notify(
    PFNIMAGEINFO notify   // pointer to the callback function invoked when the image data is completely available
    VoidPtr data = null   // pointer to user-specific data that is passed to the callback function
);

[ public ]
Void SetAnimationRate(
    SInt32 rate   // animation rate in milliseconds
);

[ public ]
Void SetDisplay(
    SFBDisplaySmpConstRef display   // SFBDisplay interface
);

[ public ]
Void SetDrawSize(
    SInt32 width    // new width of the image
    SInt32 height   // new height of the image
);

[ public ]
Void SetFrameCount(
    SInt32 count   // number of frames
);

[ public ]
Void SetFrameSize(
    SInt32 width   // width of each frame 
);

[ public ]
Void SetOffset(
    SInt32 cx   // X coordinate of the new offset
    SInt32 cy   // Y coordinate of the new offset
);

[ public ]
Void SetOffset(
    SFXGridConstRef grid   // grid of the new offset
);

[ public ]
Void SetParm(
    SInt32 parm   // IPARM_SIZE, IPARM_OFFSET, IPARM_CXFRAME, IPARM_NFRAMES, IPARM_RATE, IPARM_ROP, or IPARM_OFFSCREEN
    SInt32 p1     // parm specific parameter value
    SInt32 p2     // parm specific parameter value
);

[ public ]
Void SetStream(
    SFBAStreamSmpConstRef stream   // SFBAStream class
                                   // SFBFile instance or SFBSocket class, etc.
);

[ public ]
SFCError SetStream(
    SFXStorageConstRef storage   // SFBAStream class
                                 // SFBFile instance or SFBSocket class, etc.
);

[ public ]
Void Start(
    SInt32 x   // specifies the X coordinates of the upper left corner of the destination 
               // rectangular area where the frame needs to be drawn
    SInt32 y   // specifies the Y coordinates of the upper left corner of the destination 
               // rectangular area where the frame needs to be drawn
);

[ public ]
Void Start(
    SFXGridConstRef grid   // specifies the coordinates of the upper left corner of the destination 
                           // rectangular area where the frame needs to be drawn
);

[ public ]
Void Stop(Void);