ITerrainEntityContainer

Description

interface Tinman.Engine.Scenes.ITerrainEntityContainer

Derived from

IDisposable

Extended by

IScene
SceneEntity

Base interface for classes that contain terrain entities.

Public / Methods

Terrain​Decal​Add


public method TerrainDecalAdd → (1)

decal in : TerrainDecal

[not-null]
The terrain decal to add.

Adds an aggregated TerrainDecal to this scene entity.

Modifying the state of aTerrainDecal object after is has been added to a scene does not automatically trigger a scene update; the TerrainObjectModified method may be used to make sure that the scene is updated properly, in order to reflect all state changes.

The IVisibleMask.VisibleMask property of decal in will be interpreted according to IEntityViewMask, when determining in which views the given decal in shall be visible.

Terrain​Decal​Remove


public method TerrainDecalRemove → (1)

decal in : TerrainDecal

[not-null]
The terrain decal to remove.

Removes the given aggregated TerrainDecal from this scene entity.

Terrain​Model​Add


public method TerrainModelAdd → (1)

model in : TerrainModel

[not-null]
The terrain model to add.

Adds an aggregated TerrainModel to this scene entity.

Modifying the state of aTerrainModel object after is has been added to a scene does not automatically trigger a scene update; the TerrainObjectModified method may be used to make sure that the scene is updated properly, in order to reflect all state changes.

The IVisibleMask.VisibleMask property of model in will be interpreted according to IEntityViewMask, when determining in which views the given model in shall be visible.

Terrain​Model​Remove


public method TerrainModelRemove → (1)

model in : TerrainModel

[not-null]
The terrain model to remove.

Removes the given aggregated TerrainModel from this scene entity.

Terrain​Object​Modified


public method TerrainObjectModified → ()

This method may be called after the state of a TerrainDecal or TerrainModel terrain entity has been modified, in order make the scene reflect all of these changes.

This method is called implicitly when using one of the following methods:

The same effect as calling this method may be achieved by returning true from IUpdateableFrameTime.UpdateFrameTime or IInputConsumer.ConsumeInput, after modifying the state of a terrain object.