jme3utilities.debug

Class Describer

java.lang.Object

jme3utilities.debug.Describer

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

PhysicsDescriber

public class Describer
extends java.lang.Object
implements java.lang.Cloneable

Generate compact textual descriptions of Libbulletjme objects.

Constructor Summary

Constructors

Constructor and Description
Describer() Instantiate a Describer with the default separator.

Method Summary

Modifier and Type	Method and Description
Describer	clone() Create a copy of this Describer.
java.lang.String	describe(BoundingBox aabb) Generate a compact, textual description of the specified BoundingBox.
protected java.lang.String	describeHalfExtents(Vector3f he) Describe the specified half extents.
java.lang.String	describeScale(Vector3f vector) Generate a compact, textual description of the specified scale vector.
java.lang.String	listSeparator() Return the list separator.
void	setListSeparator(java.lang.String newSeparator) Alter the list separator.

Methods inherited from class java.lang.Object

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

Constructor Detail

Describer

public Describer()

Instantiate a Describer with the default separator.

This no-arg constructor was made explicit to avoid javadoc warnings from JDK 18+.

Method Detail

describe

public java.lang.String describe(BoundingBox aabb)

Generate a compact, textual description of the specified BoundingBox.

Parameters:

aabb - the box to describe (not null, unaffected)

Returns:

description (not null, not empty)

describeScale

public java.lang.String describeScale(Vector3f vector)

Generate a compact, textual description of the specified scale vector.

Parameters:

vector - the vector to describe (not null, unaffected)

Returns:

a description (not null, may be empty)

listSeparator

public java.lang.String listSeparator()

Return the list separator.

Returns:

separator text string (not null, may be empty, default=" ")

setListSeparator

public void setListSeparator(java.lang.String newSeparator)

Alter the list separator.

Parameters:

newSeparator - (not null, may be empty)

describeHalfExtents

protected java.lang.String describeHalfExtents(Vector3f he)

Describe the specified half extents.

Parameters:

he - the half extent for each axis (not null, unaffected)

Returns:

a bracketed description (not null, not empty)

clone

public Describer clone()
                throws java.lang.CloneNotSupportedException

Create a copy of this Describer.

Overrides:

clone in class java.lang.Object

Returns:

a new instance, equivalent to this one

Throws:

java.lang.CloneNotSupportedException - if the superclass isn't cloneable