Primitives

---

Evergine has a collection of 3D primitives that you can use for prototyping purposes. The primitives are easier and faster to use, making them very useful when you are conducting tests or creating a prototype scene.

Primitive collection:

• Capsule
• Cone
• Cube
• Cylinder
• Plane
• Pyramid
• Sphere
• Teapot
• Torus

The main difference between using primitives and using a Model is that in the case of primitives, the Mesh is generated procedurally instead of being obtained from an asset. This allows you to parameterize the way the mesh is generated.

Create a Primitive from Evergine Studio

From the Entity Hierarchy panel, click on the button and go to the Primitives 3D submenu.

Create a Primitive from Code

To create a primitive, you only need to create an entity with the following components:

protected override void CreateScene()
{
    var assetsService = Application.Current.Container.Resolve<AssetsService>();

    var material = assetsService.Load<Material>(EvergineContent.Materials.DefaultMaterial);

    Entity cubeEntity = new Entity()
        .AddComponent(new Transform3D())
        .AddComponent(new MaterialComponent() { Material = material })
        .AddComponent(new CubeMesh()) // A cube primitive
        .AddComponent(new MeshRenderer());

    this.Managers.EntityManager.Add(cubeEntity);
}

Tip

To create a primitive, you only need to change the CubeMesh component to CapsuleMesh, ConeMesh, CylinderMesh, PlaneMesh, PyramidMesh, SphereMesh, TeapotMesh, or TorusMesh component.

Cube Parameters

The component to create this primitive is CubeMesh.

Parameter	Description
Size	The size of the cube. Must be greater than 0.
UVHorizontalFlip	Indicates whether to flip the horizontal texture coordinate.
UVVerticalFlip	Indicates whether to flip the vertical texture coordinate.
InitialU	The horizontal texture coordinate offset.
InitialV	The vertical texture coordinate offset.
UTile	The horizontal texture coordinate scale factor.
VTile	The vertical texture coordinate scale factor.

Sphere Parameters

The component to create this primitive is SphereMesh.

Parameter	Description
Diameter	The diameter of the sphere. Must be greater than 0.
Tessellation	The tessellation of the sphere. Must be greater than 3.
UVHorizontalFlip	Indicates whether to flip the horizontal texture coordinate.
UVVerticalFlip	Indicates whether to flip the vertical texture coordinate.

Plane Parameters

The component to create this primitive is PlaneMesh.

Parameter	Description
PlaneNormal	The normal of the plane. Available values: XPositive YPositive ZPositive XNegative YNegative ZNegative
Width	The width of the plane. Must be greater than 0.
Height	The height of the plane. Must be greater than 0.
TwoSides	Indicates whether the plane has two sides. By default, the bottom face of the plane is not generated.
UMirror	Indicates whether to flip the horizontal texture coordinate.
VMirror	Indicates whether to flip the vertical texture coordinate.
UOffset	Applies an offset to the horizontal texture coordinates.
VOffset	Applies an offset to the vertical texture coordinates.
UTile	The horizontal texture coordinate scale factor.
VTile	The vertical texture coordinate scale factor.
Origin	Represents the pivot in a normalized position. By default, the value is (0.5, 0.5), which indicates that the PlaneMesh position is measured from the center of the plane.

Teapot Parameters

The component to create this primitive is TeapotMesh.

Parameter	Description
Size	The size of the teapot. Must be greater than 0.
Tessellation	The tessellation of the teapot. Must be greater than 3.

Capsule Parameters

The component to create this primitive is CapsuleMesh.

Parameter	Description
Height	The height of the capsule. Must be greater than 0.
Radius	The radius of the capsule. Must be greater than 0.
Tessellation	The tessellation of the capsule. Must be even.

Cone Parameters

The component to create this primitive is ConeMesh.

Parameter	Description
Height	The height of the cone. Must be greater than 0.
Diameter	The diameter of the cone. Must be greater than 0.
Tessellation	The tessellation of the cone.

Cylinder Parameters

The component to create this primitive is CylinderMesh.

Parameter	Description
Height	The height of the cylinder. Must be greater than 0.
Diameter	The diameter of the cylinder. Must be greater than 0.
Tessellation	The tessellation of the cylinder. Must be greater than 3.

Pyramid Parameters

The component to create this primitive is PyramidMesh.

Parameter	Description
Size	The size of the pyramid. Must be greater than 0.

Torus Parameters

The component to create this primitive is TorusMesh.

Parameter	Description
Diameter	The diameter of the torus. Must be greater than 0.
Thickness	The thickness of the torus. Must be greater than 0.
Tessellation	The tessellation of the torus. Must be greater than 3.