hmi.elckerlyc.animationengine.controller
Class CompoundController

java.lang.Object
  hmi.xml.XMLStructureAdapter
      hmi.elckerlyc.animationengine.controller.CompoundController

All Implemented Interfaces:

PhysicalController, XMLStructure

public class CompoundController
extends XMLStructureAdapter
implements PhysicalController

A physical controller that is a compound of several other controllers. XML writing functionality is not implemented.

Author:

Dennis Reidsma

Field Summary

private Map<String,PhysicalController>	desiredControllers
private String[]	desJointIDs
private String[]	jointIDs
private PhysicalHumanoid	pHuman
private Map<String,PhysicalController>	requiredControllers
private static String	XMLTAG

Fields inherited from class hmi.xml.XMLStructureAdapter

ATTRIBUTE_TOKEN_DELIMITERS, COMMA_SEPARATOR, DECODEDARRAYSIZE, DEFAULT_RECOVER_MODE, NEWLINE, SYSTEMNEWLINE, TAB, TAB_STRING

Constructor Summary

CompoundController()

CompoundController(PhysicalHumanoid p)

Method Summary

void	addDesiredController(PhysicalController newController, String id)
void	addRequiredController(PhysicalController newController, String id)
PhysicalController	copy(PhysicalHumanoid ph) Creates a copy of the controller
void	decodeAttributes(HashMap<String,String> attrMap, XMLTokenizer tokenizer) decodes all attributes.
void	decodeContent(XMLTokenizer tokenizer) decodes the XML contents, i.e. the XML between the STag and ETag of the encoding.
String[]	getDesiredJointIDs() Gets the ids of joints the controller would like to steer if available
String	getParameterValue(String name) Get the parameter value of parameter name, return null if not found
String[]	getRequiredJointIDs() Gets the ids of controlled joints
String	getXMLTag() The XML Stag for XML encoding -- use this method to find out the run-time xml tag of an object
void	reset() Clears out all previous time dependen variables
void	setParameterValue(String name, float value)
void	setParameterValue(String name, String value)
void	setPhysicalHumanoid(PhysicalHumanoid p) Links the controller to a new set of physical joints
void	update(double timeDiff) Updates the controller
static String	xmlTag() The XML Stag for XML encoding -- use this static method when you want to see if a given String equals the xml tag for this class

Methods inherited from class hmi.xml.XMLStructureAdapter

appendAttribute, appendAttribute, appendAttribute, appendAttribute, appendAttribute, appendAttribute, appendAttribute, appendAttribute, appendAttribute, appendAttribute, appendAttribute, appendAttribute, appendAttribute, appendAttribute, appendAttribute, appendAttribute, appendAttribute, appendAttribute, appendAttribute, appendAttribute, appendAttribute, appendAttribute, appendAttribute, appendAttribute, appendAttribute, appendAttribute, appendAttribute, appendAttribute, appendAttribute, appendAttribute, appendAttributes, appendAttributes, appendAttributeString, appendAttributeString, appendBooleans, appendCloseEmptyTag, appendCloseSTag, appendComment, appendContent, appendContent, appendDoubleElement, appendEmptyTag, appendEmptyTag, appendEmptyTag, appendEmptyTag, appendEmptyTag, appendEmptyTag, appendETag, appendETag, appendFloatArrayElement, appendFloatElement, appendFloats, appendIntArrayElement, appendIntElement, appendInts, appendLongElement, appendNewLine, appendNewLine, appendNewLine, appendOpenSTag, appendOptionalDoubleElement, appendOptionalFloatElement, appendOptionalIntElement, appendOptionalLongElement, appendSpaces, appendSpaces, appendSTag, appendSTag, appendSTag, appendStringArrayElement, appendStrings, appendSystemNewLine, appendTab, appendTextElement, appendXML, appendXML, appendXML, appendXML, appendXML, appendXMLStructure, appendXMLStructureList, appendXMLTextElementList, countTokens, countTokens, decodeAttribute, decodeAttribute, decodeBoolean, decodeBooleanArray, decodeBooleanArray, decodeBooleanArray, decodeBooleanArray, decodeDouble, decodeDoubleArray, decodeDoubleArray, decodeDoubleArray, decodeDoubleArray, decodeFloat, decodeFloatArray, decodeFloatArray, decodeFloatArray, decodeFloatArray, decodeInt, decodeIntArray, decodeIntArray, decodeIntArray, decodeIntArray, decodeLong, decodeStringArray, decodeStringArray, decodeStringArray, decodeStringArray, decodeXMLStructureList, decodeXMLValueElement, getNamespace, getOptionalAttribute, getOptionalAttribute, getOptionalBooleanAttribute, getOptionalDoubleAttribute, getOptionalFloatAttribute, getOptionalIntAttribute, getOptionalLongAttribute, getRequiredAttribute, getRequiredBooleanAttribute, getRequiredDoubleAttribute, getRequiredFloatAttribute, getRequiredIntAttribute, getRequiredLongAttribute, getTagLine, hasContent, parseXMLElement, postProcess, preProcess, readXML, readXML, readXML, setConsoleAttributeEnabled, setDefaultRecoverMode, setRecoverMode, spaces, toString, toXMLString, toXMLString, toXMLString, toXMLString, toXMLString, toXMLString, writeXML, writeXML, writeXML, writeXML

Methods inherited from class java.lang.Object

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

Field Detail

requiredControllers

private Map<String,PhysicalController> requiredControllers

desiredControllers

private Map<String,PhysicalController> desiredControllers

jointIDs

private String[] jointIDs

desJointIDs

private String[] desJointIDs

pHuman

private PhysicalHumanoid pHuman

XMLTAG

private static final String XMLTAG

See Also:

Constant Field Values

Constructor Detail

CompoundController

public CompoundController()

CompoundController

public CompoundController(PhysicalHumanoid p)

Method Detail

reset

public void reset()

Description copied from interface: PhysicalController

Clears out all previous time dependen variables

Specified by:

reset in interface PhysicalController

setPhysicalHumanoid

public void setPhysicalHumanoid(PhysicalHumanoid p)

Description copied from interface: PhysicalController

Links the controller to a new set of physical joints

Specified by:

setPhysicalHumanoid in interface PhysicalController

Parameters:

p - physical humanoid to link to

getRequiredJointIDs

public String[] getRequiredJointIDs()

Description copied from interface: PhysicalController

Gets the ids of controlled joints

Specified by:

getRequiredJointIDs in interface PhysicalController

getDesiredJointIDs

public String[] getDesiredJointIDs()

Description copied from interface: PhysicalController

Gets the ids of joints the controller would like to steer if available

Specified by:

getDesiredJointIDs in interface PhysicalController

update

public void update(double timeDiff)

Description copied from interface: PhysicalController

Updates the controller

Specified by:

update in interface PhysicalController

Parameters:

timeDiff - time since last update

copy

public PhysicalController copy(PhysicalHumanoid ph)

Description copied from interface: PhysicalController

Creates a copy of the controller

Specified by:

copy in interface PhysicalController

addRequiredController

public void addRequiredController(PhysicalController newController,
                                  String id)

addDesiredController

public void addDesiredController(PhysicalController newController,
                                 String id)

getParameterValue

public String getParameterValue(String name)

Description copied from interface: PhysicalController

Get the parameter value of parameter name, return null if not found

Specified by:

getParameterValue in interface PhysicalController

setParameterValue

public void setParameterValue(String name,
                              String value)

Specified by:

setParameterValue in interface PhysicalController

setParameterValue

public void setParameterValue(String name,
                              float value)

Specified by:

setParameterValue in interface PhysicalController

decodeAttributes

public void decodeAttributes(HashMap<String,String> attrMap,
                             XMLTokenizer tokenizer)

Description copied from class: XMLStructureAdapter

decodes all attributes. The default implementation calls decodeAttribute for every attribute in turn. The decodeAttributes method can be reimplemented when attributes must be processed in some particular order.

Overrides:

decodeAttributes in class XMLStructureAdapter

decodeContent

public void decodeContent(XMLTokenizer tokenizer)
                   throws IOException

Description copied from class: XMLStructureAdapter

decodes the XML contents, i.e. the XML between the STag and ETag of the encoding. MUST BE OVERWRITTEN BY IMPLEMENTATIONS.

Overrides:

decodeContent in class XMLStructureAdapter

Throws:

IOException

xmlTag

public static String xmlTag()

The XML Stag for XML encoding -- use this static method when you want to see if a given String equals the xml tag for this class

getXMLTag

public String getXMLTag()

The XML Stag for XML encoding -- use this method to find out the run-time xml tag of an object

Specified by:

getXMLTag in interface XMLStructure

Overrides:

getXMLTag in class XMLStructureAdapter