Version:

Mesh

Mesh

You can add the Mesh component to an entity to provide visual geometry on an entity. The Mesh component has key controls and options for Lumberyard’s basic rendering features. The supported geometry type is meshes (.cgf).

Mesh Component Properties

[Mesh component properties in Lumberyard Editor]

The Mesh component has the following properties:


PropertyDescription
VisibleEntity is visible.
Mesh assetSpecifies the asset file for the mesh entity.
Material overrideSpecifies an override material.
OpacityThe entity’s degree of transparency.
Max view distanceMaximum distance from which this entity can be viewed.
View distance multiplierAdjusts the maximum view distance. If set to 1.0, then the default maximum view distance is used. For example, 1.1 extends the default by 10%.
LOD distance ratioSets the level of detail (LOD) ratio over distance.
Cast shadowsCasts shadow maps.
Use VisAreasAllows vis areas to control the component’s visibility.

Advanced

The Mesh component has different advanced properties that depend on whether your mesh is static or dynamic.

  • A mesh is dynamic when the Static property is not set on the Transform component. This is the default setting when you create an entity. Dynamic meshes do not affect nav meshes.
  • A mesh is static when the Static property is set on the Transform component. You can use static objects for more optimal paths during rendering and processing. We recommend that you create static meshes whenever possible. A static mesh can move or deform only when the Receive Wind or Deformable Mesh properties are set.

For more information, see Transform Component Properties.

Advanced Properties for Dynamic Meshes

If your mesh is dynamic, the Mesh component has the following advanced properties.

[Advanced Mesh component properties for a dynamic mesh in Lumberyard Editor]


PropertyDescription
Receive windAffected by wind.
Accept decalsReceives decals.
Deformable meshAllows static mesh assets to deform that have specific dynamic data. For example, you can have a mesh deform asset that is stationary.

Advanced Properties for Static Meshes

If the mesh is static, the Mesh component has the following advanced properties.

[Advanced Mesh component properties for a static mesh in Lumberyard Editor]


PropertyDescription
Rain occluderBlocks or stops dynamic raindrops.
Affect dynamic waterGenerates ripples in dynamic water.
Receive windAffected by wind.
Accept decalsReceives decals.
Affect navmeshAffects navmesh generation.
Visibility occluderBlocks visibility of other objects.
Deformable meshAllows static mesh assets to deform that have specific dynamic data. For example, you can have a mesh deform asset that is stationary.
Affects GIAffects global illumination results.

Note
If you select the Receive wind or Deformable mesh settings, the entity’s Transform component remains Static, but the mesh is considered dynamic.