TerrainMaterial

Description

sealed class Tinman.Engine.Components.TerrainMaterial

Describes a terrain material for texturing.

Public / Constructors

For

2 overloads

[Pure]
public static method For1 → (3)

materialId in : int32

[0..255]
The material ID.

color opt : int64 = Colors.White

Optional material color key (see MaterialKey.Color.

name opt : string = null

Human-readable name of this terrain material.

returns → TerrainMaterial

The TerrainMaterial object.

Creates a new instance of TerrainMaterial.

[Pure]
public static method For2 → (2)

material in : MaterialKey

The material key.

name opt : string = null

Human-readable name of this terrain material.

returns → TerrainMaterial

The TerrainMaterial object.

Creates a new instance of TerrainMaterial.

Public / Methods

H

4 overloads

[Pure]
public method H1 → (1)

scale in : Vec2F

The new scale value.

returns → TerrainMaterial

The resulting TerrainMaterial object.

Set the value of ScaleHorizontal.

[Pure]
public method H2 → (1)

blend in : TerrainMaterialBlend

The new blend value.

returns → TerrainMaterial

The resulting TerrainMaterial object.

Set the value of BlendHorizontal.

[Pure]
public method H3 → (1)

texture in : TerrainMaterialTexture

[not-null]
The new texture value.

returns → TerrainMaterial

The resulting TerrainMaterial object.

Set the value of Horizontal.

public method H4 → (3)

texture in : TerrainMaterialTexture

[not-null]
The new texture value.

scale in : Vec2F

The new scale value.

blend in : TerrainMaterialBlend

The new blend value.

returns → TerrainMaterial

The resulting TerrainMaterial object.

Set the value of Horizontal, ScaleHorizontal and BlendHorizontal.

V

4 overloads

[Pure]
public method V1 → (1)

scale in : Vec2F

The new scale value.

returns → TerrainMaterial

The resulting TerrainMaterial object.

Set the value of ScaleVertical.

[Pure]
public method V2 → (1)

blend in : TerrainMaterialBlend

The new blend value.

returns → TerrainMaterial

The resulting TerrainMaterial object.

Set the value of BlendVertical.

[Pure]
public method V3 → (1)

texture in : TerrainMaterialTexture

[not-null]
The new texture value.

returns → TerrainMaterial

The resulting TerrainMaterial object.

Set the value of Vertical.

public method V4 → (3)

texture in : TerrainMaterialTexture

[not-null]
The new texture value.

scale in : Vec2F

The new scale value.

blend in : TerrainMaterialBlend

The new blend value.

returns → TerrainMaterial

The resulting TerrainMaterial object.

Set the value of Vertical, ScaleVertical and BlendVertical.

Public / Attributes

Blend​Horizontal

public readonly attribute BlendHorizontal → (TerrainMaterialBlend)

Material color blend for Horizontal.

Blend​Vertical

public readonly attribute BlendVertical → (TerrainMaterialBlend)

Material color blend for Vertical.

Horizontal

public readonly attribute Horizontal → (TerrainMaterialTexture)

The horizontal terrain texture.

Key

public readonly attribute Key → (MaterialKey)

The material key.

The material key is used to extract material weights from the HeightmapLayer.Texture layer.

Name

public readonly attribute Name → (string)

Human-readable name of this terrain material or null if none.

Placeholder

public readonly attribute Placeholder → (IModelTexture)

A placeholder texture using the material key color (see MaterialKey.Color).

Scale​Horizontal

public readonly attribute ScaleHorizontal → (Vec2F)

Artificial scale factors to apply to the texture and displacement scales of Horizontal.

Vec2F.X artificially scales TerrainMaterialTexture.ScaleTexture.
Vec2F.Y artificially scales TerrainMaterialTexture.ScaleDisplacement.

Scale​Vertical

public readonly attribute ScaleVertical → (Vec2F)

Artificial scale factors to apply to the texture and displacement scales of Vertical.

Vec2F.X artificially scales TerrainMaterialTexture.ScaleTexture.
Vec2F.Y artificially scales TerrainMaterialTexture.ScaleDisplacement.

Vertical

public readonly attribute Vertical → (TerrainMaterialTexture)

The vertical terrain texture (for triplanar mapping) or null (for standard UV-mapping).