Module de.fabmax.physxjni

Package physx.common

Class PxPlane

java.lang.Object

physx.NativeObject

physx.common.PxPlane

public class PxPlane
extends NativeObject

Representation of a plane.

Plane equation used: n.dot(v) + d = 0

Nested Class Summary

Nested classes/interfaces inherited from class physx.NativeObject

NativeObject.Allocator<T>

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF
static final int	SIZEOF

Fields inherited from class physx.NativeObject

address, isExternallyAllocated, SIZEOF_BYTE, SIZEOF_DOUBLE, SIZEOF_FLOAT, SIZEOF_INT, SIZEOF_LONG, SIZEOF_POINTER, SIZEOF_SHORT

Constructor Summary

Constructors

Modifier	Constructor	Description
	PxPlane()	Constructor
	PxPlane(float nx, float ny, float nz, float distance)	Constructor from a normal and a distance
protected	PxPlane(long address)
	PxPlane(PxVec3 normal, float distance)	Constructor from a normal and a distance
	PxPlane(PxVec3 point, PxVec3 normal)	Constructor from a normal and a distance
	PxPlane(PxVec3 p0, PxVec3 p1, PxVec3 p2)	Constructor from three points

Method Summary

Modifier and Type	Method	Description
static PxPlane	arrayGet(long baseAddress, int index)
boolean	contains(PxVec3 p)
static PxPlane	createAt(long address)
static PxPlane	createAt(long address, float nx, float ny, float nz, float distance)
static PxPlane	createAt(long address, PxVec3 normal, float distance)
static PxPlane	createAt(long address, PxVec3 point, PxVec3 normal)
static PxPlane	createAt(long address, PxVec3 p0, PxVec3 p1, PxVec3 p2)
static <T> PxPlane	createAt(T allocator, NativeObject.Allocator<T> allocate)
static <T> PxPlane	createAt(T allocator, NativeObject.Allocator<T> allocate, float nx, float ny, float nz, float distance)
static <T> PxPlane	createAt(T allocator, NativeObject.Allocator<T> allocate, PxVec3 normal, float distance)
static <T> PxPlane	createAt(T allocator, NativeObject.Allocator<T> allocate, PxVec3 point, PxVec3 normal)
static <T> PxPlane	createAt(T allocator, NativeObject.Allocator<T> allocate, PxVec3 p0, PxVec3 p1, PxVec3 p2)
void	destroy()
float	distance(PxVec3 p)
float	getD()	The distance from the origin
PxVec3	getN()	The normal to the plane
PxPlane	inverseTransform(PxTransform pose)	inverse-transform plane
void	normalize()	equivalent plane with unit normal
PxVec3	pointInPlane()	find an arbitrary point in the plane
PxVec3	project(PxVec3 p)	projects p into the plane
void	setD(float value)	The distance from the origin
void	setN(PxVec3 value)	The normal to the plane
PxPlane	transform(PxTransform pose)	transform plane
static PxPlane	wrapPointer(long address)

Methods inherited from class physx.NativeObject

checkNotNull, equals, getAddress, hashCode

Methods inherited from class java.lang.Object

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

Field Details

SIZEOF

public static final int SIZEOF

ALIGNOF

public static final int ALIGNOF

See Also:

• Constant Field Values

Constructor Details

PxPlane

protected PxPlane(long address)

PxPlane

public PxPlane()

Constructor

PxPlane

public PxPlane(float nx,
 float ny,
 float nz,
 float distance)

Constructor from a normal and a distance

PxPlane

public PxPlane(PxVec3 normal,
 float distance)

Constructor from a normal and a distance

PxPlane

public PxPlane(PxVec3 p0,
 PxVec3 p1,
 PxVec3 p2)

Constructor from three points

PxPlane

public PxPlane(PxVec3 point,
 PxVec3 normal)

Constructor from a normal and a distance

Method Details

wrapPointer

public static PxPlane wrapPointer(long address)

arrayGet

public static PxPlane arrayGet(long baseAddress,
 int index)

createAt

public static PxPlane createAt(long address)

Parameters:

address - Pre-allocated memory, where the object is created.

Returns:

Stack allocated object of PxPlane

createAt

public static <T> PxPlane createAt(T allocator,
 NativeObject.Allocator<T> allocate)

Type Parameters:

T - Allocator class, e.g. LWJGL's MemoryStack.

Parameters:

allocator - Object to use for allocation, e.g. an instance of LWJGL's MemoryStack.

allocate - Method to call on allocator to obtain the target address, e.g. MemoryStack::nmalloc.

Returns:

Stack allocated object of PxPlane

createAt

public static PxPlane createAt(long address,
 float nx,
 float ny,
 float nz,
 float distance)

Parameters:

address - Pre-allocated memory, where the object is created.

nx - WebIDL type: float

ny - WebIDL type: float

nz - WebIDL type: float

distance - WebIDL type: float

Returns:

Stack allocated object of PxPlane

createAt

public static <T> PxPlane createAt(T allocator,
 NativeObject.Allocator<T> allocate,
 float nx,
 float ny,
 float nz,
 float distance)

Type Parameters:

T - Allocator class, e.g. LWJGL's MemoryStack.

Parameters:

allocator - Object to use for allocation, e.g. an instance of LWJGL's MemoryStack.

allocate - Method to call on allocator to obtain the target address, e.g. MemoryStack::nmalloc.

nx - WebIDL type: float

ny - WebIDL type: float

nz - WebIDL type: float

distance - WebIDL type: float

Returns:

Stack allocated object of PxPlane

createAt

public static PxPlane createAt(long address,
 PxVec3 normal,
 float distance)

Parameters:

address - Pre-allocated memory, where the object is created.

normal - WebIDL type: PxVec3 [Const, Ref]

distance - WebIDL type: float

Returns:

Stack allocated object of PxPlane

createAt

public static <T> PxPlane createAt(T allocator,
 NativeObject.Allocator<T> allocate,
 PxVec3 normal,
 float distance)

Type Parameters:

T - Allocator class, e.g. LWJGL's MemoryStack.

Parameters:

allocator - Object to use for allocation, e.g. an instance of LWJGL's MemoryStack.

allocate - Method to call on allocator to obtain the target address, e.g. MemoryStack::nmalloc.

normal - WebIDL type: PxVec3 [Const, Ref]

distance - WebIDL type: float

Returns:

Stack allocated object of PxPlane

createAt

public static PxPlane createAt(long address,
 PxVec3 p0,
 PxVec3 p1,
 PxVec3 p2)

Parameters:

address - Pre-allocated memory, where the object is created.

p0 - WebIDL type: PxVec3 [Const, Ref]

p1 - WebIDL type: PxVec3 [Const, Ref]

p2 - WebIDL type: PxVec3 [Const, Ref]

Returns:

Stack allocated object of PxPlane

createAt

public static <T> PxPlane createAt(T allocator,
 NativeObject.Allocator<T> allocate,
 PxVec3 p0,
 PxVec3 p1,
 PxVec3 p2)

Type Parameters:

T - Allocator class, e.g. LWJGL's MemoryStack.

Parameters:

allocator - Object to use for allocation, e.g. an instance of LWJGL's MemoryStack.

allocate - Method to call on allocator to obtain the target address, e.g. MemoryStack::nmalloc.

p0 - WebIDL type: PxVec3 [Const, Ref]

p1 - WebIDL type: PxVec3 [Const, Ref]

p2 - WebIDL type: PxVec3 [Const, Ref]

Returns:

Stack allocated object of PxPlane

createAt

public static PxPlane createAt(long address,
 PxVec3 point,
 PxVec3 normal)

Parameters:

address - Pre-allocated memory, where the object is created.

point - WebIDL type: PxVec3 [Const, Ref]

normal - WebIDL type: PxVec3 [Const, Ref]

Returns:

Stack allocated object of PxPlane

createAt

public static <T> PxPlane createAt(T allocator,
 NativeObject.Allocator<T> allocate,
 PxVec3 point,
 PxVec3 normal)

Type Parameters:

T - Allocator class, e.g. LWJGL's MemoryStack.

Parameters:

allocator - Object to use for allocation, e.g. an instance of LWJGL's MemoryStack.

allocate - Method to call on allocator to obtain the target address, e.g. MemoryStack::nmalloc.

point - WebIDL type: PxVec3 [Const, Ref]

normal - WebIDL type: PxVec3 [Const, Ref]

Returns:

Stack allocated object of PxPlane

destroy

public void destroy()

getN

public PxVec3 getN()

The normal to the plane

setN

public void setN(PxVec3 value)

The normal to the plane

getD

public float getD()

The distance from the origin

setD

public void setD(float value)

The distance from the origin

distance

public float distance(PxVec3 p)

Parameters:

p - WebIDL type: PxVec3 [Const, Ref]

Returns:

WebIDL type: float

contains

public boolean contains(PxVec3 p)

Parameters:

p - WebIDL type: PxVec3 [Const, Ref]

Returns:

WebIDL type: boolean

project

public PxVec3 project(PxVec3 p)

projects p into the plane

pointInPlane

public PxVec3 pointInPlane()

find an arbitrary point in the plane

normalize

public void normalize()

equivalent plane with unit normal

transform

public PxPlane transform(PxTransform pose)

transform plane

inverseTransform

public PxPlane inverseTransform(PxTransform pose)

inverse-transform plane