Package org.ngengine.components.jme3

Class AppComponentInitializer

java.lang.Object

org.ngengine.components.jme3.AppComponentInitializer

All Implemented Interfaces:

ComponentInitializer

public class AppComponentInitializer
extends Object
implements ComponentInitializer

Initializes components by connecting them to JME3 application resources.

Constructor Summary

Constructors

Constructor	Description
AppComponentInitializer(Application app)

Method Summary

Modifier and Type	Method	Description
boolean	canInitialize(ComponentManager mng, Component fragment)	Check if the component can be initialized by this initializer.
void	cleanup(ComponentManager mng, Component fragment)	Cleanup the component in the given component manager.
int	deprecatedInitialize(ComponentManager mng, Component fragment, Runnable markReady)	Deprecated, for removal: This API element is subject to removal in a future version.
int	initialize(ComponentManager mng, Component fragment, Runnable markReady)	Initialize the component in the given component manager.

Methods inherited from class java.lang.Object

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

Constructor Details

AppComponentInitializer

public AppComponentInitializer(Application app)

Method Details

deprecatedInitialize

@Deprecated(forRemoval=true)
public int deprecatedInitialize(ComponentManager mng,
 Component fragment,
 Runnable markReady)

Deprecated, for removal: This API element is subject to removal in a future version.

initialize

public int initialize(ComponentManager mng,
 Component fragment,
 Runnable markReady)

Description copied from interface: ComponentInitializer

Initialize the component in the given component manager. This method is called when the component is added to the component manager.

Specified by:

initialize in interface ComponentInitializer

Parameters:

mng - the component manager

fragment - the component to initialize

markReady - a runnable that should be called when the initialization is complete

Returns:

how many times the markReady callback is expected to be called to mark the complete initialization.

cleanup

public void cleanup(ComponentManager mng,
 Component fragment)

Description copied from interface: ComponentInitializer

Cleanup the component in the given component manager. This method is called when the component is removed from the component manager.

Specified by:

cleanup in interface ComponentInitializer

Parameters:

mng - the component manager

fragment - the component to cleanup

canInitialize

public boolean canInitialize(ComponentManager mng,
 Component fragment)

Description copied from interface: ComponentInitializer

Check if the component can be initialized by this initializer. This is used to determine if the component is compatible with this initializer and can be initialized without issues. If the component is not compatible, it will not be initialized and the component manager will call the next available initializer in the chain.

Specified by:

canInitialize in interface ComponentInitializer

Parameters:

mng - the component manager

fragment - the component to check

Returns:

true if the component can be initialized, false otherwise