Module com.github.stephengold.joltjni
Package com.github.stephengold.joltjni

Class DrawSettings

java.lang.Object
com.github.stephengold.joltjni.JoltPhysicsObject
com.github.stephengold.joltjni.DrawSettings
All Implemented Interfaces:
ConstDrawSettings, ConstJoltPhysicsObject, AutoCloseable, Comparable<JoltPhysicsObject>
public final class DrawSettings extends JoltPhysicsObject implements ConstDrawSettings
Configure debug visualization of some hair. (native type: Hair::DrawSettings)

  • Constructor Details

    • DrawSettings

      public DrawSettings()
      Instantiate settings with the default values.

    • DrawSettings

      public DrawSettings(ConstDrawSettings original)
      Instantiate a copy of the specified settings.
      Parameters:
      original - the settings to copy (not null, unaffected)

  • Method Details

    • setDrawAngularVelocity

      public DrawSettings setDrawAngularVelocity(boolean enable)
      Enable or disable visualization of vertex angular velocities. (native attribute: mDrawAngularVelocity)
      Parameters:
      enable - true to enable, or false to disable (default=false)
      Returns:
      the modified settings, for chaining

    • setDrawGridDensity

      public DrawSettings setDrawGridDensity(boolean enable)
      Enable or disable visualization of grid density. (native attribute: mDrawGridDensity)
      Parameters:
      enable - true to enable, or false to disable (default=false)
      Returns:
      the modified settings, for chaining

    • setDrawGridVelocity

      public DrawSettings setDrawGridVelocity(boolean enable)
      Enable or disable visualization of grid velocity. (native attribute: mDrawGridVelocity)
      Parameters:
      enable - true to enable, or false to disable (default=false)
      Returns:
      the modified settings, for chaining

    • setDrawInitialGravity

      public DrawSettings setDrawInitialGravity(boolean enable)
      Enable or disable visualization of the initial gravity vector. (native attribute: mDrawInitialGravity)
      Parameters:
      enable - true to enable, or false to disable (default=true)
      Returns:
      the modified settings, for chaining

    • setDrawNeutralDensity

      public DrawSettings setDrawNeutralDensity(boolean enable)
      Enable or disable visualization of the grid density of the hair in its neutral pose. (native attribute: mDrawNeutralDensity)
      Parameters:
      enable - true to enable, or false to disable (default=false)
      Returns:
      the modified settings, for chaining

    • setDrawOrientations

      public DrawSettings setDrawOrientations(boolean enable)
      Enable or disable visualization of the coordinate axes of each simulated vertex. (native attribute: mDrawOrientations)
      Parameters:
      enable - true to enable, or false to disable (default=false)
      Returns:
      the modified settings, for chaining

    • setDrawRenderStrands

      public DrawSettings setDrawRenderStrands(boolean enable)
      Enable or disable debug visualization of the strands. (native attribute: mDrawRenderStrands)
      Parameters:
      enable - true to enable, or false to disable (default=false)
      Returns:
      the modified settings, for chaining

    • setDrawRods

      public DrawSettings setDrawRods(boolean enable)
      Enable or disable visualization of the simulated rods. (native attribute: mDrawRods)
      Parameters:
      enable - true to enable, or false to disable (default=true)
      Returns:
      the modified settings, for chaining

    • setDrawSkinPoints

      public DrawSettings setDrawSkinPoints(boolean enable)
      Enable or disable visualization of the skinning points on the scalp. (native attribute: mDrawSkinPoints)
      Parameters:
      enable - true to enable, or false to disable (default=false)
      Returns:
      the modified settings, for chaining

    • setDrawUnloadedRods

      public DrawSettings setDrawUnloadedRods(boolean enable)
      Enable or disable visualization of rods in their unloaded pose. (native attribute: mDrawUnloadedRods)
      Parameters:
      enable - true to enable, or false to disable (default=false)
      Returns:
      the modified settings, for chaining

    • setDrawVertexVelocity

      public DrawSettings setDrawVertexVelocity(boolean enable)
      Enable or disable visualization of vertex velocities. (native attribute: mDrawVertexVelocity)
      Parameters:
      enable - true to enable, or false to disable (default=false)
      Returns:
      the modified settings, for chaining

    • setRenderStrandColor

      public DrawSettings setRenderStrandColor(ERenderStrandColor color)
      Configure colors for visualizing strands. (native attribute: mRenderStrandColor)
      Parameters:
      color - the desired coloring option (not null, default=PerSimulatedStrand)
      Returns:
      the modified settings, for chaining

    • setSimulationStrandBegin

      public DrawSettings setSimulationStrandBegin(int strandIndex)
      Configure the start of the range of strands to visualize. (native attribute: mSimulationStrandBegin)
      Parameters:
      strandIndex - the desired strand index (≥0)
      Returns:
      the modified settings, for chaining

    • setSimulationStrandEnd

      public DrawSettings setSimulationStrandEnd(int strandIndex)
      Configure the end of the range of strands to visualize. (native attribute: mSimulationStrandEnd)
      Parameters:
      strandIndex - the desired strand index (≥0)
      Returns:
      the modified settings, for chaining

    • getDrawAngularVelocity

      public boolean getDrawAngularVelocity()
      Test whether to visualize vertex angular velocities. The settings are unaffected. (native attribute: mDrawAngularVelocity)
      Specified by:
      getDrawAngularVelocity in interface ConstDrawSettings
      Returns:
      true if enabled, otherwise false

    • getDrawGridDensity

      public boolean getDrawGridDensity()
      Test whether to visualize grid density. The settings are unaffected. (native attribute: mDrawGridDensity)
      Specified by:
      getDrawGridDensity in interface ConstDrawSettings
      Returns:
      true if enabled, otherwise false

    • getDrawGridVelocity

      public boolean getDrawGridVelocity()
      Test whether to visualize grid velocity. The settings are unaffected. (native attribute: mDrawGridVelocity)
      Specified by:
      getDrawGridVelocity in interface ConstDrawSettings
      Returns:
      true if enabled, otherwise false

    • getDrawInitialGravity

      public boolean getDrawInitialGravity()
      Test whether to visualize the initial gravity vector. The settings are unaffected. (native attribute: mDrawInitialGravity)
      Specified by:
      getDrawInitialGravity in interface ConstDrawSettings
      Returns:
      true if enabled, otherwise false

    • getDrawNeutralDensity

      public boolean getDrawNeutralDensity()
      Test whether to visualize the grid density of the hair in its neutral pose. The settings are unaffected. (native attribute: mDrawNeutralDensity)
      Specified by:
      getDrawNeutralDensity in interface ConstDrawSettings
      Returns:
      true if enabled, otherwise false

    • getDrawOrientations

      public boolean getDrawOrientations()
      Test whether to visualize the coordinate axes of each simulated vertex. The settings are unaffected. (native attribute: mDrawOrientations)
      Specified by:
      getDrawOrientations in interface ConstDrawSettings
      Returns:
      true if enabled, otherwise false

    • getDrawRenderStrands

      public boolean getDrawRenderStrands()
      Test whether to visualize the strands. The settings are unaffected. (native attribute: mDrawRenderStrands)
      Specified by:
      getDrawRenderStrands in interface ConstDrawSettings
      Returns:
      true if enabled, otherwise false

    • getDrawRods

      public boolean getDrawRods()
      Test whether to visualize the simulated rods. The settings are unaffected. (native attribute: mDrawRods)
      Specified by:
      getDrawRods in interface ConstDrawSettings
      Returns:
      true if enabled, otherwise false

    • getDrawSkinPoints

      public boolean getDrawSkinPoints()
      Test whether to visualize the skinning points on the scalp. The settings are unaffected. (native attribute: mDrawSkinPoints)
      Specified by:
      getDrawSkinPoints in interface ConstDrawSettings
      Returns:
      true if enabled, otherwise false

    • getDrawUnloadedRods

      public boolean getDrawUnloadedRods()
      Test whether to visualize rods in their unloaded pose. The settings are unaffected. (native attribute: mDrawUnloadedRods)
      Specified by:
      getDrawUnloadedRods in interface ConstDrawSettings
      Returns:
      true if enabled, otherwise false

    • getDrawVertexVelocity

      public boolean getDrawVertexVelocity()
      Test whether to visualize vertex velocities. The settings are unaffected. (native attribute: mDrawVertexVelocity)
      Specified by:
      getDrawVertexVelocity in interface ConstDrawSettings
      Returns:
      true if enabled, otherwise false

    • getRenderStrandColor

      public ERenderStrandColor getRenderStrandColor()
      Return the option for coloring strands. The settings are unaffected. (native attribute: mRenderStrandColor)
      Specified by:
      getRenderStrandColor in interface ConstDrawSettings
      Returns:
      the enum value (not null)

    • getSimulationStrandBegin

      public int getSimulationStrandBegin()
      Return the start of the range of strands to visualize. The settings are unaffected. (native attribute: mSimulationStrandBegin)
      Specified by:
      getSimulationStrandBegin in interface ConstDrawSettings
      Returns:
      the starting strand index

    • getSimulationStrandEnd

      public int getSimulationStrandEnd()
      Return the end of the range of strands to visualize. The settings are unaffected. (native attribute: mSimulationStrandEnd)
      Specified by:
      getSimulationStrandEnd in interface ConstDrawSettings
      Returns:
      the ending strand index