Class CollisionCooking

Physical collision data cooking tools. Allows to bake heightfield, convex and triangle mesh colliders data.

CollisionCooking
Assembly: FlaxEngine.dll
File: Engine/Physics/CollisionCooking.h
Syntax
public class CollisionCooking

Methods

CookCollision(const Argument& arg, CollisionData::SerializedOptions& outputOptions, BytesContainer& outputData)

Cooks the collision from the model and prepares the data for the CollisionData format.

Declaration
public static bool CookCollision(const Argument& arg, CollisionData::SerializedOptions& outputOptions, BytesContainer& outputData)
Parameters
Argument arg

The input argument descriptor.
CollisionData::SerializedOptions outputOptions

The output options container.
BytesContainer outputData

The output data container.
Returns
bool

True if failed, otherwise false.

CookConvexMesh(CookingInput& input, BytesContainer& output)

Attempts to cook a convex mesh from the provided mesh data. Assumes the input data is valid and contains vertex positions. If the method returns false the resulting convex mesh will be in the output parameter.

Declaration
public static bool CookConvexMesh(CookingInput& input, BytesContainer& output)
Parameters
CookingInput input

The input.
BytesContainer output

The output.
Returns
bool

True if failed, otherwise false.

CookHeightField(int32 cols, int32 rows, const PhysicsBackend::HeightFieldSample* data, WriteStream& stream)

Cooks a heightfield. The results are written to the stream. To create a heightfield object there is an option to precompute some of calculations done while loading the heightfield data.

Declaration
public static bool CookHeightField(int32 cols, int32 rows, const PhysicsBackend::HeightFieldSample* data, WriteStream& stream)
Parameters
int32 cols

The heightfield columns count.
int32 rows

The heightfield rows count.
PhysicsBackend::HeightFieldSample data

The heightfield data.
WriteStream stream

The user stream to output the cooked data.
Returns
bool

True if failed, otherwise false.

CookTriangleMesh(CookingInput& input, BytesContainer& output)

Attempts to cook a triangle mesh from the provided mesh data. Assumes the input data is valid and contains vertex positions as well as face indices. If the method returns false the resulting convex mesh will be in the output parameter.

Declaration
public static bool CookTriangleMesh(CookingInput& input, BytesContainer& output)
Parameters
CookingInput input

The input.
BytesContainer output

The output.
Returns
bool

True if failed, otherwise false.