Module com.github.stephengold.joltjni

Package com.github.stephengold.joltjni

Class PlaneShapeSettings

java.lang.Object

com.github.stephengold.joltjni.JoltPhysicsObject

com.github.stephengold.joltjni.SerializableObject

com.github.stephengold.joltjni.ShapeSettings

com.github.stephengold.joltjni.PlaneShapeSettings

All Implemented Interfaces:

ConstJoltPhysicsObject, ConstSerializableObject, ConstShapeSettings, RefTarget, AutoCloseable, Comparable<JoltPhysicsObject>

public class PlaneShapeSettings
extends ShapeSettings

Settings used to construct a PlaneShape.

Field Summary

Fields

Modifier and Type	Field	Description
static final float	cDefaultHalfExtent	default half-extent for the PlaneShape

Constructor Summary

Constructors

Constructor	Description
PlaneShapeSettings()	Instantiate default settings.
PlaneShapeSettings(PlaneShapeSettings original)	Instantiate a copy of the specified settings.
PlaneShapeSettings(ConstPlane plane)	Instantiate settings for the specified plane.
PlaneShapeSettings(ConstPlane plane, ConstPhysicsMaterial material)	Instantiate settings for the specified plane and material.
PlaneShapeSettings(ConstPlane plane, ConstPhysicsMaterial material, float halfExtent)	Instantiate settings for the specified plane, material, and extent.

Method Summary

Modifier and Type	Method	Description
float	getHalfExtent()	Return the half extent.
ConstPhysicsMaterial	getMaterial()	Return the material.
Plane	getPlane()	Copy the surface equation.
void	setHalfExtent(float halfExtent)	Alter the plane's extent.
void	setMaterial(ConstPhysicsMaterial material)	Replace the material.
void	setPlane(ConstPlane plane)	Alter the surface equation.

Methods inherited from class com.github.stephengold.joltjni.ShapeSettings

clearCachedResult, cloneShapeSettings, create, getRefCount, setEmbedded, setVirtualAddressAsCoOwner, toRef, toRefC

Methods inherited from class com.github.stephengold.joltjni.SerializableObject

getRtti

Methods inherited from class com.github.stephengold.joltjni.JoltPhysicsObject

close, compareTo, equals, getContainingObject, hasAssignedNativeObject, hashCode, isCleanerStarted, ownsNativeObject, setVirtualAddress, setVirtualAddress, startCleaner, targetVa, toString, va

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface com.github.stephengold.joltjni.readonly.ConstJoltPhysicsObject

close, hasAssignedNativeObject, ownsNativeObject, targetVa

Methods inherited from interface com.github.stephengold.joltjni.readonly.ConstSerializableObject

getRtti

Field Details

cDefaultHalfExtent

public static final float cDefaultHalfExtent

default half-extent for the PlaneShape

See Also:

• Constant Field Values

Constructor Details

PlaneShapeSettings

public PlaneShapeSettings()

Instantiate default settings.

PlaneShapeSettings

public PlaneShapeSettings(ConstPlane plane)

Instantiate settings for the specified plane.

Parameters:

plane - the desired surface plane (not null, unaffected)

PlaneShapeSettings

public PlaneShapeSettings(ConstPlane plane,
 ConstPhysicsMaterial material)

Instantiate settings for the specified plane and material.

Parameters:

plane - the desired surface plane (not null, unaffected)

material - the desired surface properties (not null, unaffected) or null for default properties (default=null)

PlaneShapeSettings

public PlaneShapeSettings(ConstPlane plane,
 ConstPhysicsMaterial material,
 float halfExtent)

Instantiate settings for the specified plane, material, and extent.

Parameters:

plane - the desired surface plane (not null, unaffected)

material - the desired surface properties (not null, unaffected) or null for default properties (default=null)

halfExtent - the desired radius of the bounding box (>0, default=1000)

PlaneShapeSettings

public PlaneShapeSettings(PlaneShapeSettings original)

Instantiate a copy of the specified settings.

Parameters:

original - the settings to copy (not null, unaffected)

Method Details

getHalfExtent

public float getHalfExtent()

Return the half extent. The settings are unaffected. (native attribute: mHalfExtent)

Returns:

half the extent

getMaterial

public ConstPhysicsMaterial getMaterial()

Return the material. The settings are unaffected. (native attribute: mMaterial)

Returns:

a new JVM object with the pre-existing native object assigned, or null if none

getPlane

public Plane getPlane()

Copy the surface equation. The settings are unaffected. (native attribute: mPlane)

Returns:

a new Plane

setHalfExtent

public void setHalfExtent(float halfExtent)

Alter the plane's extent. (native attribute: mHalfExtent)

Parameters:

halfExtent - one-half of the desired extent

setMaterial

public void setMaterial(ConstPhysicsMaterial material)

Replace the material. (native attribute: mMaterial)

Parameters:

material - the desired material, or null if none (default=null)

setPlane

public void setPlane(ConstPlane plane)

Alter the surface equation. (native attribute: mPlane)

Parameters:

plane - the desired surface (not null, unaffected, default=((0,0,0),0))