Module de.fabmax.physxjni

Package physx.extensions

Class PxCollectionExt

java.lang.Object

physx.NativeObject

physx.extensions.PxCollectionExt

public class PxCollectionExt
extends NativeObject

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
protected	PxCollectionExt()
protected	PxCollectionExt(long address)

Method Summary

Modifier and Type	Method	Description
static PxCollectionExt	arrayGet(long baseAddress, int index)
static PxCollection	createCollection(PxScene scene)	Collects all objects from a PxScene.
void	destroy()
static void	releaseObjects(PxCollection collection)	Removes and releases all object from a collection.
static void	releaseObjects(PxCollection collection, boolean releaseExclusiveShapes)	Removes and releases all object from a collection.
static void	remove(PxCollection collection, short concreteType)	Removes objects of a given type from a collection, potentially adding them to another collection.
static void	remove(PxCollection collection, short concreteType, PxCollection to)	Removes objects of a given type from a collection, potentially adding them to another collection.
static PxCollectionExt	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

PxCollectionExt

protected PxCollectionExt()

PxCollectionExt

protected PxCollectionExt(long address)

Method Details

wrapPointer

public static PxCollectionExt wrapPointer(long address)

arrayGet

public static PxCollectionExt arrayGet(long baseAddress,
 int index)

destroy

public void destroy()

releaseObjects

public static void releaseObjects(PxCollection collection)

Removes and releases all object from a collection.

The Collection itself is not released.

If the releaseExclusiveShapes flag is not set to true, release() will not be called on exclusive shapes.

It is assumed that the application holds a reference to each of the objects in the collection, with the exception of objects that are not releasable (PxBase::isReleasable()). In general, objects that violate this assumption need to be removed from the collection prior to calling releaseObjects.

Note: when a shape is created with PxRigidActor::createShape() or PxRigidActorExt::createExclusiveShape(), the only counted reference is held by the actor. If such a shape and its actor are present in the collection, the reference count will be decremented once when the actor is released, and once when the shape is released, resulting in undefined behavior. Shape reference counts can be incremented with PxShape::acquireReference().

Parameters:

collection - to remove and release all object from.

releaseObjects

public static void releaseObjects(PxCollection collection,
 boolean releaseExclusiveShapes)

Removes and releases all object from a collection.

The Collection itself is not released.

If the releaseExclusiveShapes flag is not set to true, release() will not be called on exclusive shapes.

It is assumed that the application holds a reference to each of the objects in the collection, with the exception of objects that are not releasable (PxBase::isReleasable()). In general, objects that violate this assumption need to be removed from the collection prior to calling releaseObjects.

Note: when a shape is created with PxRigidActor::createShape() or PxRigidActorExt::createExclusiveShape(), the only counted reference is held by the actor. If such a shape and its actor are present in the collection, the reference count will be decremented once when the actor is released, and once when the shape is released, resulting in undefined behavior. Shape reference counts can be incremented with PxShape::acquireReference().

Parameters:

collection - to remove and release all object from.

releaseExclusiveShapes - if this parameter is set to false, release() will not be called on exclusive shapes.

remove

public static void remove(PxCollection collection,
 short concreteType)

Removes objects of a given type from a collection, potentially adding them to another collection.

\param[in,out] collection Collection from which objects are removed

Parameters:

concreteType - PxConcreteType of sdk objects that should be removed

remove

public static void remove(PxCollection collection,
 short concreteType,
 PxCollection to)

Removes objects of a given type from a collection, potentially adding them to another collection.

\param[in,out] collection Collection from which objects are removed

Parameters:

concreteType - PxConcreteType of sdk objects that should be removed \param[in,out] to Optional collection to which the removed objects are added

createCollection

public static PxCollection createCollection(PxScene scene)

Collects all objects from a PxScene.

This function creates a new collection from all objects that were added to the specified PxScene. Instances of the following types are included: PxActor, PxAggregate, PxArticulationReducedCoordinate and PxJoint (other PxConstraint types are not included).

This is a helper function to ease the creation of collections for serialization. The function PxSerialization.complete() can be used to complete the collection with required objects prior to serialization.

Parameters:

scene - The PxScene instance from which objects are collected. See #PxScene

Returns:

Collection to which objects are added. See #PxCollection

See Also:

• PxSerialization.complete(physx.common.PxCollection, physx.extensions.PxSerializationRegistry)