Table of Contents

Class Bepu3DPhysicsOptions

Namespace
Stride.CommunityToolkit.Bepu
Assembly
Stride.CommunityToolkit.Bepu.dll

Provides options for creating a 3D primitive entity with Bepu physics.

public class Bepu3DPhysicsOptions : Primitive3DEntityOptions
Inheritance
Bepu3DPhysicsOptions
Inherited Members

Remarks

Extends Primitive3DEntityOptions with a configurable Bepu CollidableComponent.

When Component is left null, the creation helper that consumes the options picks a context-appropriate default: a dynamic BodyComponent for primitives, a StaticComponent for ground helpers.

When collider generation is enabled, creation helpers populate the collider with shapes that match the selected primitive type.

Properties

Component

Gets or sets the Bepu collidable component attached to the entity.

public CollidableComponent? Component { get; set; }

Property Value

CollidableComponent

Remarks

When null (the default), the consuming helper chooses: primitive creation attaches a dynamic BodyComponent with an empty CompoundCollider, while ground helpers attach a StaticComponent. Set it explicitly to override either default or to preconfigure collider children.

IncludeCollider

Gets or sets a value indicating whether a collider shape matching the primitive type is created automatically.

public bool IncludeCollider { get; set; }

Property Value

bool

Remarks

Defaults to true. When set to false, the Component is attached without generated collider shapes so they can be added later.