Class PrimitiveEntityOptionsBase

Namespace

Stride.CommunityToolkit.Engine

Assembly

Stride.CommunityToolkit.dll

Provides common, non-physics options used when creating primitive entities.

public abstract class PrimitiveEntityOptionsBase

Inheritance

object

PrimitiveEntityOptionsBase

Derived

Primitive2DEntityOptions

Primitive3DEntityOptions

Remarks

This base type contains rendering, identification, and positioning options shared by 2D and 3D primitive creation helpers.

Physics-specific options are defined by derived types such as Bepu2DPhysicsOptions, Bepu3DPhysicsOptions, Bullet2DPhysicsOptions, and Bullet3DPhysicsOptions.

Properties

EntityName

Gets or sets the optional name assigned to the created entity.

public string? EntityName { get; set; }

Property Value

string

Remarks

If null, the creation helper may assign a name or leave the entity unnamed.

Material

Gets or sets the material to apply to the generated primitive model.

public Material? Material { get; set; }

Property Value

Material

Remarks

If null, the generated model uses the material behavior defined by the creation helper or the engine.

Position

Gets or sets the initial world position applied to the entity's transform.

public Vector3? Position { get; set; }

Property Value

Vector3?

Remarks

If null, the entity keeps the default transform position, Zero.

RenderGroup

Gets or sets the render group assigned to the generated model component.

public RenderGroup RenderGroup { get; set; }

Property Value

RenderGroup

Remarks

Defaults to Group0. Render groups can be used to route entities through different rendering passes or layers.