Plugin documentation

Hi, I really don’t know if this is the right place to ask about. If not, feel free to move it to the right place !

I wonder if there is some documentation for plugins. Maybe the question has been asked yet, but I’ve been able to search for it in the forum.
For example, I downloaded the “AI” plugin. I don’t know where to start for it. The plugins repository says “Homepage:”. But I cannot find any pointer there…
Previously, I used the “imagePainter” plugin. Without documentation, I gave up, since I found the marvelous AWTLoader instead…

Any advice on how to find information?

As always, in the wiki :wink:
Oh, you mean for the plugins themselves and not for creating them… Well either in the SDK manual (F1) or on the page linked in the plugin info but that is different on a plugin basis as not all are documented and not all developers added manual help entries.

Quote: pretend I quoted normen

I haven’t looked into this yet so I’m just curious… but do plugins include source and/or javadoc? Can the javadoc for a plugin generally be pulled up just like any other javadoc?

I generated Javadoc for ImagePainter and included it in the distribution (I thought). It is fully javadocced. Can someone who has the plugin installed test that for me please?

Yes, when you create that library entry you specify javadoc and source and it embeds in the SDK just like the core doc and sources (or any libs docs and sources really).

You can additionally put more documentation-like JavaHelp entries to your plugin in html form that will appear in the F1 manual.

Yesterday, I installed the AI plugin, but it comes with no documentation, no javadoc nor any source :(.

Today, I installed the latest version of ImagePainter, and it comes with full source and javadoc. That’s nice! The indicated site (homepage) suddenly disappeared from the plugins window… I uninstalled and re-installed, and the site link is back. And stays there.

Well ImagePainter doesn’t really have a home page or website, just the announcement thread on these forums. The fact that it includes full source and javadoc should mean that it doesn’t need one though I would hope.

That’s true; It’s quite easy to use, except when image rasters are to be used. Where do they come from? I can’t figure out yet. I think they are not AWT image rasters…

No, ImageRaster is a jME3 feature:

So that’s only to paint JME images over JME images?
I thought there was a way to paint a AWT image over a JME image… But there is still AWTLoader ;-).
Thanks for the advice,

AWT Images aren’t portable, in particular android does not support them.

jme3 images can load all the common formats (png, jpg, etc) and then use them to draw into each other etc.

Unless you need specific draw calls that aren’t supported, or you are using an external library, then there is no real need to use BufferedImage, etc.

There is a plan to write an implementation of ImageRaster on top of BufferedImage which would then allow ImagePainter to use them transparently. No-one has had the need for that functionality though so the wrapper has not been written…it should be a simple job though.

Ok, I didn’t know about the Android stuff. I’ve never looked into it yet.

In my current application, I screenshot a viewport to paste it in a BufferedImage (some kind of mosaic). The BufferedImage is then converted to JME image for display.
Do you think ti would be possible within JME ?

I would have thought you can do something with rendering the viewport to a jME3 Image, and then paste that rendered Image into the mosaic…

It’s not something I’ve tried myself though…

Yes, you’re right. I’ve seen somewhere rendering to a texture. So it must be doable. I will investigate.
Thanks for the advice.