Class PhysicsScene

java.lang.Object
com.github.stephengold.joltjni.JoltPhysicsObject
com.github.stephengold.joltjni.PhysicsScene
All Implemented Interfaces:
ConstJoltPhysicsObject, RefTarget, AutoCloseable, Comparable<ConstJoltPhysicsObject>

public class PhysicsScene extends JoltPhysicsObject implements RefTarget
The creation settings of a set of bodies.
  • Constructor Details

    • PhysicsScene

      public PhysicsScene()
      Instantiate an empty scene.
  • Method Details

    • fixInvalidScales

      public boolean fixInvalidScales()
      Correct any incorrectly scaled shapes in the scene.
      Returns:
      true if successful, otherwise false
    • fromPhysicsSystem

      public void fromPhysicsSystem(PhysicsSystem system)
      Load the current state of the specified physics system.
      Parameters:
      system - the physics system to load from (not null, unaffected)
    • getBodies

      public BodyCreationSettings[] getBodies()
      Access the body-creation settings as a Java array.
      Returns:
      a new array of new JVM objects with the pre-existing native objects assigned
    • createBodies

      public boolean createBodies(PhysicsSystem system)
      Instantiate the bodies in the scene.
      Parameters:
      system - where to add the bodies (not null, modified)
      Returns:
      true if successful, otherwise false
    • saveBinaryState

      public void saveBinaryState(StreamOut stream, boolean saveShapes, boolean saveGroupFilter)
      Save the state of this object in binary form.
      Parameters:
      stream - the stream to write to (not null)
      saveShapes - if true, save the shapes
      saveGroupFilter - if true, save the group filter
    • getRefCount

      public int getRefCount()
      Count the active references to the native PhysicsScene. The scene is unaffected.
      Specified by:
      getRefCount in interface RefTarget
      Returns:
      the count (≥0)
    • setEmbedded

      public void setEmbedded()
      Mark the native PhysicsScene as embedded.
      Specified by:
      setEmbedded in interface RefTarget
    • toRef

      public PhysicsSceneRef toRef()
      Create a counted reference to the native PhysicsScene.
      Specified by:
      toRef in interface RefTarget
      Returns:
      a new JVM object with a new native object assigned