msim.serialization

Class DAEExporter

java.lang.Object

msim.serialization.DAEExporter

public class DAEExporter
extends java.lang.Object

Facility to construct a COLLADA scenegraph from a Linkage sub-tree.

See also DAELoader, which gives full documentation of the MSim-COLLADA mapping.

Copyright (C) 2009 Marsette A. Vona, III

Author:

Marsette A. Vona, III

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	DAEExporter.LatentClosure record containing all needed info to export a closure joint
protected static class	DAEExporter.Libraries all needed COLLADA libraries

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	cvsid
protected static vona.dae.util.DAEUtils	daeUtils for now use the singleton DAEUtils
protected static javax.xml.datatype.DatatypeFactory	datatypeFactory XML datatype factory
protected static javax.xml.bind.Marshaller	marshaller marshaller for DAE MSim extras
protected static vona.dae.jaxb.dae.ObjectFactory	objFact DAE object factory

Constructor Summary

Constructors

Constructor and Description
DAEExporter()

Method Summary

Methods

Modifier and Type	Method and Description
protected static vona.dae.jaxb.dae.NodeType	exportLinkToDAE(Link link, boolean exportWidgets, boolean exportParentJoint, DAEExporter.Libraries lib, java.util.List<DAEExporter.LatentClosure> latentClosures) Export an MSim Link to a DAE "node".
static vona.dae.jaxb.dae.COLLADA	exportToDAE(Link linkageRoot) Covers exportToDAE(Link, boolean), exports widgets.
static vona.dae.jaxb.dae.COLLADA	exportToDAE(Link linkageRoot, boolean exportUserLinkWidgets) Export a Linkage sub-tree to a COLLADA visual scene graph.
protected static vona.dae.jaxb.dae.ExtraType	wrapExtra(DAEMSimExtra daeMSimExtra) Marshal an MSim DAE extra element into a DAE extra/technique with profile=MSim.

Methods inherited from class java.lang.Object

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

Field Detail

cvsid

private static final java.lang.String cvsid

See Also:

Constant Field Values

daeUtils

protected static final vona.dae.util.DAEUtils daeUtils

for now use the singleton DAEUtils

marshaller

protected static final javax.xml.bind.Marshaller marshaller

marshaller for DAE MSim extras

datatypeFactory

protected static final javax.xml.datatype.DatatypeFactory datatypeFactory

XML datatype factory

objFact

protected static final vona.dae.jaxb.dae.ObjectFactory objFact

DAE object factory

Constructor Detail

DAEExporter

public DAEExporter()

Method Detail

exportToDAE

public static vona.dae.jaxb.dae.COLLADA exportToDAE(Link linkageRoot,
                                    boolean exportUserLinkWidgets)

Export a Linkage sub-tree to a COLLADA visual scene graph.

The COLLADA scene graph could then be marshalled via a call to DAEUtils.marshalDAE(COLLADA, File).

Any encountered closure joints which attach outside the subtree rooted at linkageRoot are not exported (warnings will be issued).

The passed linkageRoot will correspond to a COLLADA node at the top of a visual scene graph tree. That node will in turn be the only child of a COLLADA visual_scene with an msim_skip extra that indicates the scene is replaced by the node.

Parameters:

exportUserLinkWidgets - whether to export user link widgets as COLLADA geometries

exportToDAE

public static vona.dae.jaxb.dae.COLLADA exportToDAE(Link linkageRoot)

Covers exportToDAE(Link, boolean), exports widgets.

exportLinkToDAE

protected static vona.dae.jaxb.dae.NodeType exportLinkToDAE(Link link,
                                         boolean exportWidgets,
                                         boolean exportParentJoint,
                                         DAEExporter.Libraries lib,
                                         java.util.List<DAEExporter.LatentClosure> latentClosures)

Export an MSim Link to a DAE "node".

Recurs on the connected tree child joints of link to export the entire subtree. All encountered closure joints are collected in latentClosures for later export, as they need to be checked to ensure that their children are within the export tree.

Parameters:

link - the link to export, not null

exportWidgets - whether to export user link widgets

exportParentJoint - whether to export the configuration of link's parent joint as a DAE msim extra node "msim_parent_joint", provided that link is not a root

lib - the DAE libraries into which various elements will be stored

latentClosures - the list of encountered closure joints

wrapExtra

protected static vona.dae.jaxb.dae.ExtraType wrapExtra(DAEMSimExtra daeMSimExtra)

Marshal an MSim DAE extra element into a DAE extra/technique with profile=MSim.