Module de.fabmax.physxjni
Package physx.support

Enum Class PxVisualizationParameterEnum

java.lang.Object
java.lang.Enum<PxVisualizationParameterEnum>
physx.support.PxVisualizationParameterEnum
All Implemented Interfaces:
Serializable, Comparable<PxVisualizationParameterEnum>, Constable
public enum PxVisualizationParameterEnum extends Enum<PxVisualizationParameterEnum>
Debug visualization parameters.

#PxVisualizationParameter::eSCALE is the master switch for enabling visualization, please read the corresponding documentation for further details.

See also: PxScene.setVisualizationParameter() PxScene.getVisualizationParameter() PxScene.getRenderBuffer()

  • Enum Constant Details

    • eSCALE

      public static final PxVisualizationParameterEnum eSCALE
      This overall visualization scale gets multiplied with the individual scales. Setting to zero ignores all visualizations. Default is 0.

      The below settings permit the debug visualization of various simulation properties. The setting is either zero, in which case the property is not drawn. Otherwise it is a scaling factor that determines the size of the visualization widgets.

      Only objects for which visualization is turned on using setFlag(eVISUALIZATION) are visualized (see #PxActorFlag::eVISUALIZATION, #PxShapeFlag::eVISUALIZATION, ...). Default is 0.

      Notes: - to see any visualization, you have to set PxVisualizationParameter::eSCALE to nonzero first. - the scale factor has been introduced because it's difficult (if not impossible) to come up with a good scale for 3D vectors. Normals are normalized and their length is always 1. But it doesn't mean we should render a line of length 1. Depending on your objects/scene, this might be completely invisible or extremely huge. That's why the scale factor is here, to let you tune the length until it's ok in your scene. - however, things like collision shapes aren't ambiguous. They are clearly defined for example by the triangles & polygons themselves, and there's no point in scaling that. So the visualization widgets are only scaled when it makes sense.

      Range: [0, PX_MAX_F32)
      Default: 0

    • eWORLD_AXES

      public static final PxVisualizationParameterEnum eWORLD_AXES
      Visualize the world axes.

    • eBODY_AXES

      public static final PxVisualizationParameterEnum eBODY_AXES
      Visualize a bodies axes.

      See also: PxActor.globalPose PxActor

    • eBODY_MASS_AXES

      public static final PxVisualizationParameterEnum eBODY_MASS_AXES
      Visualize a body's mass axes.

      This visualization is also useful for visualizing the sleep state of bodies. Sleeping bodies are drawn in black, while awake bodies are drawn in white. If the body is sleeping and part of a sleeping group, it is drawn in red.

      See also: PxBodyDesc.massLocalPose PxActor

    • eBODY_LIN_VELOCITY

      public static final PxVisualizationParameterEnum eBODY_LIN_VELOCITY
      Visualize the bodies linear velocity.

      See also: PxBodyDesc.linearVelocity PxActor

    • eBODY_ANG_VELOCITY

      public static final PxVisualizationParameterEnum eBODY_ANG_VELOCITY
      Visualize the bodies angular velocity.

      See also: PxBodyDesc.angularVelocity PxActor

    • eCONTACT_POINT

      public static final PxVisualizationParameterEnum eCONTACT_POINT
      Visualize contact points. Will enable contact information.

    • eCONTACT_NORMAL

      public static final PxVisualizationParameterEnum eCONTACT_NORMAL
      Visualize contact normals. Will enable contact information.

    • eCONTACT_ERROR

      public static final PxVisualizationParameterEnum eCONTACT_ERROR
      Visualize contact errors. Will enable contact information.

    • eCONTACT_FORCE

      public static final PxVisualizationParameterEnum eCONTACT_FORCE

    • eACTOR_AXES

      public static final PxVisualizationParameterEnum eACTOR_AXES
      Visualize actor axes.

      See also: PxRigidStatic PxRigidDynamic PxArticulationLink

    • eCOLLISION_AABBS

      public static final PxVisualizationParameterEnum eCOLLISION_AABBS
      Visualize bounds (AABBs in world space)

    • eCOLLISION_SHAPES

      public static final PxVisualizationParameterEnum eCOLLISION_SHAPES
      Shape visualization

      See also: PxShape

    • eCOLLISION_AXES

      public static final PxVisualizationParameterEnum eCOLLISION_AXES
      Shape axis visualization

      See also: PxShape

    • eCOLLISION_COMPOUNDS

      public static final PxVisualizationParameterEnum eCOLLISION_COMPOUNDS
      Compound visualization (compound AABBs in world space)

    • eCOLLISION_FNORMALS

      public static final PxVisualizationParameterEnum eCOLLISION_FNORMALS
      Mesh & convex face normals

      See also: PxTriangleMesh PxConvexMesh

    • eCOLLISION_EDGES

      public static final PxVisualizationParameterEnum eCOLLISION_EDGES
      Active edges for meshes

      See also: PxTriangleMesh

    • eCOLLISION_STATIC

      public static final PxVisualizationParameterEnum eCOLLISION_STATIC
      Static pruning structures

    • eCOLLISION_DYNAMIC

      public static final PxVisualizationParameterEnum eCOLLISION_DYNAMIC
      Dynamic pruning structures

    • eJOINT_LOCAL_FRAMES

      public static final PxVisualizationParameterEnum eJOINT_LOCAL_FRAMES
      Joint local axes

    • eJOINT_LIMITS

      public static final PxVisualizationParameterEnum eJOINT_LIMITS
      Joint limits

    • eCULL_BOX

      public static final PxVisualizationParameterEnum eCULL_BOX
      Visualize culling box

    • eMBP_REGIONS

      public static final PxVisualizationParameterEnum eMBP_REGIONS
      MBP regions

    • eSIMULATION_MESH

      public static final PxVisualizationParameterEnum eSIMULATION_MESH
      Renders the simulation mesh instead of the collision mesh (only available for tetmeshes)

      Deformable visualization is currently not supported.

    • eSDF

      public static final PxVisualizationParameterEnum eSDF
      Renders the SDF of a mesh instead of the collision mesh (only available for triangle meshes with SDFs)

    • eNUM_VALUES

      public static final PxVisualizationParameterEnum eNUM_VALUES
      This is not a parameter, it just records the current number of parameters (as maximum(PxVisualizationParameter)+1) for use in loops.

    • eFORCE_DWORD

      public static final PxVisualizationParameterEnum eFORCE_DWORD

  • Field Details

    • value

      public final int value

  • Method Details

    • values

      public static PxVisualizationParameterEnum[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static PxVisualizationParameterEnum valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • forValue

      public static PxVisualizationParameterEnum forValue(int value)