Package com.jme3.scene.debug.custom

Class ArmatureDebugger

java.lang.Object

com.jme3.scene.Spatial

com.jme3.scene.Node

com.jme3.scene.debug.custom.ArmatureDebugger

All Implemented Interfaces:

HasLocalTransform, CloneableSmartAsset, Collidable, Savable, JmeCloneable, Cloneable

public class ArmatureDebugger
extends Node

The class that creates a mesh to display how bones behave. If it is supplied with the bones' lengths it will show exactly how the bones look like on the scene. If not then only connections between each bone heads will be shown.

Nested Class Summary

Nested classes/interfaces inherited from class com.jme3.scene.Spatial

Spatial.BatchHint, Spatial.CullHint, Spatial.DFSMode

Field Summary

Fields inherited from class com.jme3.scene.Node

children

Fields inherited from class com.jme3.scene.Spatial

batchHint, controls, cullHint, frustrumIntersects, key, localLights, localOverrides, localTransform, name, parent, queueBucket, queueDistance, refreshFlags, RF_BOUND, RF_CHILD_LIGHTLIST, RF_LIGHTLIST, RF_MATPARAM_OVERRIDE, RF_TRANSFORM, shadowMode, userData, worldBound, worldLights, worldOverrides, worldTransform

Constructor Summary

Constructors

Constructor	Description
ArmatureDebugger()	Default constructor for `ArmatureDebugger`.
ArmatureDebugger(AssetManager assetManager, SkinningControl skControl)	Convenience constructor that creates an ArmatureDebugger and immediately initializes its materials based on the provided AssetManager and SkinningControl.
ArmatureDebugger(String name, Armature armature, List<Joint> deformingJoints)	Creates an `ArmatureDebugger` instance without explicit bone length data.

Method Summary

Modifier and Type	Method	Description
int	collideWith(Collidable other, CollisionResults results)	Check collision with another Collidable.
void	displayNonDeformingJoint(boolean display)	Sets the visibility of non-deforming joints and their associated outlines and wires.
Armature	getArmature()	Returns the Armature instance associated with this debugger.
ArmatureNode	getBoneShapes()	Returns the ArmatureNode which is responsible for generating and managing the visual mesh of the bones and wires.
ArmatureInterJointsWire	getInterJointWires()	Returns the ArmatureInterJointsWire instance, which represents the dotted lines connecting a bone's tail to the head of its children.
void	initialize(AssetManager assetManager, Camera camera)	Initializes the materials and camera for the debugger's visual components.
protected Joint	select(Geometry geo)	Selects and returns the Joint associated with a given Geometry.
void	updateLogicalState(float tpf)	updateLogicalState calls the update() method for all controls attached to this Spatial.

Methods inherited from class com.jme3.scene.Node

attachChild, attachChildAt, breadthFirstTraversal, clone, cloneFields, deepClone, depthFirstTraversal, descendantMatches, descendantMatches, descendantMatches, detachAllChildren, detachChild, detachChildAt, detachChildNamed, getChild, getChild, getChildIndex, getChildren, getQuantity, getTriangleCount, getVertexCount, hasChild, oldDeepClone, read, setLightListRefresh, setLodLevel, setMaterial, setMatParamOverrideRefresh, setModelBound, setParent, setTransformRefresh, swapChildren, updateGeometricState, updateModelBound, updateWorldBound, write

Methods inherited from class com.jme3.scene.Spatial

addControl, addControlAt, addLight, addMatParamOverride, breadthFirstTraversal, center, checkCulling, clearMatParamOverrides, clone, depthFirstTraversal, forceRefresh, getBatchHint, getControl, getControl, getCullHint, getKey, getLastFrustumIntersection, getLocalBatchHint, getLocalCullHint, getLocalLightList, getLocalMatParamOverrides, getLocalQueueBucket, getLocalRotation, getLocalScale, getLocalShadowMode, getLocalToWorldMatrix, getLocalTransform, getLocalTranslation, getName, getNumControls, getParent, getQueueBucket, getShadowMode, getUserData, getUserDataKeys, getWorldBound, getWorldLightList, getWorldMatParamOverrides, getWorldRotation, getWorldScale, getWorldTransform, getWorldTranslation, hasAncestor, jmeClone, localToWorld, lookAt, matches, move, move, oldClone, removeControl, removeControl, removeFromParent, removeLight, removeMatParamOverride, rotate, rotate, rotateUpTo, runControlRender, scale, scale, setBatchHint, setBoundRefresh, setCullHint, setKey, setLastFrustumIntersection, setLocalRotation, setLocalRotation, setLocalScale, setLocalScale, setLocalScale, setLocalTransform, setLocalTranslation, setLocalTranslation, setName, setQueueBucket, setRequiresUpdates, setShadowMode, setUserData, toString, updateMatParamOverrides, updateWorldLightList, updateWorldTransforms, worldToLocal

Methods inherited from class java.lang.Object

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

Constructor Details

ArmatureDebugger

public ArmatureDebugger()

Default constructor for `ArmatureDebugger`. Use ArmatureDebugger(String, Armature, List) for a functional instance.

ArmatureDebugger

public ArmatureDebugger(AssetManager assetManager,
 SkinningControl skControl)

Convenience constructor that creates an ArmatureDebugger and immediately initializes its materials based on the provided AssetManager and SkinningControl.

Parameters:

assetManager - The AssetManager used to load textures and materials for the debug visualization.

skControl - The SkinningControl from which to extract the Armature and its associated joints.

ArmatureDebugger

public ArmatureDebugger(String name,
 Armature armature,
 List<Joint> deformingJoints)

Creates an `ArmatureDebugger` instance without explicit bone length data. In this configuration, the visual representation will consist of wires connecting the bone heads, and points representing the bone heads. No dotted lines for inter-bone connections will be visible.

Parameters:

name - The name of this debugger's root node.

armature - The Armature to be visualized.

deformingJoints - A List of Joint objects that are considered deforming joints.

Method Details

displayNonDeformingJoint

public void displayNonDeformingJoint(boolean display)

Sets the visibility of non-deforming joints and their associated outlines and wires.

Parameters:

display - `true` to make non-deforming joints visible, `false` to hide them.

initialize

public void initialize(AssetManager assetManager,
 Camera camera)

Initializes the materials and camera for the debugger's visual components. This method should be called after the `ArmatureDebugger` is added to a scene graph and an AssetManager and Camera are available.

Parameters:

assetManager - The AssetManager to load textures and materials.

camera - The scene's primary Camera, used by the `ArmatureNode` for billboard rendering of joint points.

getArmature

public Armature getArmature()

Returns the Armature instance associated with this debugger.

Returns:

The Armature being debugged.

updateLogicalState

public void updateLogicalState(float tpf)

Description copied from class: Spatial

updateLogicalState calls the update() method for all controls attached to this Spatial.

Overrides:

updateLogicalState in class Node

Parameters:

tpf - Time per frame.

See Also:

• Spatial.addControl(com.jme3.scene.control.Control)

collideWith

public int collideWith(Collidable other,
 CollisionResults results)

Description copied from interface: Collidable

Check collision with another Collidable.

Specified by:

collideWith in interface Collidable

Overrides:

collideWith in class Node

Parameters:

other - The object to check collision against

results - Will contain the list of CollisionResults.

Returns:

how many collisions were found between this and other

select

protected Joint select(Geometry geo)

Selects and returns the Joint associated with a given Geometry. This is an internal helper method, likely used for picking operations.

Parameters:

geo - The Geometry representing a part of a joint.

Returns:

The Joint corresponding to the geometry, or `null` if not found.

getBoneShapes

public ArmatureNode getBoneShapes()

Returns the ArmatureNode which is responsible for generating and managing the visual mesh of the bones and wires.

Returns:

The ArmatureNode instance.

getInterJointWires

public ArmatureInterJointsWire getInterJointWires()

Returns the ArmatureInterJointsWire instance, which represents the dotted lines connecting a bone's tail to the head of its children. This will be `null` if the debugger was created without bone length data.

Returns:

The ArmatureInterJointsWire instance, or `null` if not present.