build2DTileMeshWithGround

previous: iMeshFederation::build2DTileMesh()

next: iMeshFederation::build2DTiledGround()

Contents, API Reference, Interfaces, iMeshFederation, build2DTileMeshWithGround

iMeshFederation::build2DTileMeshWithGround()

Description

Generates an iMesh object with simple 2D square bounds for the specified tile in this federation (instanced ground version).

Syntax

std::unique_ptr<iMesh> build2DTileMeshWithGround(const iGround& ground, int32_t tileIndex, const char *const* options) const

Parameters

ground

The ground for the mesh. Only ground built by calling iMeshFederation::build2DTiledGround() on this federation should be used here.

tileIndex

The index of the federation tile for which a mesh is being built.

options

A set of named attributes to control how the mesh is built.

Refer to Handling Attributes for information about passing sets of named attributes.

See mesh loading options for options that may be passed into this method.

Return Value

A newly created Interface iMesh object constructed to serve as the federation tile mesh for the federation tile with the specified index.

Remarks

If you are using simple tiled ground meshes then you can use iMeshFederation::build2DTiledGround() in combination with this method to replace calls to iMeshFederation::build2DTileMesh() to get 'instancing' of the ground portion of your meshes, with potentially significant reductions in memory footprint.

C# Mapping

Mesh build2DTileMeshWithGround(Ground ground, int tileIndex, string[] options);

next: iMeshFederation::build2DTiledGround()