Engine.Terrain

Extends

Info

Modifiers

dependson ( LightComponent ) native ( Terrain ) showcategories ( Movement , Collision ) placeable

Copyright 1998-2008 Epic Games, Inc. All Rights Reserved.

Core.Object
|   
+-- Engine.Actor
   |   
   +-- Engine.Info
      |   
      +-- Engine.Terrain

Functions Summary
		CalcLayerBounds ()
		PostBeginPlay ()))

AlphaMaps Source code

Array of the alpha maps between layers

bHeightmapLocked Source code

The terrain heightmap is locked - no editing can take place on it

bLocked Source code

The terrain is locked - no editing can take place on it

bShowingCollision Source code

Viewing collision tessellation level

CachedDisplacements Source code

INTERNAL - Displacement related values

CachedTerrainMaterials[2] Source code

array of cached terrain materials for SM2,SM3

Heights Source code

Array of the terrain heights

InfoData Source code

Array of the terrain information data (visible, etc.)

MaxCollisionDisplacement Source code

NumSectionsX Source code

Internal values used to setup components The number of sections is the number of terrain components along the X and Y of the 'grid'.

NumSectionsY Source code

NumVerticesX Source code

The number of vertices currently stored in a single row of height and alpha data. Updated from NumPatchesX when Allocate is called(usually from PostEditChange).

NumVerticesY Source code

The number of vertices currently stored in a single column of height and alpha data. Updated from NumPatchesY when Allocate is called(usually from PostEditChange).

ReleaseResourcesFence Source code

Command fence used to shut down properly

SectionSize Source code

SelectedVertices Source code

TerrainComponents Source code

The array of terrain components that are used by the terrain

TessellationCheckBorder Source code

The number of components to border around the current view position when checking for tessellations update. If -1, then use the general setting from the engine configuration. If 0, every component will be checked for tessellation changes each frame.

TessellationCheckCount Source code

WeightedMaterials Source code

INTERNAL - The weighted materials and blend maps

WeightedTextureMaps Source code

Collision

bAllowRigidBodyUnderneath Source code

If true, this allows rigid bodies to go underneath visible areas of the terrain. This adds some physics cost.

bBlockRigidBody Source code

If false, primitive does not block rigid body physics. Property is propagated to terrain components.

CollisionTesselationLevel Source code

The tessellation level to utilize when performing collision checks with non-zero extents.

Lighting

bAcceptsDynamicLights Source code

If false, primitive does not accept dynamic lights, aka lights with HasStaticShadowing() == FALSE Property is propagated to terrain components.

bBilinearFilterLightmapGeneration Source code

If true, the lightmap generation will be performed using the bilinear filtering that all other lightmap generation in the engine uses.

bCastDynamicShadow Source code

If false, primitive does not cast dynamic shadows. Property is propagated to terrain components .

bCastShadow Source code

Whether terrain should cast shadows. Property is propagated to terrain components

bForceDirectLightMap Source code

If true, forces all static lights to use light-maps for direct lighting on the terrain, regardless of the light's UseDirectLightMap property. Property is propagated to terrain components .

bIsOverridingLightResolution Source code

If true, the light/shadow map size is no longer restricted... The size of the light map will be (per component): INT LightMapSizeX = Component->SectionSizeX * StaticLightingResolution + 1; INT LightMapSizeY = Component->SectionSizeY * StaticLightingResolution + 1; So, the maximum size of a light/shadow map for a component will be: MaxMapSizeX = MaxComponentSize * StaticLightingResolution + 1 MaxMapSizeY = MaxComponentSize * StaticLightingResolution + 1 Be careful with the setting of StaticLightingResolution when this mode is enabled. It will be quite easy to run up a massive texture requirement on terrain!

LightingChannels Source code

StaticLightingResolution Source code

The resolution to cache lighting at, in texels/patch. A separate shadow-map is used for each terrain component, which is up to (MaxComponentSize * StaticLightingResolution + 1) pixels on a side. Must be a power of two, 1 <= StaticLightingResolution <= MaxTesselationLevel.

Terrain

bMorphingEnabled Source code

Whether to utilize morping terrain or not

bMorphingGradientsEnabled Source code

Whether to utilize morping gradients or not (bMorphingEnabled must be true for this to matter)

bShowWireframe Source code

Tells the terrain to render in wireframe.

DecoLayers Source code

Array of the decoration layers applied

EditorTessellationLevel Source code

Editor-viewing tessellation level

Layers Source code

Array of the terrain layers applied to the terrain

MaxComponentSize Source code

For rendering and collision, split the terrain into components with a maximum size of (MaxComponentSize,MaxComponentSize) patches. The terrain is split up into rectangular groups of patches called terrain components for rendering. MaxComponentSize is the maximum number of patches in a single row/column of a terrain component. Generally, all components will be MaxComponentSize patches square, but on terrains with a patch resolution which isn't a multiple of MaxComponentSize, there will be some components along the edges which are smaller. This is limited by the MaxTesselationLevel, to prevent the vertex buffer for a fully tessellated component from being > 65536 vertices. For a MaxTesselationLevel of 16, MaxComponentSize is limited to <= 15. For a MaxTesselationLevel of 8, MaxComponentSize is limited to <= 31. PostEditChange clamps this to be >= 1.

MaxTesselationLevel Source code

The maximum number of quads in a single row/column of a tessellated patch. Must be a power of two, 1 <= MaxTesselationLevel <= 16

MinTessellationLevel Source code

The minimum number of quads in a tessellated patch. Must be a power of two, 1 <= MaxTesselationLevel

NormalMapLayer Source code

The index of the layer that supplies the normal map for the whole terrain. If this is -1, the terrain will compile the normal property the old way (all normal maps blended together). If this is a valid index into the layer array, it will compile the normal property only for the material(s) contained in said layer.

NumPatchesX Source code

The number of patches in a single row of the terrain's patch grid. PostEditChange clamps this to be >= 1. Note that if you make this and/or NumPatchesY smaller, it will destroy the height-map/alpha-map data which is no longer used by the patches.If you make the dimensions larger, it simply fills in the new height-map/alpha-map data with zero.

NumPatchesY Source code

The number of patches in a single column of the terrain's patch grid. PostEditChange clamps this to be >= 1.

TesselationDistanceScale Source code

The scale factor to apply to the distance used in determining the tessellation level to utilize when rendering a patch. TessellationLevel = SomeFunction((Patch distance to camera) * TesselationDistanceScale)

TessellationCheckDistance Source code

The radius from the view origin that terrain tessellation checks should be performed. If less than 0, the general setting from the engine configuration will be used. If 0.0, every component will be checked for tessellation changes each frame.

WireframeColor Source code

The color to use when rendering the wireframe of the terrain.

AlphaMap Source code

A mapping used to apply a layer to the terrain. Full structure can be found in UnTerrain.h, FAlphaMap.

CachedTerrainMaterialArray Source code

SelectedTerrainVertex Source code

Selected vertex structure - used for vertex editing
Weight:

The weight of the selection.

X:

The position of the vertex.

Y:

The position of the vertex.

TerrainDecoLayer Source code

A decoration layer - used to easily apply static meshes to the terrain
AlphaMapIndex:

INTERNAL: The index of the alpha map that represents the application of this layer.

Decorations:

The decoration(s) to apply for this layer.

Name:

The name of the DecoLayer, for UI display purposes.

TerrainDecoration Source code

A decoration source for terrain DecoLayers.
Density:

The density to use when applying the mesh to the terrain.

Factory:

The factory used to generate the decoration mesh.

Instances:

INTERNAL: An array of instances of the decoration applied to the terrain.

MaxScale:

The max scale to apply to the source mesh.

MinScale:

The min scale to apply to the source mesh.

RandSeed:

The value to use to seed the random number generator.

SlopeRotationBlend:

The amount to rotate the mesh to match the slope of the terrain where it is being placed. If 1.0, the mesh will match the slope exactly.

TerrainDecorationInstance Source code

A decoration instance applied to the terrain. Used internally to apply DecoLayers.

TerrainHeight Source code

A height data entry that is stored in an array for the terrain. Full structure can be found in UnTerrain.h, FTerrainHeight.

TerrainInfoData Source code

InfoData entries for each patch in the terrain. This includes information such as whether the patch is visible or not (holes). Full structure can be found in UnTerrain.h, FTerrainInfoData.

TerrainLayer Source code

A layer that can be painted onto the terrain.
AlphaMapIndex:

INTERNAL: The index of the alpha map that represents the application of this layer.

Hidden:

Whether the layer is hidden (not rendered).

HighlightColor:

The color to highlight the layer with.

Highlighted:

Whether the layer should be highlighted when rendered.

MaxX:

Rectangle encompassing all the vertices this layer affects. TerrainLayerSetup::SetMaterial() uses this to avoid rebuilding terrain that has not changed

MaxY:

Rectangle encompassing all the vertices this layer affects. TerrainLayerSetup::SetMaterial() uses this to avoid rebuilding terrain that has not changed

MinX:

Rectangle encompassing all the vertices this layer affects. TerrainLayerSetup::SetMaterial() uses this to avoid rebuilding terrain that has not changed

MinY:

Rectangle encompassing all the vertices this layer affects. TerrainLayerSetup::SetMaterial() uses this to avoid rebuilding terrain that has not changed

Name:

The name of the layer, for UI display purposes.

Setup:

The TerrainLayerSetup, which declares the material(s) used in the layer.

WireframeColor:

The color to wireframe highlight the layer with.

WireframeHighlighted:

Whether the layer should be wireframe highlighted when rendered. CURRENTLY NOT IMPLEMENTED

TerrainMaterialResource Source code

Terrain material resource - compiled terrain material used to render the terrain. Full structure can be found in UnTerrain.h, FTerrainMaterialResource.

TerrainWeightedMaterial Source code

A weighted material used on the terrain. Full structure can be found in UnTerrain.h, FTerrainWeightedMaterial.

CalcLayerBounds Source code

for each layer, calculate the rectangle encompassing all the vertices affected by it and store the result in the layer's MinX, MinY, MaxX, and MaxY properties

PostBeginPlay Source code

defaultproperties
{
   NormalMapLayer=-1
   MaxTesselationLevel=4
   MinTessellationLevel=1
   TesselationDistanceScale=1.000000
   TessellationCheckDistance=-1.000000
   CollisionTesselationLevel=1
   NumPatchesX=1
   NumPatchesY=1
   MaxComponentSize=16
   StaticLightingResolution=4
   bBilinearFilterLightmapGeneration=True
   bCastShadow=True
   bForceDirectLightMap=True
   bCastDynamicShadow=True
   bBlockRigidBody=True
   bAcceptsDynamicLights=True
   LightingChannels=(bInitialized=True,Static=True)
   WireframeColor=(B=255,G=255,R=0,A=0)
   Begin Object Class=SpriteComponent Name=Sprite ObjName=Sprite Archetype=SpriteComponent'Engine.Default__Info:Sprite'
      Sprite=Texture2D'EngineResources.S_Terrain'
      ObjectArchetype=SpriteComponent'Engine.Default__Info:Sprite'
   End Object
   Components(0)=Sprite
   bStatic=True
   bHidden=False
   bNoDelete=True
   bWorldGeometry=True
   bCollideActors=True
   bBlockActors=True
   bEdShouldSnap=True
   DrawScale3D=(X=256.000000,Y=256.000000,Z=256.000000)
   CollisionType=COLLIDE_CustomDefault
   Name="Default__Terrain"
   ObjectArchetype=Info'Engine.Default__Info'
}