RiWindow Documentation

RiWindow

Quick Index

Class Summary

class RiWindow
{

public:

	// Constructors and assignment
	RiWindow(int sizeX , int sizeY , int posX , int posY );
	~RiWindow() ;;

	// Accessors
int	GetWidth();
int	GetHeight();
int	GetXPosition();
int	GetYPosition();

	// Members
void	Open(const char *name);
void	Close();
void	Save();
void	NeedsRedraw();
void	SetSize(int width, int height);
void	AddTimeout(int ms);
static int	GetNumOpenWindows();
protected:
void	PrintHelp();
void	MakeCurrent();
void	Keyboard(unsigned char key, int x, int y);
void	Mouse(int button, int state, int x, int y);
int	Timeout();
void	Redraw();
void	Reshape();
void	DoOpen();
void	DoClose();
void	DoSave();
void	DoNeedsRedraw();
void	DoSetSize();
void	DoAddTimeout();
static void	InsertAction(const RiWindowAction &act);
static void	GuiLock();
static void	GuiUnlock();
static RiWindow *	GetCurrentWindow();

}; // RiWindow

DESCRIPTION

KEYBOARD BINDINGS

q quit (close window) s save to file .tif

RiWindow(int sizeX , int sizeY , int posX , int posY );

Default Constructor

    RiWindow(int sizeX = -1, int sizeY = -1, int posX = -1, int posY = -1);

~RiWindow() ;;

Destructor

    virtual ~RiWindow()   ;
;

Function is currently defined inline.

int GetWidth();

    int		GetWidth();

int GetHeight();

    int		GetHeight();

int GetXPosition();

    int		GetXPosition();

int GetYPosition();

    int 	GetYPosition();

void Open(const char *name);

open the window

    void Open(const char *name);

void Close();

close the window

    void Close();

void Save();

save the contents of the window

    void Save();

void NeedsRedraw();

Tell the gui that the window needs to be redrawn

    void NeedsRedraw();

void SetSize(int width, int height);

Tell the gui to resize the window.

    void SetSize(int width, int height);

void AddTimeout(int ms);

Trigger the Timeout method in ms milleseconds

    void AddTimeout(int ms);

int GetNumOpenWindows();

Useful for knowing when to kill the app

    static int GetNumOpenWindows();

void PrintHelp();

Print info about any mouse and keyboard commands that apply (should call parent although this will cause ugly formating)

    virtual void PrintHelp();

void MakeCurrent();

Opens window if not already opened.

    void  MakeCurrent();

void Keyboard(unsigned char key, int x, int y);

    virtual void Keyboard(unsigned char key, int x, int y);

void Mouse(int button, int state, int x, int y);

    virtual void Mouse(int button, int state, int x, int y);

int Timeout();

Timeout returns the time in milleseconds until the next timeout use negative values for no more timeouts This implementation does nothing and returns -1. Overload as needed.

    virtual int Timeout();

void Redraw();

    virtual void Redraw();

void Reshape();

actions to be performed upon reshaping the window size[XY] and pos[XY] will have been updated.

    virtual void Reshape();

void DoOpen();

really open the window

    virtual void DoOpen();

void DoClose();

really close the window

    virtual void DoClose();

void DoSave();

really save the window

    virtual void DoSave();

void DoNeedsRedraw();

really notify the system that the window needs to be redrawn

    virtual void DoNeedsRedraw();

void DoSetSize();

really notify the system that the window needs to be redrawn

    virtual void DoSetSize();

void DoAddTimeout();

really insert the timeout function for the window.

    virtual void DoAddTimeout();

void InsertAction(const RiWindowAction &act);

Insert an action to be processed by the gui thread

    static void InsertAction(const RiWindowAction &act);

void GuiLock();

    static void GuiLock();

void GuiUnlock();

    static void GuiUnlock();

RiWindow *GetCurrentWindow();

    static RiWindow *GetCurrentWindow();

All Members

public:

	// Accessors
int	GetWidth();
int	GetHeight();
int	GetXPosition();
int	GetYPosition();

	// Members
void	Open(const char *name);
void	Close();
void	Save();
void	NeedsRedraw();
void	SetSize(int width, int height);
void	AddTimeout(int ms);
static int	GetNumOpenWindows();
protected:
void	PrintHelp();
void	MakeCurrent();
void	Keyboard(unsigned char key, int x, int y);
void	Mouse(int button, int state, int x, int y);
int	Timeout();
void	Redraw();
void	Reshape();
void	DoOpen();
void	DoClose();
void	DoSave();
void	DoNeedsRedraw();
void	DoSetSize();
void	DoAddTimeout();
static void	InsertAction(const RiWindowAction &act);
static void	GuiLock();
static void	GuiUnlock();
static RiWindow *	GetCurrentWindow();

Ancestors

Class does not inherit from any other class.

Descendants

Ri2DWindow
- RiImageWindow
  - RiRealImageWindow

Generated from source by the Cocoon utilities on Fri Feb 25 15:15:18 2000 .