msim.serialization

Class J3DLoader

java.lang.Object

msim.serialization.J3DLoader

@ThreadSafe
public class J3DLoader
extends java.lang.Object

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

Among other uses, this provides a bridge from the Java3D loaders to the MSim model.

Copyright (C) 2008 Marsette A. Vona, III

Author:

Marsette A. Vona, III

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	cvsid
static java.lang.String	WP_J3D_PATH Widget property containing the corresponding Java3D path, for Widgets generated in loadFromJ3D(Link, Node, boolean, int, boolean).

Constructor Summary

Constructors

Constructor and Description
J3DLoader()

Method Summary

Methods

Modifier and Type	Method and Description
protected static void	loadChildrenFromJ3D(Link linkageRoot, javax.media.j3d.Group j3dGroup, boolean loadBodyShapes, int j3dFormatMask, boolean mergeUnnamed, java.lang.StringBuffer j3dPath, vona.math.RX mergeCMT, char type) Helper for loadFromJ3D(Link, Node, boolean, int, boolean, StringBuffer, RX) that loads correspondents to the children of j3dGroup to linkageRoot.
static Link	loadFromJ3D(Link linkageRoot, javax.media.j3d.Node j3dRoot) Covers loadFromJ3D(Link, Node, boolean, int, boolean), always loads body shapes with all vertex components and does not merge unnamed transforms.
static Link	loadFromJ3D(Link linkageRoot, javax.media.j3d.Node j3dRoot, boolean loadBodyShapes, int j3dFormatMask, boolean mergeUnnamed) Load a Linkage sub-tree from a Java3D scene graph.
protected static void	loadFromJ3D(Link linkageRoot, javax.media.j3d.Node j3dRoot, boolean loadBodyShapes, int j3dFormatMask, boolean mergeUnnamed, java.lang.StringBuffer j3dPath, vona.math.RX mergeCMT) Impl of loadFromJ3D(Link, Node, boolean, int, boolean).
static Link	loadFromJ3D(Link linkageRoot, com.sun.j3d.loaders.Scene j3dScene) Covers loadFromJ3D(Link, Node, boolean, int, boolean), loads from the scene group, always loads body shapes with all vertex components and does not merge unnamed transforms.
static Link	loadFromJ3D(Link linkageRoot, com.sun.j3d.loaders.Scene j3dScene, boolean loadBodyShapes, int j3dFormatMask, boolean mergeUnnamed) Covers loadFromJ3D(Link, Node, boolean, int, boolean), loads from the scene group.
static Link	loadFromJ3D(javax.media.j3d.Node j3dRoot) Covers loadFromJ3D(Link, Node, boolean, int, boolean), always loads body shapes with all vertex components, does not merge unnamed transforms, and makes a new linkageRoot.
static Link	loadFromJ3D(com.sun.j3d.loaders.Scene j3dScene) Covers loadFromJ3D(Link, Node, boolean, int, boolean), loads from the scene group, always loads body shapes with all vertex components, does not merge unnamed transforms, and makes a new linkageRoot.

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

WP_J3D_PATH

public static final java.lang.String WP_J3D_PATH

Widget property containing the corresponding Java3D path, for Widgets generated in loadFromJ3D(Link, Node, boolean, int, boolean).

See Also:

Constant Field Values

Constructor Detail

J3DLoader

public J3DLoader()

Method Detail

loadFromJ3D

public static Link loadFromJ3D(Link linkageRoot,
               javax.media.j3d.Node j3dRoot,
               boolean loadBodyShapes,
               int j3dFormatMask,
               boolean mergeUnnamed)

Load a Linkage sub-tree from a Java3D scene graph.

The Java3D scene graph is traversed as a tree starting at j3dRoot, with the SharedGroup of any encountered Java3D Link nodes instantiated in-place. For each TransformGroup g with a rigid transform t (except in the case that j3dRoot itself is a TransformGroup, see below), a new Joint.Type.GENERAL Joint j is added with identity mobility transform and mobility-to-parent transform set to t, and the childLink of j is set to a new Link.

The new sub-linkage is attached at the link linkageRoot such that linkageRoot and j3dRoot correspond. Thus, if j3dRoot is a Group then the correspondents to its children are directly attached to linkageRoot; this holds even in the case that j3dRoot is itself a TransformGroup.

Parameters:

linkageRoot - the attach point for the new sub-tree, or null to create a new root Link in the top-level Linkage

j3dRoot - the root of the Java3D scene graph from which to load the sub-linkage, not null

loadBodyShapes - whether to assign Shape3D nodes as Link user Widgets, if not they are ignored

j3dFormatMask - see JOGLGeometry.extract(GeometryArray, int, PrintStream)

mergeUnnamed - whether to create Joints only for TransformGroups that have non-empty names

Returns:

linkageRoot, which may be freshly consed if it was passed as null

Throws:

CapabilityNotSetException - if the appropriate capabilities are not set and j3dRoot or any of its descendants is part of live or compiled scene graph

loadFromJ3D

public static Link loadFromJ3D(Link linkageRoot,
               javax.media.j3d.Node j3dRoot)

Covers loadFromJ3D(Link, Node, boolean, int, boolean), always loads body shapes with all vertex components and does not merge unnamed transforms.

loadFromJ3D

public static Link loadFromJ3D(javax.media.j3d.Node j3dRoot)

Covers loadFromJ3D(Link, Node, boolean, int, boolean), always loads body shapes with all vertex components, does not merge unnamed transforms, and makes a new linkageRoot.

loadFromJ3D

public static Link loadFromJ3D(Link linkageRoot,
               com.sun.j3d.loaders.Scene j3dScene,
               boolean loadBodyShapes,
               int j3dFormatMask,
               boolean mergeUnnamed)

Covers loadFromJ3D(Link, Node, boolean, int, boolean), loads from the scene group.

loadFromJ3D

public static Link loadFromJ3D(Link linkageRoot,
               com.sun.j3d.loaders.Scene j3dScene)

Covers loadFromJ3D(Link, Node, boolean, int, boolean), loads from the scene group, always loads body shapes with all vertex components and does not merge unnamed transforms.

loadFromJ3D

public static Link loadFromJ3D(com.sun.j3d.loaders.Scene j3dScene)

Covers loadFromJ3D(Link, Node, boolean, int, boolean), loads from the scene group, always loads body shapes with all vertex components, does not merge unnamed transforms, and makes a new linkageRoot.

loadFromJ3D

protected static void loadFromJ3D(Link linkageRoot,
               javax.media.j3d.Node j3dRoot,
               boolean loadBodyShapes,
               int j3dFormatMask,
               boolean mergeUnnamed,
               java.lang.StringBuffer j3dPath,
               vona.math.RX mergeCMT)

Impl of loadFromJ3D(Link, Node, boolean, int, boolean).

Keeps track of the current tree path under j3dRoot so that informative warnings can be emitted when issues like ignored node types or non-rigid transforms are encountered.

Parameters:

j3dPath - a string describing the current tree path under j3dRoot, for the top-level call this should have length 1. For each recursive call two elements are appended: a character describing the type of the parent node and, if appliccable, an int giving the child index

mergeCMT - if children are transformed by this when they are attached, used for mergeUnnamed

loadChildrenFromJ3D

protected static void loadChildrenFromJ3D(Link linkageRoot,
                       javax.media.j3d.Group j3dGroup,
                       boolean loadBodyShapes,
                       int j3dFormatMask,
                       boolean mergeUnnamed,
                       java.lang.StringBuffer j3dPath,
                       vona.math.RX mergeCMT,
                       char type)

Helper for loadFromJ3D(Link, Node, boolean, int, boolean, StringBuffer, RX) that loads correspondents to the children of j3dGroup to linkageRoot.