Package jme3utilities.debug

Class Describer

java.lang.Object
jme3utilities.debug.Describer
All Implemented Interfaces:
Cloneable
public class Describer extends Object implements Cloneable
Generate compact textual descriptions of jME3 objects.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Describer()
    A no-arg constructor to avoid javadoc warnings from JDK 18.

  • Method Summary

    Modifier and Type
    Method
    Description
    Describer
    clone()
    Create a copy of this Describer.
    String
    describe(com.jme3.anim.Armature armature)
    Generate a compact, textual description of the specified Armature, not including its joints.
    String
    describe(com.jme3.anim.Joint joint)
    Generate a compact, textual description of the specified Joint, not including its children.
    String
    describe(com.jme3.animation.Bone bone)
    Generate a compact, textual description of the specified Bone, not including its children.
    String
    describe(com.jme3.animation.Skeleton skeleton)
    Generate a compact, textual description of the specified Skeleton, not including its bones.
    protected String
    describe(com.jme3.asset.TextureKey textureKey)
    Describe a TextureKey.
    String
    describe(com.jme3.bounding.BoundingBox aabb)
    Generate a compact, textual description of the specified BoundingBox.
    String
    describe(com.jme3.bounding.BoundingSphere sphere)
    Generate a compact, textual description of the specified BoundingSphere.
    String
    describe(com.jme3.bounding.BoundingVolume boundingVolume)
    Generate a compact, textual description of the specified BoundingVolume.
    protected String
    describe(com.jme3.light.Light light)
    Generate a brief textual description of a light.
    protected String
    describe(com.jme3.light.LightList lightList)
    Generate a textual description of a light list.
    String
    describe(com.jme3.material.Material material)
    Generate a compact, textual description of the specified Material, not including its parameters.
    String
    describe(com.jme3.material.MatParam matParam)
    Generate a compact, textual description of the specified material parameter.
    protected String
    describe(com.jme3.material.MatParamOverride override)
    Generate a textual description of a material-parameter override.
    protected String
    describe(com.jme3.material.RenderState state)
    Generate a textual description of a RenderState.
    protected String
    describe(com.jme3.post.Filter filter)
    Generate a textual description of a filter.
    protected String
    describe(com.jme3.post.SceneProcessor processor)
    Generate a textual description of a SceneProcessor.
    protected String
    describe(com.jme3.renderer.Camera camera)
    Generate a textual description of a camera.
    protected String
    describe(com.jme3.scene.control.Control control)
    Generate a textual description of a scene-graph control.
    String
    describe(com.jme3.scene.Mesh mesh)
    Generate a compact, textual description of the specified Mesh.
    String
    describe(com.jme3.scene.VertexBuffer buffer)
    Generate a compact, textual description of the specified VertexBuffer.
    String
    describe(com.jme3.texture.Texture texture)
    Generate a compact, textual description of the specified Texture.
    String
    describeAudioNode(com.jme3.scene.Spatial spatial)
    Generate a compact, textual description of an AudioNode.
    String
    describeBucket(com.jme3.scene.Spatial spatial)
    Generate a compact, textual description of the render-queue bucket to which the specified Spatial is assigned.
    String
    describeControls(com.jme3.scene.Spatial spatial)
    Generate a compact, textual description of all controls added to the specified Spatial.
    String
    describeCull(com.jme3.scene.Spatial spatial)
    Generate a compact, textual description of the view-frustum culling hints of the specified Spatial.
    String
    describeFilters(com.jme3.post.FilterPostProcessor fpp)
    Generate a compact, textual description of the filters in the specified FilterPostProcessor.
    String
    describeFlags(com.jme3.renderer.ViewPort viewPort)
    Generate a compact, textual description of the flags of the specified ViewPort.
    String
    describeFloats(float... data)
    Generate a compact, textual description of the specified single-precision floating-point values.
    protected String
    describeHalfExtents(com.jme3.math.Vector3f he)
    Describe the specified half extents.
    String
    describeLocation(com.jme3.scene.Spatial spatial)
    Generate a compact, textual description of the world location of the specified Spatial.
    protected String
    describeMore(com.jme3.renderer.Camera camera)
    Generate additional textual description of a Camera.
    String
    describeOrientation(com.jme3.scene.Spatial spatial)
    Generate a compact, textual description of the world orientation of the specified Spatial.
    String
    describeOverrides(com.jme3.scene.Spatial spatial)
    Generate a compact, textual description of the material-parameter overrides of the specified Spatial.
    String
    describeProcessors(com.jme3.renderer.ViewPort viewPort)
    Generate a compact, textual description of the scene processors of the specified ViewPort.
    String
    describeScale(com.jme3.math.Vector3f vector)
    Generate a compact, textual description of the specified scale vector.
    String
    describeScale(com.jme3.scene.Spatial spatial)
    Generate a compact, textual description of the world scale of the specified Spatial.
    String
    describeShadow(com.jme3.scene.Spatial spatial)
    Generate a compact, textual description of the shadow modes of the specified Spatial.
    String
    describeTrackTarget(com.jme3.anim.util.HasLocalTransform target)
    Generate a compact, textual description of the specified animation track target.
    protected char
    describeType(com.jme3.scene.Spatial spatial)
    Generate a single-character description of the specified Spatial.
    String
    describeUserData(com.jme3.scene.Spatial spatial)
    Generate a compact, textual description of any user data in the specified Spatial.
    String
    describeVertexData(com.jme3.scene.Mesh mesh, int vertexIndex)
    Generate a compact, textual description of the indexed vertex in the specified Mesh.
    protected boolean
    isControlEnabled(com.jme3.scene.control.Control control)
    Test whether the specified scene-graph control is enabled.
    String
    listSeparator()
    Return the list separator.
    void
    setListSeparator(String newSeparator)
    Alter the list separator.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • Describer

      public Describer()
      A no-arg constructor to avoid javadoc warnings from JDK 18.

  • Method Details

    • describe

      public String describe(com.jme3.anim.Armature armature)
      Generate a compact, textual description of the specified Armature, not including its joints.
      Parameters:
      armature - the Armature to describe (not null, unaffected)
      Returns:
      a description (not null, not empty)

    • describe

      public String describe(com.jme3.animation.Bone bone)
      Generate a compact, textual description of the specified Bone, not including its children.
      Parameters:
      bone - the Bone to describe (not null, unaffected)
      Returns:
      a description (not null, not empty)

    • describe

      public String describe(com.jme3.bounding.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)

    • describe

      public String describe(com.jme3.bounding.BoundingSphere sphere)
      Generate a compact, textual description of the specified BoundingSphere.
      Parameters:
      sphere - the sphere to describe (not null, unaffected)
      Returns:
      description (not null, not empty)

    • describe

      public String describe(com.jme3.bounding.BoundingVolume boundingVolume)
      Generate a compact, textual description of the specified BoundingVolume.
      Parameters:
      boundingVolume - the sphere to describe (not null, unaffected)
      Returns:
      description (not null, not empty)

    • describe

      public String describe(com.jme3.anim.Joint joint)
      Generate a compact, textual description of the specified Joint, not including its children.
      Parameters:
      joint - the Joint to describe (not null, unaffected)
      Returns:
      a description (not null, not empty)

    • describe

      public String describe(com.jme3.material.Material material)
      Generate a compact, textual description of the specified Material, not including its parameters.
      Parameters:
      material - the Material to describe (may be null, unaffected)
      Returns:
      a description (not null, may be empty)

    • describe

      public String describe(com.jme3.material.MatParam matParam)
      Generate a compact, textual description of the specified material parameter.
      Parameters:
      matParam - the material parameter to describe (not null, unaffected)
      Returns:
      a description (not null, may be empty)

    • describe

      public String describe(com.jme3.scene.Mesh mesh)
      Generate a compact, textual description of the specified Mesh.
      Parameters:
      mesh - the Mesh to describe (may be null, unaffected)
      Returns:
      a description (not null, not empty)

    • describe

      public String describe(com.jme3.animation.Skeleton skeleton)
      Generate a compact, textual description of the specified Skeleton, not including its bones.
      Parameters:
      skeleton - the Skeleton to describe (not null, unaffected)
      Returns:
      a description (not null, not empty)

    • describe

      public String describe(com.jme3.texture.Texture texture)
      Generate a compact, textual description of the specified Texture.
      Parameters:
      texture - the Texture to describe (may be null, unaffected)
      Returns:
      a textual description (not null, not empty)

    • describe

      public String describe(com.jme3.scene.VertexBuffer buffer)
      Generate a compact, textual description of the specified VertexBuffer.
      Parameters:
      buffer - the buffer to describe (not null, unaffected)
      Returns:
      a textual description (not null, not empty)

    • describeAudioNode

      public String describeAudioNode(com.jme3.scene.Spatial spatial)
      Generate a compact, textual description of an AudioNode.
      Parameters:
      spatial - the AudioNode to describe (not null, unaffected)
      Returns:
      a description (not null, not empty)

    • describeBucket

      public String describeBucket(com.jme3.scene.Spatial spatial)
      Generate a compact, textual description of the render-queue bucket to which the specified Spatial is assigned.
      Parameters:
      spatial - the Spatial to describe (not null, unaffected)
      Returns:
      a description (not null, not empty)

    • describeControls

      public String describeControls(com.jme3.scene.Spatial spatial)
      Generate a compact, textual description of all controls added to the specified Spatial.
      Parameters:
      spatial - the Spatial to describe (not null, unaffected)
      Returns:
      a description (not null, may be empty)

    • describeCull

      public String describeCull(com.jme3.scene.Spatial spatial)
      Generate a compact, textual description of the view-frustum culling hints of the specified Spatial.
      Parameters:
      spatial - the Spatial to describe (not null, unaffected)
      Returns:
      a description (not null, not empty)

    • describeFilters

      public String describeFilters(com.jme3.post.FilterPostProcessor fpp)
      Generate a compact, textual description of the filters in the specified FilterPostProcessor.
      Parameters:
      fpp - the processor to describe (not null, unaffected)
      Returns:
      a description (not null, may be empty)

    • describeFlags

      public String describeFlags(com.jme3.renderer.ViewPort viewPort)
      Generate a compact, textual description of the flags of the specified ViewPort.
      Parameters:
      viewPort - the ViewPort to describe (not null, unaffected)
      Returns:
      a description (not null, not empty)

    • describeFloats

      public String describeFloats(float... data)
      Generate a compact, textual description of the specified single-precision floating-point values.
      Parameters:
      data - the values to describe (not null)
      Returns:
      a description (not null, not empty)

    • describeLocation

      public String describeLocation(com.jme3.scene.Spatial spatial)
      Generate a compact, textual description of the world location of the specified Spatial.
      Parameters:
      spatial - the Spatial to describe (not null, unaffected)
      Returns:
      a description (not null, may be empty)

    • describeOrientation

      public String describeOrientation(com.jme3.scene.Spatial spatial)
      Generate a compact, textual description of the world orientation of the specified Spatial.
      Parameters:
      spatial - the Spatial to describe (not null, unaffected)
      Returns:
      a description (not null, may be empty)

    • describeOverrides

      public String describeOverrides(com.jme3.scene.Spatial spatial)
      Generate a compact, textual description of the material-parameter overrides of the specified Spatial.
      Parameters:
      spatial - the Spatial to describe (not null, unaffected)
      Returns:
      a description (not null, not empty)

    • describeProcessors

      public String describeProcessors(com.jme3.renderer.ViewPort viewPort)
      Generate a compact, textual description of the scene processors of the specified ViewPort.
      Parameters:
      viewPort - the ViewPort to describe (not null, unaffected)
      Returns:
      a description (not null, may be empty)

    • describeScale

      public String describeScale(com.jme3.scene.Spatial spatial)
      Generate a compact, textual description of the world scale of the specified Spatial.
      Parameters:
      spatial - the Spatial to describe (not null, unaffected)
      Returns:
      a description (not null, may be empty)

    • describeScale

      public String describeScale(com.jme3.math.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)

    • describeShadow

      public String describeShadow(com.jme3.scene.Spatial spatial)
      Generate a compact, textual description of the shadow modes of the specified Spatial.
      Parameters:
      spatial - the spatial to describe (not null, unaffected)
      Returns:
      a description (not null, not empty)

    • describeTrackTarget

      public String describeTrackTarget(com.jme3.anim.util.HasLocalTransform target)
      Generate a compact, textual description of the specified animation track target.
      Parameters:
      target - the target to describe (may be null, unaffected)
      Returns:
      a string of descriptive text (not null, not empty)

    • describeUserData

      public String describeUserData(com.jme3.scene.Spatial spatial)
      Generate a compact, textual description of any user data in the specified Spatial.
      Parameters:
      spatial - the Spatial to describe (not null, unaffected)
      Returns:
      a description (not null, may be empty)

    • describeVertexData

      public String describeVertexData(com.jme3.scene.Mesh mesh, int vertexIndex)
      Generate a compact, textual description of the indexed vertex in the specified Mesh.
      Parameters:
      mesh - (not null, unaffected)
      vertexIndex - (≥0)
      Returns:
      a description (not null, not empty)

    • listSeparator

      public String listSeparator()
      Return the list separator.
      Returns:
      separator text string (not null, may be empty, default=" ")

    • setListSeparator

      public void setListSeparator(String newSeparator)
      Alter the list separator.
      Parameters:
      newSeparator - (not null, may be empty)

    • describe

      protected String describe(com.jme3.renderer.Camera camera)
      Generate a textual description of a camera.
      Parameters:
      camera - the camera to describe (may be null, unaffected)
      Returns:
      a description (not null, not empty)
      See Also:

    • describe

      protected String describe(com.jme3.scene.control.Control control)
      Generate a textual description of a scene-graph control.
      Parameters:
      control - the control to describe (not null, unaffected)
      Returns:
      a description (not null, may be empty)

    • describe

      protected String describe(com.jme3.post.Filter filter)
      Generate a textual description of a filter.
      Parameters:
      filter - the filter to describe (unaffected)
      Returns:
      a description (not null, not empty)

    • describe

      protected String describe(com.jme3.light.Light light)
      Generate a brief textual description of a light.
      Parameters:
      light - the light to describe (unaffected)
      Returns:
      a description (not null, not empty)

    • describe

      protected String describe(com.jme3.light.LightList lightList)
      Generate a textual description of a light list.
      Parameters:
      lightList - the list to describe (not null, unaffected)
      Returns:
      a description (not null, may be empty)

    • describe

      protected String describe(com.jme3.material.MatParamOverride override)
      Generate a textual description of a material-parameter override.
      Parameters:
      override - the override to describe (not null, unaffected)
      Returns:
      a description (not null, not empty)

    • describe

      protected String describe(com.jme3.material.RenderState state)
      Generate a textual description of a RenderState.
      Parameters:
      state - the RenderState to describe (not null, unaffected)
      Returns:
      a description (not null, not empty)

    • describe

      protected String describe(com.jme3.post.SceneProcessor processor)
      Generate a textual description of a SceneProcessor.
      Parameters:
      processor - the processor to describe (may be null, unaffected)
      Returns:
      a description (not null, not empty)

    • describe

      protected String describe(com.jme3.asset.TextureKey textureKey)
      Describe a TextureKey.
      Parameters:
      textureKey - (not null, unaffected)
      Returns:
      a textual description (not null, not empty)

    • describeHalfExtents

      protected String describeHalfExtents(com.jme3.math.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)

    • describeMore

      protected String describeMore(com.jme3.renderer.Camera camera)
      Generate additional textual description of a Camera.
      Parameters:
      camera - the camera to describe (not null, unaffected)
      Returns:
      a description (not null, not empty)
      See Also:

    • describeType

      protected char describeType(com.jme3.scene.Spatial spatial)
      Generate a single-character description of the specified Spatial.
      Parameters:
      spatial - the spatial to describe (unaffected, may be null)
      Returns:
      a mnemonic character

    • isControlEnabled

      protected boolean isControlEnabled(com.jme3.scene.control.Control control)
      Test whether the specified scene-graph control is enabled.
      Parameters:
      control - the control to test (not null, unaffected)
      Returns:
      true if the control is enabled, otherwise false

    • clone

      public Describer clone() throws CloneNotSupportedException
      Create a copy of this Describer.
      Overrides:
      clone in class Object
      Returns:
      a new instance, equivalent to this one
      Throws:
      CloneNotSupportedException - if the superclass isn't cloneable