com.wikitude.architect.plugin

Class Plugin

java.lang.Object

com.wikitude.architect.plugin.Plugin

public abstract class Plugin
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Plugin(java.lang.String identifier, ArchitectView architectView) Constructor, pass a unique identifier for each of your plugins.

Method Summary

Modifier and Type	Method and Description
void	callJavaScript(java.lang.String javaScriptSnippet) Pass a java script snippet which will be executed in the current AR experience.
abstract void	cameraFrameAvailable(Frame cameraFrame) Will be called every time the Wikitude Enigine receives a new camera frame from the platform camera.
protected void	destroy() Will be called when the Wikitude Engine shuts down.
protected void	endRender() Will be called right after any Wikitude SDK internal rendering is done.
java.lang.String	getIdentifier() Returns the identifier of this particular plugin.
protected void	initialize() Will be called once after your Plugin was successfully added to the Wikitude Engine.
boolean	isEnabled() Return the enabled state of this particular plugin.
protected void	pause() Will be called every time the Wikitude Engine pauses.
protected void	resume(long pausedTime) Will be called when the Wikitude Engine starts for the first time and after every pause.
void	setEnabled(boolean enabled) Set's this plugin enabled or not.
protected void	startRender() Will be called before any Wikitude SDK internal rendering is done.
abstract void	update(RecognizedTarget[] recognizedTargets) Will be called after every image recognition cycle.

Methods inherited from class java.lang.Object

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

Constructor Detail

Plugin

public Plugin(java.lang.String identifier,
              ArchitectView architectView)

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

Parameters:

identifier -

Method Detail

initialize

protected void initialize()

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

pause

protected void pause()

Will be called every time the Wikitude Engine pauses.

resume

protected void resume(long pausedTime)

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

protected void destroy()

Will be called when the Wikitude Engine shuts down.

startRender

protected void startRender()

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

endRender

protected void endRender()

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

public abstract void cameraFrameAvailable(Frame cameraFrame)

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

public abstract void update(RecognizedTarget[] recognizedTargets)

Will be called after every image recognition cycle.

Parameters:

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

callJavaScript

public void callJavaScript(java.lang.String javaScriptSnippet)

Pass a java script snippet which will be executed in the current AR experience.

Parameters:

javaScriptSnippet - java script code

getIdentifier

public java.lang.String getIdentifier()

Returns the identifier of this particular plugin.

Returns:

Identifier

isEnabled

public boolean isEnabled()

Return the enabled state of this particular plugin.

Returns:

Enabled state

setEnabled

public void setEnabled(boolean enabled)

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

Parameters:

enabled - true or false