New GtkOgre widget with demo!

Post by **DWORD** » Fri Jun 23, 2006 2:04 pm

Hi,

I'd like to announce the release of a new GtkOgre widget. It embeds Ogre render windows into GtkWidgets, but it's still very basic. You won't believe how many hours I spent with expose events and stopping it from flickering, though.

This is actually a side-product, because in the end I want to write a cross-platform wxWidget so it becomes very easy to embed Ogre on all platforms (Windows and Linux at least, don't know Mac).

The small demo application in action (it does nothing but display the scene):

Source code: gtkogre-0.1.0-src.tar.bz2

Now let's see some cross-platform tools!

reimpell · Post by **reimpell** » Fri Jun 23, 2006 2:52 pm

Great! Now one just need to write a wrapper for gtkmm...

Ocelot · Post by **Ocelot** » Fri Jun 23, 2006 5:02 pm

DWORD YOU ARE GREAT !!!!
After some changes (thanks Shaft) I can use it in Windows !!!
Proof:

And changes: ALL in gtkogre.cpp
1. include

Code: Select all

#if defined( __WIN32__ ) || defined( _WIN32 )
#include <gdk/gdkwin32.h>
#else
#include <gdk/gdkx.h>
#endif

2. Parameters for Ogre::Root::getSingleton().createRenderWindow

Code: Select all

  Ogre::NameValuePairList params;
#if defined( __WIN32__ ) || defined( _WIN32 )
  params["parentWindowHandle"] =
    Ogre::StringConverter::toString((unsigned long)GDK_WINDOW_HWND(parent));
#else
  Display* xdisplay = GDK_DISPLAY_XDISPLAY(display);
  Screen* xscreen = GDK_SCREEN_XSCREEN(screen);
  int screen_number = XScreenNumberOfScreen(xscreen);
  XID xid_parent = GDK_WINDOW_XWINDOW(parent);

  params["parentWindowHandle"] =
    Ogre::StringConverter::toString(reinterpret_cast<unsigned long>(xdisplay)) + ":" +
    Ogre::StringConverter::toString(static_cast<unsigned int>(screen_number)) + ":" +
    Ogre::StringConverter::toString(static_cast<unsigned long>(xid_parent));
#endif

3. Get the window id of the render window

Code: Select all

  /* Get the window id of the render window */
  GdkNativeWindow xid;
#if defined( __WIN32__ ) || defined( _WIN32 )
  ogre->render_window->getCustomAttribute("HWND", (void*)&xid);
#else
  ogre->render_window->getCustomAttribute("GLXWINDOW", (void*)&xid);
#endif

If you want, I can send you my code::blocks project file, which compile your demo program.

Wait for my GREAT, SUPER Ogre tools....

Post by **DWORD** » Fri Jun 23, 2006 5:54 pm

Ocelot wrote:After some changes (thanks Shaft) I can use it in Windows !!!

Wow, didn't expect that to be so easy; I thought GTK was difficult to set up on Windows. I'll put in your changes. Thanks.

Ocelot wrote:If you want, I can send you my code::blocks project file, which compile your demo program.

I don't use Code::Blocks myself but maybe others will find it useful.

Ocelot wrote:Wait for my GREAT, SUPER Ogre tools....

I will.

Post by **jacmoe** » Fri Jun 23, 2006 6:43 pm

@DWORD: Awesome! And it would be even more awesome once this is wxWidget'ed.

@Ocelot: What do you need to download in order to build this on Windows?

Game_Ender · Post by **Game_Ender** » Fri Jul 14, 2006 4:30 pm

By all reports the standard wxOgre widget from the wiki works fine for windows. I think we might need another custom effort like this on Mac, but I am not sure.

EDIT: Thanks for posting this, all the code you have to build the "parentWindowHandle" is directly applicable to wxOgre and wxGTK. Hopefully I or somebody else will actually find the time to update it. Now we really do need mac support.

I guess its time to start digging down into the Mac OpenGL support. For every ones edification, wxMac returns a ControlRef from Window::GetHandle().

Post by **DWORD** » Fri Jul 14, 2006 5:20 pm

I was not implying that the existing wxOgre didn't work.

But it has some small limitations, no support for multiple render windows being one of them, but that's easy to overcome. Linux support was a bit more work, at least for wxGTK because it had to go through a custom GtkWidget. But I've put the cross-platform wxOgre on hold for a while, got tired of tumbling with wxWidgets, I hit some weird problems on Linux. And I found that the (free) tools for GTK development were much better.

Game_Ender · Post by **Game_Ender** » Fri Jul 14, 2006 6:13 pm

I can understand the tools issue, the state of free wxWidgets RAD tools is not super good.

Its great to give people another alternative to wxWidgets and .NET for Ogre based tool making.

Ocelot · Post by **Ocelot** » Sat Jul 15, 2006 4:26 pm

DWORD, I'm playing a little with gtkogre widget and there is one "simple" problem. I can't force the widget to obtain signals other then "expose_event" and "scroll-event" (and probably destroy and delete

).
I've try add mask

Code: Select all

gtk_widget_add_events(GTK_WIDGET(ogre), GDK_BUTTON_PRESS_MASK);

set mask (in gtkogre.h)

Code: Select all

gdk_window_set_events(widget->window, static_cast<GdkEventMask>(
      gdk_window_get_events(widget->window) | GDK_EXPOSURE_MASK |GDK_BUTTON_PRESS_MASK ));

and even add event box over a gtkogre widget. But without success.

Do you know how to solve this?
I think that, the problem is with "parentWindowHandle" and gdk_window_foreign_new struff. When I use "externalWindowHandle", gtk signals are o'k but window looks ... hm funy.

PS. I've try connect OIS to the Ogre render window, result:
An exception has occured: Win32Mouse::Win32Mouse >> Failed to set coop level 64

Post by **Wolfmanfx** » Mon Aug 07, 2006 2:53 pm

I added a VC8 sln to buíld under windows i slightly modifi the demo to work against Eihort.
There a are still small bugs where no expose event is called.
I tested it with DX9 renderer plugin this works not so good as the OGL renderer maybe someone else should test it.

http://stud3.tuwien.ac.at/~e0126198/gtk ... ed_vc8.rar

@jacmoe
You need gtk-win32-devel-2.6.10-rc1.exe then u have to set OGRE_BASEPATH to ogre root and then u can build with VC8 Project files.

Post by **Wolfmanfx** » Thu Aug 10, 2006 3:30 pm

[edit]: Sry false URL

Post by **Wolfmanfx** » Fri Aug 11, 2006 8:29 am

http://dword.dk/blog/2006/07/welcome/#comments

Game_Ender · Post by **Game_Ender** » Thu Nov 09, 2006 4:08 am

To bring back and old topic, has anyone got this to work on Ubuntu Dapper? I have gotten it running but it doesn't embed the windows, they are floating.

Game_Ender · Post by **Game_Ender** » Tue Dec 05, 2006 4:17 am

So, I am trying this with Ubuntu Edgy, and Ogre 1.3 CVS and it needs some change to run with the new release of Ogre. See bellow for the line that fails.

Code: Select all

  /* Get the window id of the render window */
  XID xid;
  ogre->render_window->getCustomAttribute("GLXWINDOW", &xid);

  /* Create the widget's GdkWindow from the render window */
  widget->window = gdk_window_foreign_new(xid);  /* THIS FAILS */
  gdk_window_set_user_data(widget->window, widget);

The getCustomAttribute line needs to be changed to:

Code: Select all

ogre->render_window->getCustomAttribute("WINDOW", &xid);

Then it works just fine, now onto getting this to work with wxWidgets.

Post by **Wolfmanfx** » Tue Dec 05, 2006 12:24 pm

Hi iam also using ubuntu

Why all Guys using wxWidgets use gtk+ ^^ soon i will release a crossplattform windowmanager for gtk+(its like window forms) http://stud3.tuwien.ac.at/~e0126198/ogre2vp.jpg here a shot under linux http://stud3.tuwien.ac.at/~e0126198/win ... _linux.png but iam working now at a toolbar system...

Trigve · Post by **Trigve** » Sun Dec 17, 2006 10:42 pm

Hi @ll,

I'm making game editor and want to make it with gtkmm/GTK+...On wiki I've found GTK ogre widget...I was happy:) but when I was using it I've encounter the bugs like no expose events or mouse motion notify events (as written in this topic)...so I was looking in code to find if something can be done to fix it...So I've made new gtkmm ogre widget...it is based on gtkmm custom widget example and GTK+ widget (first post in this topic)... I don't have any ftp server or so where can I put it...so I'm pasting the code here....hope it will help someone..it was tested on winXP with ogre 1.2.4, GTK+ 2.10.6, gtkmm 2.10.5-1

GtkOgreWidget.h

Code: Select all

#pragma once

#include <gtkmm/widget.h>

class GtkOgreWidget : public Gtk::Widget
{
	// Attributes
private:
	//! GDK window.
	Glib::RefPtr<Gdk::Window> m_refGdkWindow;
	//! Ogre render window.
	Ogre::RenderWindow* m_pWindow;
	//! ID of window.
	static int m_ID;

	// Operations
public:
	//! Get ogre render window.
	Ogre::RenderWindow* getRenderWindow(void) throw();

protected:
	virtual void on_size_request(Gtk::Requisition* requisition);
	virtual void on_size_allocate(Gtk::Allocation& allocation);
	virtual void on_map();
	virtual void on_unmap();
	virtual void on_realize();
	virtual void on_unrealize();
	virtual bool on_expose_event(GdkEventExpose* event);
	

	// Construction/Destruction
public:
	GtkOgreWidget(void);
	virtual ~GtkOgreWidget(void);
};

GtkOgreWidget.cpp

Code: Select all

#include "GtkOgreWidget.h"

int GtkOgreWidget::m_ID = 0;

GtkOgreWidget::GtkOgreWidget(void)
	: Glib::ObjectBase("GtkOgre"), Gtk::Widget(), m_pWindow(NULL)
{
	set_flags(Gtk::NO_WINDOW);
	//This shows the GType name, which must be used in the RC file.
	std::cout << "GType name: " <<G_OBJECT_TYPE_NAME(gobj()) << std::endl;
	
}

GtkOgreWidget::~GtkOgreWidget(void)
{
}

void GtkOgreWidget::on_size_request(Gtk::Requisition* requisition)
{
	//Initialize the output parameter:
	*requisition = Gtk::Requisition();

	//Discover the total amount of minimum space needed by this widget.

	//Let's make this simple example widget always need 50 by 50:
	requisition->height = 200;
	requisition->width = 200;
}

void GtkOgreWidget::on_size_allocate(Gtk::Allocation& allocation)
{
	std::cout << "GtkOgreWidget::on_size_allocate" << std::endl;
	//Do something with the space that we have actually been given:
	//(We will not be given heights or widths less than we have requested, though we might get more)

	//Use the offered allocation for this container:
	set_allocation(allocation);

	if(m_refGdkWindow)
		m_refGdkWindow->move_resize(allocation.get_x(), allocation.get_y(), allocation.get_width(), allocation.get_height());

	
	if (m_pWindow)
	{
		/* Let Ogre update the viewport dimensions. */
		getRenderWindow()->windowMovedOrResized();
//		std::cout << "Width:" << getRenderWindow()->getWidth() << ", Height:" << getRenderWindow()->getHeight() << std::endl;
		on_expose_event(NULL);
	}
}

void GtkOgreWidget::on_map()
{
	//Call base class:
	Gtk::Widget::on_map();
}

void GtkOgreWidget::on_unmap()
{
	//Call base class:
	Gtk::Widget::on_unmap();
}

void GtkOgreWidget::on_realize()
{
	//Call base class:
	Gtk::Widget::on_realize();
	if(!m_refGdkWindow)
	{
		//Create the GdkWindow:
		GdkWindowAttr attributes;
		memset(&attributes, 0, sizeof(attributes));

		Gtk::Allocation allocation = get_allocation();

		//Set initial position and size of the Gdk::Window:
		attributes.x = allocation.get_x();
		attributes.y = allocation.get_y();
		attributes.width = allocation.get_width();
		attributes.height = allocation.get_height();

		attributes.event_mask = get_events () | Gdk::EXPOSURE_MASK | Gdk::ALL_EVENTS_MASK ; 
		attributes.window_type = GDK_WINDOW_CHILD;
		attributes.wclass = GDK_INPUT_OUTPUT;

		m_refGdkWindow = Gdk::Window::create(get_window(), &attributes, GDK_WA_X | GDK_WA_Y);
		Ogre::NameValuePairList params; 
#ifdef WIN32
	params["externalWindowHandle"] = Ogre::StringConverter::toString((unsigned long)GDK_WINDOW_HWND(m_refGdkWindow->gobj()));
#else
#endif
		m_pWindow = Ogre::Root::getSingleton().createRenderWindow("GtkOgreWidget" + Ogre::StringConverter::toString(++m_ID),
			allocation.get_width(), allocation.get_height(), false, &params);
		
		unset_flags(Gtk::NO_WINDOW);
		set_window(m_refGdkWindow);

		set_double_buffered(false);
		//make the widget receive expose events
		m_refGdkWindow->set_user_data(gobj());
		m_refGdkWindow->set_back_pixmap(Glib::RefPtr<Gdk::Pixmap>(), false);
		//Allocate a GC for use in on_expose_event():
	}
}

void GtkOgreWidget::on_unrealize()
{
	 m_refGdkWindow.clear();

	 //Call base class:
	 Gtk::Widget::on_unrealize();
}

bool GtkOgreWidget::on_expose_event(GdkEventExpose* event)
{
//	std::cout << "GtkOgreWidget::onExpose" << std::endl;
	//Draw on the Gdk::Window:
    m_refGdkWindow->clear();
	getRenderWindow()->update();
//	std::cout << "Width:" << getRenderWindow()->getWidth() << ", Heiht:" << getRenderWindow()->getHeight() << std::endl;
	return true;
}

Ogre::RenderWindow* GtkOgreWidget::getRenderWindow(void) throw()
{
	assert(m_pWindow);
	return m_pWindow;
}

I think there is needed some code for destroying RenderWindow

thanks

Trigve

Game_Ender · Post by **Game_Ender** » Sun Dec 17, 2006 11:57 pm

That "#else #endif" section with no lines in between should read:

Code: Select all

#else
#error Unsupported Platform
#endif

On the whole embedding Ogre issue, if I can't get this to work propely with stock wxWidgets, I will just use the GtkOgre widget with wxWidgets on Linux.

Trigve · Post by **Trigve** » Mon Dec 18, 2006 12:19 am

Game_Ender wrote:That "#else #endif" section with no lines in between should read:
Code: Select all
#else
#error Unsupported Platform
#endif

There should by the same code as in the original GtkOgre....so something like this (haven't tried it!)

Code: Select all

GdkWindow* parent = m_refGdkWindow->gobj();
	GdkDisplay* display = gdk_drawable_get_display(GDK_DRAWABLE(parent));
	GdkScreen* screen = gdk_drawable_get_screen(GDK_DRAWABLE(parent));

Display* xdisplay = GDK_DISPLAY_XDISPLAY(display); 
	Screen* xscreen = GDK_SCREEN_XSCREEN(screen); 
	int screen_number = XScreenNumberOfScreen(xscreen); 
	XID xid_parent = GDK_WINDOW_XWINDOW(parent); 

	params["externalWindowHandle"] = 
		Ogre::StringConverter::toString(reinterpret_cast<unsigned long>(xdisplay)) + ":" + 
		Ogre::StringConverter::toString(static_cast<unsigned int>(screen_number)) + ":" + 
		Ogre::StringConverter::toString(static_cast<unsigned long>(xid_parent));

Trigve

Ocelot · Post by **Ocelot** » Mon Dec 18, 2006 7:07 pm

I was using it I've encounter the bugs like no expose events or mouse motion notify events (as written in this topic)...

I've resolved mouse event problems by using OIS

Trigve · Post by **Trigve** » Mon Dec 18, 2006 8:15 pm

Ocelot wrote:I've resolved mouse event problems by using OIS

Yes, using OIS is another solution...If everything else have failed then OIS would be the solution..but why should I use another library if input can be done with gtkmm? And also when I was using OIS I had problem that I can't get input only for particular window in win32 (for particular HWND) only for whole main window...so another computations were needed there

Trigve

Ocelot · Post by **Ocelot** » Thu Dec 21, 2006 7:06 pm

.so another computations were needed there

comparision only
eg.

Code: Select all

bool OISListeners::mouseMoved(const OIS::MouseEvent &evt){
    GtkAllocation rect = GTK_WIDGET(mApp->mOgre)->allocation;
    gint x(0),y(0);
    gtk_widget_get_pointer(GTK_WIDGET(mApp->mOgre), &x,&y);
    if ((x < 0)||(y<0)||(x>rect.width)||(y>rect.height)) return false;

Trigve · Post by **Trigve** » Thu Dec 21, 2006 9:42 pm

Ocelot wrote:

Code: Select all

bool OISListeners::mouseMoved(const OIS::MouseEvent &evt){
    GtkAllocation rect = GTK_WIDGET(mApp->mOgre)->allocation;
    gint x(0),y(0);
    gtk_widget_get_pointer(GTK_WIDGET(mApp->mOgre), &x,&y);
    if ((x < 0)||(y<0)||(x>rect.width)||(y>rect.height)) return false;

with gtkmm using only:

Code: Select all

bool MeshMapViewer::onNotify(GdkEventMotion* pMotion)
{
    // Do what you want
    return true;
}

And another problem is that I can't find OIS package in the FreeBSD ports (haven't tried to compile it from scratch).

Trigve

Post by **pjcast** » Thu Dec 21, 2006 10:03 pm

There is no current BSD port of OIS unfortunately. I setup a FreeBSD VM machine here to start working on one. However, I was unable to get autotools working the way I wanted. And since the BSD demand has been low, it has not been a priority

Really, what I would love, is someone fluent with BSD (and its joystick API) to sumit a patch.

Post by **DWORD** » Fri Feb 16, 2007 10:30 pm

Haven't really looked much at this lately, but I just wanted to let you know I've uploaded a new version, which should work with Eihort. You can grab it here: http://dword.dk/public/ogre/gtkogre-0.1.1-src.tar.bz2

The gtkmm stuff looks interesting.

A lot cleaner than that "object-oriented" C in GTK+.

marv · Post by **marv** » Sat Feb 24, 2007 1:27 pm

@Trigve: Is it possible to get a complete CB project of your gtkmm example(for windows). I´m trying to write a basic app with gtkmm and ogre (to stay object oriented), but need a working start point. Your example seems to be the perfect beginning. Thank you.