Adds collected objects to a scene.

This function adds all objects contained in the input collection to the input scene. This is typically used after deserializing the collection, to populate the scene with deserialized objects.

Parameters:

[in]	collection	Objects to add to the scene. See PxCollection
[in]	scene	Scene to which collected objects will be added. See PxScene

See also:

PxCollection PxScene

Creates an aggregate with the specified maximum size and selfCollision property.

Parameters:

[in]	maxSize	the maximum number of actors that may be placed in the aggregate. This value must not exceed 128, otherwise NULL will be returned.
[in]	enableSelfCollision	whether the aggregate supports self-collision

Returns:

The new aggregate.

See also:

PxAggregate

Creates an articulation with all fields initialized to their default values.

Returns:

the new articulation

See also:

PxRigidDynamic

Creates a cloth.

Parameters:

	globalPose	The world space transform of the cloth.
	fabric	The fabric the cloth should use.
	particles	Particle definition buffer. The size of the buffer has to match the number of points of the cloth mesh which elements must match with the provided
	collData	Collision information.
	flags	Cloth flags.

Returns:

The new cloth.

See also:

PxCloth PxClothFabric PxClothCollisionData PxClothFlags

Creates a cloth fabric object from particle connectivity and restlength information.

This can then be instanced into PxCloth objects.

Note:

We recommended using PxCooking.cookClothFabric() to create cloth fabrics from meshes and then using createClothFabric(const PxInputStream& stream). This method should only be used if you need to provide fully customized particle fiber/connectivity information for your fabric or if you did custom cloth fabric serialization and want to deserialize.

Parameters:

[in]	nbParticles	the number of particles needed when creating a PxCloth instance from the fabric.
[in]	nbPhases	the number of solver phases.
[in]	phases	array defining which set to use for each phase. See PxClothFabric.getPhases().
[in]	phaseTypes	array defining the type of each phase. See PxClothFabricPhaseType.
[in]	nbRestvalues	the number of rest values
[in]	restvalues	array of rest values for each constraint. See PxClothFabric.getRestvalues().
[in]	nbSets	number of sets in the fabric.
[in]	sets	array with an index per set which points one entry beyond the last fiber of the set. See PxClothFabric.getSets().
[in]	fibers	array with an index per fiber which points one entry beyond the last particle index of the fiber. See PxClothFabric.getFibers().
[in]	indices	array of particle indices which specifies the line strips of connected particles of a fiber. See PxClothFabric.getParticleIndices().

Returns:

The new cloth fabric.

See also:

PxClothFabric PxClothFabric.release() PxCloth

Creates a cloth fabric object.

This can then be instanced into PxCloth objects.

Parameters:

[in]

stream

The stream to load the cloth fabric from.

Returns:

The new cloth fabric.

See also:

PxClothFabric PxClothFabric.release() PxInputStream PxCloth

Creates a collection object.

Objects can only be serialized or deserialized through a collection. For serialization, users must add objects to the collection and serialize the collection as a whole. For deserialization, the system gives back a collection of deserialized objects to users.

Returns:

The new collection object.

See also:

PxCollection::release()

Creates a constraint shader.

Note:

A constraint shader will get added automatically to the scene the two linked actors belong to. Either, but not both, of actor0 and actor1 may be NULL to denote attachment to the world.

Parameters:

[in]	actor0	the first actor
[in]	actor1	the second actor
[in]	connector	the connector object, which the SDK uses to communicate with the infrastructure for the constraint
[in]	shaders	the shader functions for the constraint
[in]	dataSize	the size of the data block for the shader

Returns:

The new shader.

Creates a convex mesh object.

This can then be instanced into PxShape objects.

Parameters:

[in]

stream

The stream to load the convex mesh from.

Returns:

The new convex mesh.

See also:

PxConvexMesh PxConvexMesh.release() PxInputStream createTriangleMesh() PxConvexMeshGeometry PxShape

Creates a PxHeightField object.

This can then be instanced into PxShape objects.

Parameters:

[in]

heightFieldDesc

The descriptor to load the object from.

Returns:

The new height field object.

See also:

PxHeightField PxHeightField.release() PxHeightFieldDesc PxHeightFieldGeometry PxShape

Creates a new material with default properties.

Returns:

The new material.

Parameters:

	staticFriction	the coefficient of static friction
	dynamicFriction	the coefficient of dynamic friction
	restitution	the coefficient of restitution

See also:

PxMaterial

Creates a particle fluid.

Parameters:

	maxParticles	the maximum number of particles that may be placed in the particle fluid
	perParticleRestOffset	whether the ParticleFluid supports perParticleRestOffset

Returns:

The new particle fluid.

Creates a particle system.

Parameters:

	maxParticles	the maximum number of particles that may be placed in the particle system
	perParticleRestOffset	whether the ParticleSystem supports perParticleRestOffset

Returns:

The new particle system.

Creates a dynamic rigid actor with the specified pose and all other fields initialized to their default values.

Parameters:

[in]

pose

the initial pose of the actor. Must be a valid transform

See also:

PxRigidDynamic

Creates a static rigid actor with the specified pose and all other fields initialized to their default values.

Parameters:

[in]

pose

the initial pose of the actor. Must be a valid transform

See also:

PxRigidStatic

Creates a scene.

The scene can then create its contained entities.

Parameters:

[in]

sceneDesc

Scene descriptor. See PxSceneDesc

Returns:

The new scene object.

See also:

PxScene PxScene.release() PxSceneDesc

Creates a triangle mesh object.

This can then be instanced into PxShape objects.

Parameters:

[in]

stream

The triangle mesh stream.

Returns:

The new triangle mesh.

See also:

PxTriangleMesh PxTriangleMesh.release() PxInputStream

Creates a user references object.

User references are needed when a collection contains external references, either to another collection (when serializing subsets) or to user objects.

See also:

PxUserReferences::release() PxUserReferences

Writes the array of cloth fabrics to a user buffer.

Returns the number of pointers written.

The ordering of the cloth fabrics in the array is not specified.

Parameters:

[out]	userBuffer	The buffer to receive cloth fabric pointers.
[in]	bufferSize	The number of cloth fabric pointers which can be stored in the buffer.

Returns:

The number of cloth fabric pointers written to userBuffer, this should be less or equal to bufferSize.

See also:

getNbClothFabrics() PxClothFabric

Writes the array of convex mesh pointers to a user buffer.

Returns the number of pointers written.

The ordering of the convex meshes in the array is not specified.

Parameters:

[out]	userBuffer	The buffer to receive convex mesh pointers.
[in]	bufferSize	The number of convex mesh pointers which can be stored in the buffer.
[in]	startIndex	Index of first convex mesh pointer to be retrieved

Returns:

The number of convex mesh pointers written to userBuffer, this should be less or equal to bufferSize.

See also:

getNbConvexMeshes() PxConvexMesh

Retrieves the Foundation instance.

Returns:

A reference to the Foundation object.

Writes the array of heightfield pointers to a user buffer.

Returns the number of pointers written.

The ordering of the heightfields in the array is not specified.

Parameters:

[out]	userBuffer	The buffer to receive heightfield pointers.
[in]	bufferSize	The number of heightfield pointers which can be stored in the buffer.
[in]	startIndex	Index of first heightfield pointer to be retrieved

Returns:

The number of heightfield pointers written to userBuffer, this should be less or equal to bufferSize.

See also:

getNbHeightFields() PxHeightField

Writes the array of material pointers to a user buffer.

Returns the number of pointers written.

The ordering of the materials in the array is not specified.

Parameters:

[out]	userBuffer	The buffer to receive material pointers.
[in]	bufferSize	The number of material pointers which can be stored in the buffer.
[in]	startIndex	Index of first material pointer to be retrieved

Returns:

The number of material pointers written to userBuffer, this should be less or equal to bufferSize.

See also:

getNbMaterials() PxMaterial

Return the number of cloth fabrics that currently exist.

Returns:

Number of cloth fabrics.

See also:

getClothFabrics()

Return the number of convex meshes that currently exist.

Returns:

Number of convex meshes.

See also:

getConvexMeshes()

Return the number of heightfields that currently exist.

Returns:

Number of heightfields.

See also:

getHeightFields()

Return the number of materials that currently exist.

Returns:

Number of materials.

See also:

getMaterials()

Gets number of created scenes.

Returns:

The number of scenes created.

See also:

getScene()

Return the number of triangle meshes that currently exist.

Returns:

Number of triangle meshes.

See also:

getTriangleMeshes()

The factory manager allows notifications when a new connection to pvd is made. It also allows the users to specify a scheme to handle the read-side of a network connection. By default, the SDK specifies that a thread gets launched which blocks reading on the network socket.

Returns:

A valid manager *if* the SDK was compiled with PVD support. Null otherwise.

Writes the array of scene pointers to a user buffer.

Returns the number of pointers written.

The ordering of the scene pointers in the array is not specified.

Parameters:

[out]	userBuffer	The buffer to receive scene pointers.
[in]	bufferSize	The number of scene pointers which can be stored in the buffer.
[in]	startIndex	Index of first scene pointer to be retrieved

Returns:

The number of scene pointers written to userBuffer, this should be less or equal to bufferSize.

See also:

getNbScenes() PxScene

Returns the simulation tolerance parameters.

Returns:

The current simulation tolerance parameters.

Writes the array of triangle mesh pointers to a user buffer.

Returns the number of pointers written.

The ordering of the triangle meshes in the array is not specified.

Parameters:

[out]	userBuffer	The buffer to receive triangle mesh pointers.
[in]	bufferSize	The number of triangle mesh pointers which can be stored in the buffer.
[in]	startIndex	Index of first mesh pointer to be retrieved

Returns:

The number of triangle mesh pointers written to userBuffer, this should be less or equal to bufferSize.

See also:

getNbTriangleMeshes() PxTriangleMesh

Retrieves the PhysX Visual Debugger.

Returns:

A pointer to the PxVisualDebugger. Can be NULL if PVD is not supported on this platform.

Destroys the instance it is called on.

Use this release method to destroy an instance of this class. Be sure to not keep a reference to this object after calling release. Avoid release calls while a scene is simulating (in between simulate() and fetchResults() calls).

Note that this must be called once for each prior call to PxCreatePhysics, as there is a reference counter. Also note that you mustn't destroy the allocator or the error callback (if available) until after the reference count reaches 0 and the SDK is actually removed.

Releasing an SDK will also release any scenes, triangle meshes, convex meshes, and heightfields created through it, provided the user hasn't already done so.

See also:

PxCreatePhysics()