Package com.ardor3d.framework

Interface NativeCanvas

All Superinterfaces:
Canvas
All Known Implementing Classes:
JoglAwtWindow, JoglNewtWindow
public interface NativeCanvas extends Canvas

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    close()
    close shutdowns and destroys any window contexts.
    boolean
    isActive()
    isActive returns true if the display is active.
    boolean
    isClosing()
    isClosing notifies if the window is currently closing.
    void
    moveWindowTo(int locX, int locY)
    If running in windowed mode, move the window's position to the given display coordinates in window units.
    void
    setIcon(Image[] iconImages)
    Sets one or more icons for the Canvas.
    void
    setTitle(String title)
    Sets the title of the display system.
    void
    setVSyncEnabled(boolean enabled)
    setVSyncEnabled attempts to enable or disable monitor vertical synchronization.

    Methods inherited from interface com.ardor3d.framework.Canvas

    draw, getCanvasRenderer, getMouseManager, init, setMouseManager

  • Method Details

    • close

      void close()
      close shutdowns and destroys any window contexts.

    • isActive

      boolean isActive()
      isActive returns true if the display is active.
      Returns:
      whether the display system is active.

    • isClosing

      boolean isClosing()
      isClosing notifies if the window is currently closing. This could be caused via the application itself or external interrupts such as alt-f4 etc.
      Returns:
      true if the window is closing, false otherwise.

    • setVSyncEnabled

      void setVSyncEnabled(boolean enabled)
      setVSyncEnabled attempts to enable or disable monitor vertical synchronization. The method is a "best attempt" to change the monitor vertical refresh synchronization, and is not guaranteed to be successful. This is dependent on OS.
      Parameters:
      enabled - true to synchronize, false to ignore synchronization

    • setTitle

      void setTitle(String title)
      Sets the title of the display system. This is usually reflected by the renderer as text in the menu bar.
      Parameters:
      title - The new display title.

    • setIcon

      void setIcon(Image[] iconImages)
      Sets one or more icons for the Canvas. As a reference for usual platforms on number of icons and their sizes:
      • On Windows you should supply at least one 16x16 image and one 32x32.
      • Linux (and similar platforms) expect one 32x32 image.
      • Mac OS X should be supplied one 128x128 image.
      Images should be in format RGBA8888. If they are not ardor3d will try to convert them using ImageUtils. If that fails a Ardor3dException could be thrown.
      Parameters:
      iconImages - Array of Images to be used as icons.

    • moveWindowTo

      void moveWindowTo(int locX, int locY)
      If running in windowed mode, move the window's position to the given display coordinates in window units.
      Parameters:
      locX - the x value of the location
      locY - the y value of the location