XMT-O Reference Software

xmto2xmta.tree
Class material

java.lang.Object
  |
  +--xmto2xmta.tree.TreeElement
        |
        +--xmto2xmta.tree.ConvertElement
              |
              +--xmto2xmta.tree.XmediaChildrenElement
                    |
                    +--xmto2xmta.tree.XmediaChildrenDefsElement
                          |
                          +--xmto2xmta.tree.material
All Implemented Interfaces:
Animatable, DefsObject

public class material
extends XmediaChildrenDefsElement
implements Animatable

Class to handle the conversion of the material element.

History:


Field Summary
private  java.lang.String[] animXmtaAttrFieldDefaultValue_
           
private  int[] animXmtaAttrFieldType_
           
private  java.lang.String[] animXmtaAttrName_
           
private  int[] animXmtoAttrFieldType_
           
private  java.lang.String[] animXmtoAttrName_
           
private static boolean debug_
          Whether debug information is to be printed to the console.
private  java.lang.String xmtaAttrEmissiveColor_
           
private  java.util.Hashtable xmtaMaterial2dIds_
           
private  java.util.ResourceBundle xmto2XmtaRes_
           
private  java.lang.String xmtoAttrColor_
           
private  java.lang.String xmtoAttrFilled_
           
private  java.lang.String xmtoAttrTransparency_
           
 
Fields inherited from class xmto2xmta.tree.XmediaChildrenDefsElement
isDefsParent_, isInDefsTree_, isInDefsTreeInitialized_, xmtaDefsId_
 
Fields inherited from class xmto2xmta.tree.ConvertElement
convertIndexTable_, index_, xmtaDoc_, xmtaIds_, xmtaParNodes_, xmtaParOds_, xmtaParRoutes_, xmto2Xmta_, xmtoAttrId_, xmtoElement_, xmtoIds_
 
Fields inherited from class xmto2xmta.tree.TreeElement
children, parent_
 
Fields inherited from interface xmto2xmta.tree.Animatable
TYPE_MFBool, TYPE_MFColor, TYPE_MFFloat, TYPE_MFInt32, TYPE_MFString, TYPE_MFVec2f, TYPE_SFBool, TYPE_SFColor, TYPE_SFFloat, TYPE_SFInt32, TYPE_SFString, TYPE_SFVec2f, TYPE_UNSUPPORTED
 
Constructor Summary
material(org.w3c.dom.Element xmtoElement, java.util.Hashtable xmtoIds, java.util.Hashtable xmtaIds, java.util.Hashtable convertIndexTable, org.w3c.dom.Document xmtaDoc, Xmto2Xmta xmto2Xmta)
          constructor.
 
Method Summary
 java.lang.String getAnimConvertValueXmto2Xmta(java.lang.String xmtoAttrName, java.lang.String xmtoValue, int xmtoFieldType, int xmtaFieldType)
          This function converts a xmto attribute value to its xmta equivalent.
 int getAnimXmtaAttrFieldType(java.lang.String xmtoAttrName)
          This function returns the MPEG-4 field type being animated.
 java.lang.String getAnimXmtaAttrInitialValue(java.lang.String xmtoAttrName)
          This function returns the initial value of the field begin animated.
 java.lang.String getAnimXmtaAttrName(java.lang.String xmtoAttrName)
          This function returns the MPEG-4 field being animated.
 java.lang.String getAnimXmtaDefsNodeId(java.lang.String xmtoAttrName)
          This function returns the MPEG-4 node whose field is being animated.
 java.lang.String getAnimXmtaNodeId(java.lang.String xmtoAttrName, ELASid elasId)
          This function returns the MPEG-4 node whose field is being animated.
 int getAnimXmtoAttrFieldType(java.lang.String xmtoAttrName)
          This function returns the MPEG-4 field type being animated.
 java.lang.String getXmtaAttrEmissiveColor()
           
protected  java.lang.String getXmtaDefsId(ELASid elasId)
          Get the defs id of the object.
 java.lang.String getXmtaMaterial2dId(ELASid elasId)
          get the id for the Material2d element.
 java.lang.String getXmtoAttrFilled()
           
 java.lang.String getXmtoAttrTransparency()
           
protected  boolean handleValidateSyntax(java.lang.String attributeName, java.lang.String attributeValue)
          Handle the attribute by checking its syntax.
static void setDebug(boolean debug)
          Enable debugging information to be printed to the console.
 java.lang.String toString()
           
 
Methods inherited from class xmto2xmta.tree.XmediaChildrenDefsElement
getXmtaDefsId, initDefsFlags, isDefsParent, isInDefsTree
 
Methods inherited from class xmto2xmta.tree.ConvertElement
addToParNode, addToParOd, addToParRoutes, createChildren, fireErrorEvent, fireErrorEvent, fireErrorEvent, getConvertIndexTable, getIndex, getXmtaDoc, getXmtaIds, getXmto2Xmta, getXmtoAttrId, getXmtoElement, getXmtoIds, insertIntoXmtaTree, remove, validateSyntax
 
Methods inherited from class xmto2xmta.tree.TreeElement
addChild, getChildren, getParent, removeChild, setParent
 
Methods inherited from class java.lang.Object
, clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, wait, wait, wait
 

Field Detail

debug_

private static boolean debug_
Whether debug information is to be printed to the console. default is not have debug information printed (false).

xmtoAttrColor_

private java.lang.String xmtoAttrColor_

xmtoAttrFilled_

private java.lang.String xmtoAttrFilled_

xmtoAttrTransparency_

private java.lang.String xmtoAttrTransparency_

xmtaAttrEmissiveColor_

private java.lang.String xmtaAttrEmissiveColor_

xmtaMaterial2dIds_

private java.util.Hashtable xmtaMaterial2dIds_

animXmtoAttrName_

private java.lang.String[] animXmtoAttrName_

animXmtoAttrFieldType_

private int[] animXmtoAttrFieldType_

animXmtaAttrName_

private java.lang.String[] animXmtaAttrName_

animXmtaAttrFieldType_

private int[] animXmtaAttrFieldType_

animXmtaAttrFieldDefaultValue_

private java.lang.String[] animXmtaAttrFieldDefaultValue_

xmto2XmtaRes_

private java.util.ResourceBundle xmto2XmtaRes_
Constructor Detail

material

public material(org.w3c.dom.Element xmtoElement,
                java.util.Hashtable xmtoIds,
                java.util.Hashtable xmtaIds,
                java.util.Hashtable convertIndexTable,
                org.w3c.dom.Document xmtaDoc,
                Xmto2Xmta xmto2Xmta)
constructor.
Parameters:
xmtoElement - XMT-O element for conversion.
xmtoIds - hashtable to contain XMT-O Conversion elements with the key of their XMT-O id.
xmtaIds - hashtable to contain XMT-A elements with the key of their XMT-A id.
xmtaDoc - DOM Document for the new XMT-A elements.
xmto2Xmta - Converter, used for firing error events.
Method Detail

getAnimConvertValueXmto2Xmta

public java.lang.String getAnimConvertValueXmto2Xmta(java.lang.String xmtoAttrName,
                                                     java.lang.String xmtoValue,
                                                     int xmtoFieldType,
                                                     int xmtaFieldType)
This function converts a xmto attribute value to its xmta equivalent. It then returns the converted value.
Specified by:
getAnimConvertValueXmto2Xmta in interface Animatable

getAnimXmtaAttrFieldType

public int getAnimXmtaAttrFieldType(java.lang.String xmtoAttrName)
This function returns the MPEG-4 field type being animated. e.g. SFVec2f, MFVec3f, SFColor, MFColor, ...
Specified by:
getAnimXmtaAttrFieldType in interface Animatable

getAnimXmtaAttrInitialValue

public java.lang.String getAnimXmtaAttrInitialValue(java.lang.String xmtoAttrName)
This function returns the initial value of the field begin animated. This is used in case the attribute is not specified in the animaiton. Generally this is the original value so that after the animation is finished the node field can be returned to its original state. If this value isn't specified then the default value will be used.
Specified by:
getAnimXmtaAttrInitialValue in interface Animatable

getAnimXmtaAttrName

public java.lang.String getAnimXmtaAttrName(java.lang.String xmtoAttrName)
This function returns the MPEG-4 field being animated.
Specified by:
getAnimXmtaAttrName in interface Animatable

getAnimXmtaDefsNodeId

public java.lang.String getAnimXmtaDefsNodeId(java.lang.String xmtoAttrName)
This function returns the MPEG-4 node whose field is being animated. This method is for when there is no elasId for this instantiation of the object. This can occur for xMediaChildrenObject that are defs objects, but the parent isn't a TimingElement.
Specified by:
getAnimXmtaDefsNodeId in interface Animatable

getAnimXmtaNodeId

public java.lang.String getAnimXmtaNodeId(java.lang.String xmtoAttrName,
                                          ELASid elasId)
This function returns the MPEG-4 node whose field is being animated.
Specified by:
getAnimXmtaNodeId in interface Animatable

getAnimXmtoAttrFieldType

public int getAnimXmtoAttrFieldType(java.lang.String xmtoAttrName)
This function returns the MPEG-4 field type being animated. e.g. SFVec2f, MFVec3f, SFColor, MFColor, ...
Specified by:
getAnimXmtoAttrFieldType in interface Animatable

getXmtaAttrEmissiveColor

public java.lang.String getXmtaAttrEmissiveColor()

getXmtaDefsId

protected java.lang.String getXmtaDefsId(ELASid elasId)
Get the defs id of the object.
Overrides:
getXmtaDefsId in class XmediaChildrenDefsElement
Returns:
the unique id of this object.

getXmtaMaterial2dId

public java.lang.String getXmtaMaterial2dId(ELASid elasId)
get the id for the Material2d element.

getXmtoAttrFilled

public java.lang.String getXmtoAttrFilled()

getXmtoAttrTransparency

public java.lang.String getXmtoAttrTransparency()

handleValidateSyntax

protected boolean handleValidateSyntax(java.lang.String attributeName,
                                       java.lang.String attributeValue)
Handle the attribute by checking its syntax. This is to catch all syntax errors which the schema can not check for, and thus the DOM parser doesn't find any problems. Call the parent handler to see if it can handle the attribute or not.
Overrides:
handleValidateSyntax in class ConvertElement
Parameters:
attributeName - node name of attribute.
attributeValue - node value of attribute.
Returns:
whether this attribute is handled or not.

setDebug

public static void setDebug(boolean debug)
Enable debugging information to be printed to the console.
Parameters:
debug - sets debug information is printed

toString

public java.lang.String toString()
Overrides:
toString in class TreeElement

XMT-O Reference Software