Table of Contents

Class PrimitiveCreationOptions

Namespace
Stride.CommunityToolkit.Engine
Assembly
Stride.CommunityToolkit.dll

Provides options for creating a primitive entity, such as a cube, sphere, or other 3D object. These options allow customization of the entity's name, material, collider inclusion, and render group.

public abstract class PrimitiveCreationOptions
Inheritance
PrimitiveCreationOptions
Derived

Properties

EntityName

Gets or sets the name of the entity. This can be useful for identifying the entity within the scene or debugging purposes.

public string? EntityName { get; set; }

Property Value

string

IncludeCollider

Determines whether to include a collider component in the entity. Defaults to true. A collider is necessary for physics interactions, such as detecting collisions with other entities.

public bool IncludeCollider { get; set; }

Property Value

bool

Material

Gets or sets the material to be applied to the primitive model. The material defines the appearance of the primitive, including its color and texture.

public Material? Material { get; set; }

Property Value

Material

RenderGroup

Gets or sets the render group for the entity. Defaults to Group0. Render groups allow different entities to be rendered in separate stages or layers, which can be useful for organizing complex scenes or applying different rendering effects.

public RenderGroup RenderGroup { get; set; }

Property Value

RenderGroup