espresso3d.engine
Class E3DEngine

java.lang.Object
  espresso3d.engine.base.E3DEngineItem
      espresso3d.engine.renderer.base.E3DRenderable
          espresso3d.engine.E3DEngine

public final class E3DEngine

extends E3DRenderable

Author:

espresso3d This is the main class for espresso3d. The engine does all of the work.

Field Summary

static boolean

IN_JAR This is always true except for debugging purposes during development.

Constructor Summary

E3DEngine()

Method Summary

void	addExternalRenderable(E3DRenderable renderableItem, int timeoutFrames) This adds an E3DRenderable item to the ExternalRenderable list.
void	addViewport(E3DViewport viewport) Add a new viewport to the list of viewports If the primarySoundViewport hasn't been set, it will automatically be set to this viewport.
void	addWorld(E3DWorld world) Add a world to the engines world list
void	changeScreenResolution(int width, int height, int bitsPerPixel, boolean fullscreen, java.lang.String windowTitle) change the screen resolution
void	checkInput()
E3DCollisionHandler	getCollisionHandler()
E3DViewport	getCurrentViewport() Returns the viewport the engine is currently rendering to.
E3DFeatureChecker	getFeatureChecker()
E3DFPSTimer	getFpsTimer() Returns the timer the engine uses to get its FPS.
E3DGeometryRenderer	getGeometryRenderer()
E3DInputHandler	getInputHandler()
E3DEngineLogger	getLogger()
E3DViewport	getPrimarySoundViewport()
E3DSoundHandler	getSoundHandler()
E3DTexture	getTexture(java.lang.String textureName) Return the E3DTexture that is loaded in a textureSet and named textureName
int	getTextureIDByName(java.lang.String textureName) Get the glTextureID of the texture if its in the texture map
java.util.HashMap	getTextureSet() Builds a textureSet out of all the texture sets in all the worlds If two worlds have the same entry name, the E3DTexture used for the last checked world is used.
E3DViewport	getViewport(java.lang.String viewportID)
int	getWindowHeight()
java.lang.String	getWindowTitle()
int	getWindowWidth()
java.lang.String	getWorkingDirectory() Gets the current working directory WITHOUT trailing slashes
E3DWorld	getWorld(java.lang.String worldID) Get a world from the map of worlds by its ID
java.util.HashMap	getWorldMap()
void	initEngine(int width, int height, int bitsPerPixel, boolean fullscreen, java.lang.String windowTitle) Create window and initialize OpenGL
boolean	isBackfaceCullingEnabled()
boolean	isDebugNormalsRendered()
boolean	isRunning()
void	removeAllViewports() Remove all viewports from the engine
void	removeAllWorlds() Remove all the worlds in the engine.
void	removeExternalRenderable(E3DRenderable renderableItem)
void	removeViewport(java.lang.String viewportID) Remove a viewport with viewportID from the engine If removing a viewport that is set to the primarySoundViewport, the primarySoundViewport will automatically be set to the first viewport in the viewportMap.
void	removeWorld(java.lang.String worldID) Remove a world from the engine's world list
void	render()
void	setBackfaceCullingEnabled(boolean backfaceCullingEnabled)
void	setDebugNormalsRendered(boolean renderNormals)
void	setDisplayingFPS(boolean displayingFPS) Set whether the engine should display the FPS time or not.
void	setInputHandler(E3DInputHandler inputHandler)
void	setPrimarySoundViewport(E3DViewport viewport) A primary viewport for sound must be set.
void	setRunning(boolean running)
void	setWindowTitle(java.lang.String windowTitle)

Methods inherited from class espresso3d.engine.renderer.base.E3DRenderable

getBlendMode, getKey, getRenderMode, initCorrectGeometryRenderer, isKeyChanged, setBlendMode, setKeyChanged, setRenderMode

Methods inherited from class espresso3d.engine.base.E3DEngineItem

getEngine, setEngine

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

IN_JAR

public static final boolean IN_JAR

This is always true except for debugging purposes during development.

See Also:

Constant Field Values

Constructor Detail

E3DEngine

public E3DEngine()

Method Detail

getTextureSet

public java.util.HashMap getTextureSet()

Builds a textureSet out of all the texture sets in all the worlds If two worlds have the same entry name, the E3DTexture used for the last checked world is used.

Returns:

getTextureIDByName

public int getTextureIDByName(java.lang.String textureName)

Get the glTextureID of the texture if its in the texture map

Parameters:

textureName -

Returns:

the glID of the texture or -1 if it hasn't been loaded yet

getTexture

public E3DTexture getTexture(java.lang.String textureName)

Return the E3DTexture that is loaded in a textureSet and named textureName

Parameters:

textureName - The name of the texture in the textureMap

Returns:

the E3DTexture if loaded, otherwise null

getWorkingDirectory

public java.lang.String getWorkingDirectory()

Gets the current working directory WITHOUT trailing slashes

Returns:

initEngine

public void initEngine(int width,
                       int height,
                       int bitsPerPixel,
                       boolean fullscreen,
                       java.lang.String windowTitle)
                throws java.lang.Exception

Create window and initialize OpenGL

Throws:

java.lang.Exception

changeScreenResolution

public void changeScreenResolution(int width,
                                   int height,
                                   int bitsPerPixel,
                                   boolean fullscreen,
                                   java.lang.String windowTitle)

change the screen resolution

addWorld

public void addWorld(E3DWorld world)

Add a world to the engines world list

removeWorld

public void removeWorld(java.lang.String worldID)

Remove a world from the engine's world list

Returns:

removeAllWorlds

public void removeAllWorlds()

Remove all the worlds in the engine.

getWorld

public E3DWorld getWorld(java.lang.String worldID)

Get a world from the map of worlds by its ID

Parameters:

worldID -

Returns:

getWorldMap

public java.util.HashMap getWorldMap()

Returns:

Returns the worldMap.

render

public void render()

Specified by:

render in class E3DRenderable

checkInput

public void checkInput()
                throws E3DMissingInputHandlerException

Throws:

E3DMissingInputHandlerException

setInputHandler

public void setInputHandler(E3DInputHandler inputHandler)

Parameters:

inputHandler - The inputHandler to set.

getInputHandler

public E3DInputHandler getInputHandler()

Returns:

Returns the inputHandler.

isRunning

public boolean isRunning()

Returns:

Returns whether the engine is running

setRunning

public void setRunning(boolean running)

Parameters:

running - Set the engines running state

getCollisionHandler

public E3DCollisionHandler getCollisionHandler()

Returns:

Returns the engine's used for determining collisions

isDebugNormalsRendered

public boolean isDebugNormalsRendered()

Returns:

This is a debug flag that when set to true, the normals of the world and objects will be rendered.

setDebugNormalsRendered

public void setDebugNormalsRendered(boolean renderNormals)

addExternalRenderable

public void addExternalRenderable(E3DRenderable renderableItem,
                                  int timeoutFrames)

This adds an E3DRenderable item to the ExternalRenderable list. All E3DRenderables in this list will be rendered after the main rendering hierarchy is rendered (world, actors, particles, etc) but before any 2D static images or text (so the text/images will be on top of external renderables) Each item on the list will be rendered for the # of frames passed in This is very useful for debugging (adding CMLines to the rendering loop to see direction vectors and things) It could even potentially be used to plug in your rendering algorithm. as timeoutFrames

Parameters:

renderableItem - An E3DRenderable item that you want to render outside of the optimized rendering loop.

timeoutFrames - How many frames to render this renderable for

removeExternalRenderable

public void removeExternalRenderable(E3DRenderable renderableItem)

setDisplayingFPS

public void setDisplayingFPS(boolean displayingFPS)

Set whether the engine should display the FPS time or not. Currently it shows the FPS in the window's title.

Parameters:

displayingFPS -

getWindowTitle

public java.lang.String getWindowTitle()

Returns:

Returns the windowTitle.

setWindowTitle

public void setWindowTitle(java.lang.String windowTitle)

Parameters:

windowTitle - The windowTitle to set.

getViewport

public E3DViewport getViewport(java.lang.String viewportID)

addViewport

public void addViewport(E3DViewport viewport)

Add a new viewport to the list of viewports If the primarySoundViewport hasn't been set, it will automatically be set to this viewport.

Parameters:

viewport -

setPrimarySoundViewport

public void setPrimarySoundViewport(E3DViewport viewport)

A primary viewport for sound must be set. The cameraActor in the viewport this is set to will be used as the listener for the sound. This automatically sets up the soundHandler's listener. The viewport's camera actor must NOT be null at this point.

Parameters:

viewport -

removeViewport

public void removeViewport(java.lang.String viewportID)

Remove a viewport with viewportID from the engine If removing a viewport that is set to the primarySoundViewport, the primarySoundViewport will automatically be set to the first viewport in the viewportMap. If the map is empty after removing this viewport, the primarySoundViewport will be set to null.

Parameters:

viewportID -

removeAllViewports

public void removeAllViewports()

Remove all viewports from the engine

getWindowWidth

public int getWindowWidth()

Returns:

getWindowHeight

public int getWindowHeight()

Returns:

Returns the height.

getFpsTimer

public E3DFPSTimer getFpsTimer()

Returns the timer the engine uses to get its FPS.

Returns:

getCurrentViewport

public E3DViewport getCurrentViewport()

Returns the viewport the engine is currently rendering to. This cannot be set by the user, it is for informational purposes only

Returns:

isBackfaceCullingEnabled

public boolean isBackfaceCullingEnabled()

setBackfaceCullingEnabled

public void setBackfaceCullingEnabled(boolean backfaceCullingEnabled)

getSoundHandler

public E3DSoundHandler getSoundHandler()

getPrimarySoundViewport

public E3DViewport getPrimarySoundViewport()

getGeometryRenderer

public E3DGeometryRenderer getGeometryRenderer()

getLogger

public E3DEngineLogger getLogger()

getFeatureChecker

public E3DFeatureChecker getFeatureChecker()