Adds a new collision convex.

A collision convex is defined as the intersection of planes.

Parameters:

[in]

mask

The bitmask of the planes that make up the convex.

Adds a collision plane.

Parameters:

[in]

plane

New collision plane.

Note:

Planes are not used for collision until they are added to a convex object, see addCollisionConvex().

A maximum of 32 planes are supported.

Assign current to previous positions for collision shapes, motion constraints, and separation constraints.

This allows to prevent false interpolation after leaping to an animation frame, for example. After calling clearInterpolation(), the current positions will be used without interpolation. New positions can be set afterwards to interpolate to by the end of the next frame.

Returns cloth flags.

Returns:

Cloth flags.

Retrieves the collision shapes.

Returns collision spheres, capsules, convexes, and triangles that were added through the addCollision*() methods and modified through the setCollision*() methods.

Parameters:

[out]	sphereBuffer	Spheres destination buffer, must be the same length as getNbCollisionSpheres().
[out]	pairIndexBuffer	Capsules destination buffer, must be the same length as 2*getNbCollisionSpherePairs().
[out]	planesBuffer	Planes destination buffer, must be the same length as getNbCollisionPlanes().
[out]	convexMaskBuffer	Convexes destination buffer, must be the same length as getNbCollisionConvexes().

Note:

Returns the positions at the end of the next simulate() call as specified by the setCollision*() methods.

Returns the mass-scaling coefficient.

Returns:

Mass-scaling coefficient.

returns string name of dynamic type.

Returns:

class name of most derived type of this object.

Reimplemented from PxSerializable.

Returns the damping coefficient.

Returns:

Damping coefficient.

Returns the drag coefficient.

Returns:

Drag coefficient.

Returns external acceleration.

Returns:

External acceleration in global coordinates.

Returns a pointer to the corresponding cloth fabric.

Returns:

The associated cloth fabric.

Returns the friction coefficient.

Returns:

Friction coefficient.

Returns global pose.

Returns:

Global pose as specified by the last setGlobalPose() or setTargetPose() call.

Returns acceleration scale parameter.

Returns:

Acceleration scale parameter.

Copies motion constraints to the user provided buffer.

Parameters:

[out]

motionConstraintBuffer

Destination buffer, must be at least getNbMotionConstraints().

Returns:

True if the copy was successful.

Reads back scale and bias factor for motion constraints.

See also:

setMotionConstraintScaleBias()

Returns the number of collision convexes.

Returns:

Number of collision convexes.

Returns the number of collision planes.

Returns:

Number of collision planes.

Returns the number of collision capsules.

Returns:

Number of collision capsules.

Returns the number of collision spheres.

Returns:

Number of collision spheres.

Returns the number of motion constraints.

Returns:

Number of motion constraints (same as getNbPartices() if enabled, 0 otherwise).

Returns the number of particle accelerations.

Returns:

Number of particle accelerations (same as getNbPartices() if enabled, 0 otherwise).

Returns the number of particles.

Returns:

Number of particles.

Returns the number of separation constraints.

Returns:

Number of separation constraints (same as getNbPartices() if enabled, 0 otherwise).

Returns the number of virtual particles.

Returns:

Number of virtual particles.

Returns the number of the virtual particle weights.

Returns:

Number of virtual particle weights.

Copies particle accelerations to the user provided buffer.

Parameters:

[out]

particleAccelerationsBuffer

Destination buffer, must be at least getNbParticleAccelerations().

Returns:

true if the copy was successful.

Reads solver configuration for specified phase type.

Parameters:

[in]

phaseType

Which phase to return the configuration for.

Returns:

solver configuration (see PxClothPhaseSolverConfig)

Note:

If phaseType is invalid, the returned solver configuration's solverType member will become eINVALID.

Returns previous time step size.

Time between sampling of previous and current particle positions for computing particle velocity.

Returns:

Previous time step size.

Copies separation constraints to the user provided buffer.

Parameters:

[out]

separationConstraintBuffer

Destination buffer, must be at least getNbSeparationConstraints().

Returns:

True if the copy was successful.

Returns the velocity threshold for putting cloth in sleep state.

Returns:

Velocity threshold for putting cloth in sleep state.

Returns solver frequency.

Returns:

Solver frequency.

Copies index array of virtual particles to the user provided buffer.

Parameters:

[out]

userTriangleVertexAndWeightIndices

Destination buffer, must be at least 4*getNbVirtualParticles().

See also:

setVirtualParticles()

Copies weight table of virtual particles to the user provided buffer.

Parameters:

[out]

userTriangleVertexWeightTable

Destination buffer, must be at least getNbVirtualParticleWeights().

Returns world space bounding box.

Returns:

Particle bounds in global coordinates.

Implements PxActor.

Reimplemented from PxActor.

References PxActor::isKindOf().

Returns true if cloth is in sleep state.

Returns:

True if cloth is in sleep state.

Locks the cloth solver so that external applications can safely read back particle data.

Returns:

See PxClothReadData for available user data for read back.

Forces cloth to be put in sleep state.

Deletes the actor.

Do not keep a reference to the deleted instance.

Sleeping: If this is a PxRigidDynamic, this call will awaken any sleeping actors contacting the deleted actor (directly or indirectly).

If the actor belongs to a PxAggregate object, it is automatically removed from the aggregate.

See also:

PxScene::createRigidStatic(), PxScene::createRigidDynamic(), PxScene::createParticleSystem(), PxScene::createParticleFluid(), PxAggregate

Implements PxActor.

Removes a collision convex.

Parameters:

[in]

index

Index of convex to remove.

Note:

The indices of convexes added after index are decremented by 1.

Planes referenced by this convex will not be removed.

Removes a collision plane.

Parameters:

[in]

index

Index of plane to remove.

Note:

The indices of planes added after index are decremented by 1.

Convexes that reference the plane will have the plane removed from their mask. If after removal a convex consists of zero planes, it will also be removed.

Sets cloth flags (e.g. use GPU or not, use CCD or not).

Parameters:

[in]	flag	Mask of which flags to set.
[in]	value	Value to set flags to.

Sets the collision mass scaling coefficient.

During collision it is possible to artificially increase the mass of a colliding particle, this has an effect comparable to making constraints attached to the particle stiffer and can help reduce stretching and interpenetration around collision shapes.

Parameters:

[in]

scalingCoefficient

Unitless multiplier that can take on values > 1 (default: 0.0).

Updates positions of collision planes.

Parameters:

[in]

planesBuffer

New plane positions by the end of the next simulate() call.

See also:

clearInterpolation()

Updates location and radii of collision spheres.

Parameters:

[in]

sphereBuffer

New sphere positions and radii by the end of the next simulate() call.

Note:

A maximum of 32 spheres are supported.

See also:

clearInterpolation()

Sets the damping coefficient.

The damping coefficient is the portion of local particle velocity that is canceled in 1/10 sec.

Parameters:

[in]

dampingCoefficient

New damping coefficient between 0.0 and 1.0 (default: 0.0).

Sets the drag coefficient.

The drag coefficient is the portion of the pose velocity that is applied to each particle in 1/10 sec.

Parameters:

[in]

dragCoefficient

New drag coefficient between 0.0f and 1.0 (default: 0.0).

Note:

The drag coefficient shouldn't be set higher than the damping coefficient.

Sets external particle accelerations.

Parameters:

[in]

acceleration

New acceleration in global coordinates (default: 0.0).

Note:

Use this to implement simple wind etc.

Sets the collision friction coefficient.

Parameters:

[in]

frictionCoefficient

New friction coefficient between 0.0 and 1.0 (default: 0.0).

Note:

Currently only spheres and capsules impose friction on the colliding particles.

Sets global pose.

Use this to reset the pose (e.g. teleporting).

Parameters:

[in]

pose

New global pose.

Note:

No pose interpolation is performed.

Inertia is not preserved.

See also:

setTargetPose() for inertia preserving method.

Sets the acceleration scale factor to adjust inertia effect from global pose changes.

Parameters:

[in]

scale

New scale factor between 0.0 (no inertia) and 1.0 (full inertia) (default: 1.0).

Note:

A value of 0.0 disables all inertia effects of accelerations applied through setTargetPos().

See also:

setTargetPose()

Updates motion constraints (position and radius of the constraint sphere).

Parameters:

[in]

motionConstraints

motion constraints at the end of the next simulate() call.

Note:

The motionConstraints must either be null to disable motion constraints, or be the same length as the number of particles, see getNbParticles().

See also:

clearInterpolation()

Specifies motion constraint scale and bias.

Parameters:

[in]	scale	Global scale multiplied to the radius of every motion constraint sphere (default = 1.0).
[in]	bias	Global bias added to the radius of every motion constraint sphere (default = 0.0).

Updates particle accelerations, w component is ignored.

Parameters:

[in]

particleAccelerations

New particle accelerations.

Note:

The particleAccelerations must either be null to disable accelerations, or be the same length as the number of particles, see getNbParticles().

Updates cloth particle location or inverse weight for current and previous particle state.

Parameters:

[in]	currentParticles	The particle data for the current particle state or NULL if the state should not be changed.
[in]	previousParticles	The particle data for the previous particle state or NULL if the state should not be changed.

Note:

The invWeight stored in currentParticles is the new particle inverse mass, or zero for a static particle. However, the invWeight stored in previousParticles is still used once for the next particle integration and fabric solve.

If currentParticles or previousParticles are non-NULL then they must be the length specified by getNbParticles().

This can be used to teleport particles (use same positions for current and previous).

See also:

PxClothParticle

Sets solver configuration per phase type.

Users can assign different solver configuration (solver type, stiffness, etc.) per each phase type (see PxClothFabricPhaseType).

Parameters:

[in]	phaseType	Which phases to change the configuration for.
[in]	config	What configuration to change it to.

Updates separation constraints (position and radius of the constraint sphere).

Parameters:

[in]

separationConstraints

separation constraints at the end of the next simulate() call.

Note:

The separationConstraints must either be null to disable separation constraints, or be the same length as the number of particles, see getNbParticles().

See also:

clearInterpolation()

Sets the velocity threshold for putting cloth in sleep state.

If none of the particles moves faster (in local space) than the threshold for a while, the cloth will be put in sleep state and simulation will be skipped.

Parameters:

[in]

threshold

Velocity threshold (default: 0.0f)

Sets the solver frequency parameter.

Solver frequency specifies how often the simulation step is computed per second. For example, a value of 60 represents one simulation step per frame in a 60fps scene. A value of 120 will represent two simulation steps per frame, etc.

Parameters:

[in]

frequency

Solver frequency per second.

Sets target pose.

This function will move the cloth in world space. The resulting simulation may reflect inertia effect as a result of pose acceleration.

Parameters:

[in]

pose

Target pose at the end of the next simulate() call.

See also:

setGlobalPose() to move Cloth without inertia effect.

Assigns virtual particles.

Virtual particles provide more robust and accurate collision handling against collision spheres and capsules. More virtual particles will generally increase the accuracy of collision handling, and thus a sufficient number of virtual particles can mimic triangle-based collision handling.
Virtual particles are specified as barycentric interpolation of real particles: The position of a virtual particle is w0 * P0 + w1 * P1 + w2 * P2, where P1, P2, P3 real particle positions. The barycentric weights w0, w1, w2 are stored in a separate table so they can be shared across multiple virtual particles.

Parameters:

[in]	numParticles	total number of virtual particles.
[in]	triangleVertexAndWeightIndices	Each virtual particle has four indices, the first three for real particle indices, and the last for the weight table index. Thus, the length of indices needs to be 4*numVirtualParticles.
[in]	weightTableSize	total number of unique weights triples.
[in]	triangleVertexWeightTable	array for barycentric weights.

Note:

Virtual particles only incur a runtime cost during the collision stage. Still, it is advisable to only use virtual particles for areas where high collision accuracy is desired. (e.g. sleeve around very thin wrist).

Forces cloth to wake up from sleep state.

The wakeCounterValue determines how long all particles need to move less than the velocity threshold until the cloth is put to sleep.

Parameters:

[in]

wakeCounterValue

New wake counter value (range: [0, inf]).