org.cogchar.bind.rk.robot.client
Class RobotAnimClient

java.lang.Object
  org.appdapter.core.log.BasicDebugger
      org.cogchar.bind.rk.robot.client.RobotAnimClient

All Implemented Interfaces:

org.appdapter.core.log.Loggable

public class RobotAnimClient
extends org.appdapter.core.log.BasicDebugger

This class is able to invoke animations. It currently holds two separate implementations, one used when we have an AnimPlayer already, another when we want to search OSGi every time.

Author:

Stu B.

Nested Class Summary

static class

RobotAnimClient.BuiltinAnimKind

Field Summary

Fields inherited from class org.appdapter.core.log.BasicDebugger

myLogger

Fields inherited from interface org.appdapter.core.log.Loggable

IMPO_HI, IMPO_HIHI, IMPO_LO, IMPO_LOLO, IMPO_MAX, IMPO_MIN, IMPO_NORM

Constructor Summary

RobotAnimClient(org.robokind.api.animation.player.AnimationPlayer cachedPlayer)

RobotAnimClient(org.osgi.framework.BundleContext bundleCtx, String animationPlayerOsgiFilterString)

Method Summary

boolean	endAndClearAnimationJob(org.robokind.api.animation.player.AnimationJob aj)
List<org.robokind.api.animation.player.AnimationJob>	getAllCurrentAnimationsForPlayer(org.robokind.api.animation.player.AnimationPlayer ap)
org.robokind.api.animation.xml.AnimationFileReader	getAnimationReader()
org.robokind.api.animation.Animation	makeBuiltinAnim(RobotAnimClient.BuiltinAnimKind baKind, ModelRobot refBot)
boolean	markAnimationJobComplete(org.robokind.api.animation.player.AnimationJob aj)
org.robokind.api.animation.player.AnimationJob	playAnimationSegmentNow(org.robokind.api.animation.Animation anim, long segBeginOffsetMsec, long segEndOffsetMsec)
org.robokind.api.animation.player.AnimationJob	playFullAnimationNow(org.robokind.api.animation.Animation anim)
org.robokind.api.animation.Animation	readAnimationFromFile(String filepath)
org.robokind.api.animation.Animation	readAnimationFromHC(org.apache.commons.configuration.HierarchicalConfiguration hc)
org.robokind.api.animation.Animation	readAnimationFromURL(String urlText)
org.apache.commons.configuration.HierarchicalConfiguration	readXmlConfigFile(String xmlConfFilePath) http://commons.apache.org/configuration/apidocs/org/apache/commons/configuration/XMLConfiguration.html
org.apache.commons.configuration.HierarchicalConfiguration	readXmlConfigUrl(String xmlConfUrl)

Methods inherited from class org.appdapter.core.log.BasicDebugger

checkDebugImportance, forceLog4jConfig, getLogger, getLoggerForClass, isLoggerUsable, logDebug, logError, logError, logInfo, logInfo, logInfoEvent, logWarning, logWarning, logWithException, setDebugImportanceThreshold, setLogger, useLoggerForClass

Methods inherited from class java.lang.Object

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

Constructor Detail

RobotAnimClient

public RobotAnimClient(org.osgi.framework.BundleContext bundleCtx,
                       String animationPlayerOsgiFilterString)
                throws Exception

Throws:

Exception

RobotAnimClient

public RobotAnimClient(org.robokind.api.animation.player.AnimationPlayer cachedPlayer)

Method Detail

getAnimationReader

public org.robokind.api.animation.xml.AnimationFileReader getAnimationReader()

playAnimationSegmentNow

public org.robokind.api.animation.player.AnimationJob playAnimationSegmentNow(org.robokind.api.animation.Animation anim,
                                                                              long segBeginOffsetMsec,
                                                                              long segEndOffsetMsec)

playFullAnimationNow

public org.robokind.api.animation.player.AnimationJob playFullAnimationNow(org.robokind.api.animation.Animation anim)

markAnimationJobComplete

public boolean markAnimationJobComplete(org.robokind.api.animation.player.AnimationJob aj)

endAndClearAnimationJob

public boolean endAndClearAnimationJob(org.robokind.api.animation.player.AnimationJob aj)

getAllCurrentAnimationsForPlayer

public List<org.robokind.api.animation.player.AnimationJob> getAllCurrentAnimationsForPlayer(org.robokind.api.animation.player.AnimationPlayer ap)

readAnimationFromFile

public org.robokind.api.animation.Animation readAnimationFromFile(String filepath)

readAnimationFromHC

public org.robokind.api.animation.Animation readAnimationFromHC(org.apache.commons.configuration.HierarchicalConfiguration hc)

readAnimationFromURL

public org.robokind.api.animation.Animation readAnimationFromURL(String urlText)

readXmlConfigFile

public org.apache.commons.configuration.HierarchicalConfiguration readXmlConfigFile(String xmlConfFilePath)

http://commons.apache.org/configuration/apidocs/org/apache/commons/configuration/XMLConfiguration.html

Parameters:

xmlConfFilePath -

Returns:

readXmlConfigUrl

public org.apache.commons.configuration.HierarchicalConfiguration readXmlConfigUrl(String xmlConfUrl)

makeBuiltinAnim

public org.robokind.api.animation.Animation makeBuiltinAnim(RobotAnimClient.BuiltinAnimKind baKind,
                                                            ModelRobot refBot)
                                                     throws Exception

Throws:

Exception