com.wikitude.common.plugins

Class Plugin

java.lang.Object

com.wikitude.common.plugins.Plugin

Deprecated.

@Deprecated
public abstract class Plugin
extends Object

Constructor Summary

Constructors

Constructor and Description
Plugin(String identifier) Deprecated.

Method Summary

Modifier and Type	Method and Description
abstract void	cameraFrameAvailable(Frame cameraFrame) Deprecated.
protected void	destroy() Deprecated.
protected void	endRender() Deprecated.
String	getIdentifier() Deprecated.
protected void	initialize() Deprecated.
boolean	isEnabled() Deprecated.
protected void	pause() Deprecated.
protected void	resume(long pausedTime) Deprecated.
void	setEnabled(boolean enabled) Deprecated.
protected void	startRender() Deprecated.
abstract void	update(RecognizedTarget[] recognizedTargets) Deprecated.

Methods inherited from class java.lang.Object

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

Constructor Detail

Plugin

@Deprecated
public Plugin(String identifier)

Deprecated.

Constructor, pass a unique identifier for each of your plugins.

Parameters:

identifier -

Method Detail

initialize

@Deprecated
protected void initialize()

Deprecated.

Will be called once after your Plugin was successfully added to the Wikitude Engine. Initialize your plugin here.

pause

@Deprecated
protected void pause()

Deprecated.

Will be called every time the Wikitude Engine pauses.

resume

@Deprecated
protected void resume(long pausedTime)

Deprecated.

Will be called when the Wikitude Engine starts for the first time and after every pause.

Parameters:

pausedTime - the duration of the pause in milliseconds

destroy

@Deprecated
protected void destroy()

Deprecated.

Will be called when the Wikitude Engine shuts down.

startRender

@Deprecated
protected void startRender()

Deprecated.

Will be called before any Wikitude SDK internal rendering is done. Therefore any drawn objects are behind any Wikitude SDK object.

endRender

@Deprecated
protected void endRender()

Deprecated.

Will be called right after any Wikitude SDK internal rendering is done. Therefore any drawn objects are in front of any Wikitude SDK object.

cameraFrameAvailable

@Deprecated
public abstract void cameraFrameAvailable(Frame cameraFrame)

Deprecated.

Will be called every time the Wikitude Enigine receives a new camera frame from the platform camera.

Parameters:

cameraFrame - frame wrapper object which contains the frame data and some metadata about the frame

update

@Deprecated
public abstract void update(RecognizedTarget[] recognizedTargets)

Deprecated.

Will be called after every image recognition cycle.

Parameters:

recognizedTargets - list of recognized targets or null if no target was recognized

getIdentifier

@Deprecated
public String getIdentifier()

Deprecated.

Returns the identifier of this particular plugin.

Returns:

Identifier

isEnabled

@Deprecated
public boolean isEnabled()

Deprecated.

Return the enabled state of this particular plugin.

Returns:

Enabled state

setEnabled

@Deprecated
public void setEnabled(boolean enabled)

Deprecated.

Set's this plugin enabled or not. A enabled plugin receives cameraFrameAvailable, update, startRender and endRender calls.

Parameters:

enabled - true or false