| UObjectBase
|
Module |
|
Header |
/Engine/Source/Runtime/Landscape/Classes/LandscapeComponent.h |
Include |
#include "LandscapeComponent.h" |
class ULandscapeComponent : public UPrimitiveComponent
Name | Description | ||
---|---|---|---|
|
ActiveExcludedBoxes |
||
|
BakedTextureMaterialGuid |
The Material Guid that used when baking, to detect material recompilations |
|
|
CachedLocalBox |
Cached local-space bounding box, created at heightmap update time |
|
|
ChangeTag |
||
|
TLazyObjectPtr<... |
CollisionComponent |
Reference to associated collision component |
|
CollisionMipLevel |
Heightfield mipmap used to generate collision |
|
|
ComponentSizeQuads |
Total number of quads for this component, has to be >0 |
|
|
EditToolRenderData |
Pointer to data shared with the render thread, used by the editor tools |
|
|
ForcedLOD |
Forced LOD level to use when rendering |
|
|
UTexture2D *... |
GIBakedBaseColorTexture |
Pre-baked Base Color texture for use by distance field GI |
|
TSharedRef< FLa... |
GrassData |
Grass data for generation |
|
HeightmapScaleBias |
UV offset to Heightmap data from component local coordinates |
|
|
LayerWhitelist |
List of layers allowed to be painted on this component. |
|
|
LightingLODBias |
LOD level Bias to use when lighting buidling via lightmass, -1 Means automatic LOD calculation based on ForcedLOD + LODBias |
|
|
LODBias |
LOD level Bias to use when rendering |
|
|
LODIndexToMaterialIndex |
Mapping between LOD and Material Index |
|
|
MapBuildDataId |
Uniquely identifies this component's built map data. |
|
|
MaterialIndexToDisabledTessellationMaterial |
Mapping between Material Index to associated generated disabled Tessellation Material |
|
|
MaterialInstances |
||
|
MaterialInstancesDynamic |
||
|
MaterialPerLOD |
Represent the chosen material for each LOD |
|
|
MobileBlendableLayerMask |
For ES2 |
|
|
MobileCombinationMaterialInstances |
The editor needs to save out the combination MIC we'll use for mobile, because we cannot generate it at runtime for standalone PIE games |
|
|
MobileDataSourceHash |
Hash of source for ES2 generated data. Used determine if we need to re-generate ES2 pixel data. |
|
|
MobileMaterialInterfaces |
Material interfaces used for mobile |
|
|
MobileWeightmapLayerAllocations |
Layer allocations used by mobile. |
|
|
MobileWeightmapTextures |
Generated weightmap textures used for ES2. |
|
|
float |
NegativeZBoundsExtension |
Allows overriding the landscape bounds. |
|
NumSubsections |
Number of subsections in X or Y axis |
|
|
OverrideHoleMaterial |
||
|
OverrideMaterial |
||
|
OverrideMaterials |
||
|
PlatformData |
Platform Data where don't support texture sampling in vertex buffer |
|
|
float |
PositiveZBoundsExtension |
Allows overriding the landscape bounds. |
|
SectionBaseX |
X offset from global components grid origin (in quads) |
|
|
SectionBaseY |
Y offset from global components grid origin (in quads) |
|
|
SimpleCollisionMipLevel |
Heightfield mipmap used to generate simple collision |
|
|
SplineHash |
||
|
StateId |
||
|
float |
StaticLightingResolution |
StaticLightingResolution overriding per component, default value 0 means no overriding |
|
SubsectionSizeQuads |
Number of quads for a subsection of the component. SubsectionSizeQuads+1 must be a power of two. |
|
|
WeightmapScaleBias |
UV offset to component's weightmap data from component local coordinates |
|
|
WeightmapsHash |
Represents hash of last weightmap usage update |
|
|
float |
WeightmapSubsectionOffset |
U or V offset into the weightmap for the first subsection, in texture UV space |
|
UTexture2D *... |
XYOffsetmapTexture |
XYOffsetmap texture reference |
Name | Description | |
---|---|---|
|
ULandscapeComponent ( |
Name | Description | ||
---|---|---|---|
|
AddDefaultLayerData ( |
||
|
AddLayerData ( |
||
|
AreTexturesStreamedForGrassMapRender() |
Are the textures we need to render a grassmap currently streamed in? |
|
|
CanRenderGrassMap() |
Could a grassmap currently be generated, disregarding whether our textures are streamed in? |
|
|
CheckGenerateLandscapePlatformData ( |
Generate mobile data if it's missing or outdated |
|
|
ClearDirtyCollisionHeightData() |
Clears component's dirtied collision region (used by Layer System) |
|
|
ClearUpdateFlagsForModes ( |
||
|
ComponentHasVisibilityPainted() |
Returns true if this component has visibility painted |
|
|
ComputeLayerHash() |
||
|
ComputeWeightmapsHash() |
||
|
CopyFinalLayerIntoEditingLayer ( |
||
|
CreateEmptyTextureMips ( |
Generate empty mipmaps for weightmap |
|
|
DeleteLayer ( |
Deletes a layer from this component, removing all its data |
|
|
DestroyCollisionData() |
Deletes Collision Component |
|
|
float |
EditorGetPaintLayerWeightAtLocation ( |
Gets the landscape paint layer weight value at the given position using LandscapeLayerInfo . |
|
float |
EditorGetPaintLayerWeightByNameAtLocation |
Gets the landscape paint layer weight value at the given position using layer name. |
|
FillLayer ( |
Fills a layer to 100% on this component, adding it if needed and removing other layers that get painted away |
|
|
FixupWeightmaps() |
Fix up component layers, weightmaps |
|
|
ForEachLayer ( |
||
|
GenerateHeightmapMips |
Generate mipmaps for height and tangent data. |
|
|
GenerateMipsTempl ( |
Generate mipmaps for weightmap Assumes all weightmaps are unique to this component. |
|
|
GenerateMobileWeightmapLayerAllocations() |
Generates mobile platform data for this component. |
|
|
GeneratePlatformPixelData() |
||
|
GeneratePlatformVertexData ( |
||
|
GenerateWeightmapMips ( |
||
|
UMaterialIns... |
GetCombinationMaterial ( |
Helper function for UpdateMaterialInstance to get Material without set parameters |
|
GetComponentExtent |
Extends passed region with this component section size |
|
|
const FLands... |
GetEditingLayer() |
|
|
FLandscapeLa... |
GetEditingLayer() |
|
|
GetEditingLayerGUID() |
||
|
GetGeneratedTexturesAndMaterialInstances |
Returns all generated textures and material instances used by this component. |
|
|
UTexture2D &... |
GetHeightmap ( |
|
|
ALandscape &... |
GetLandscapeActor() |
Get the landscape actor associated with this component. |
|
UMaterialInt... |
GetLandscapeHoleMaterial() |
Returns the components's LandscapeHoleMaterial, or the Component's OverrideLandscapeHoleMaterial if set |
|
ULandscapeIn... |
GetLandscapeInfo() |
Gets the landscape info object for this landscape |
|
UMaterialInt... |
GetLandscapeMaterial ( |
Returns the component's LandscapeMaterial, or the Component's OverrideLandscapeMaterial if set |
|
ALandscapePr... |
GetLandscapeProxy() |
Gets the landscape proxy actor which owns this component |
|
GetLayerAllocationKey ( |
Generate a key for a component's layer allocations to use with MaterialInstanceConstantMap. |
|
|
FLandscapeLa... |
GetLayerData ( |
|
|
const FLands... |
GetLayerData ( |
|
|
GetLayerDebugColorKey |
||
|
GetLayerUpdateFlagPerMode() |
||
|
float |
GetLayerWeightAtLocation ( |
|
|
ULevel * |
GetLevel() |
Get the level in which the owning actor resides |
|
const FGuid ... |
GetLightingGuid() |
|
|
GetMapBuildDataId() |
||
|
UMaterialIns... |
GetMaterialInstance |
|
|
GetMaterialInstanceCount ( |
||
|
UMaterialIns... |
GetMaterialInstanceDynamic ( |
Gets the landscape material instance dynamic for this component |
|
const FMeshM... |
GetMeshMapBuildData() |
|
|
GetSectionBase() |
||
|
GetStaticLightingInfo ( |
||
|
const TArray... |
GetWeightmapLayerAllocations ( |
|
|
GetWeightmapLayerAllocations ( |
||
|
const TArray... |
GetWeightmapLayerAllocations ( |
|
|
GetWeightmapLayerAllocations ( |
||
|
GetWeightmapTextures ( |
||
|
const TArray... |
GetWeightmapTextures ( |
|
|
const TArray... |
GetWeightmapTexturesUsage ( |
|
|
GetWeightmapTexturesUsage ( |
||
|
HasLayersData() |
||
|
Init |
Initialize the landscape component |
|
|
InitHeightmapData |
||
|
InitWeightmapData ( |
||
|
IsGrassMapOutdated() |
Is the grassmap data outdated, eg by a material |
|
|
IsLandscapeHoleMaterialValid() |
Returns true if the component has a valid LandscapeHoleMaterial |
|
|
IsUpdateFlagEnabledForModes ( |
||
|
MaterialHasGrass() |
True if the component's landscape material supports grass |
|
|
ReallocateWeightmaps ( |
Create weightmaps for this component for the layers specified in the WeightmapLayerAllocations array |
|
|
RecreateCollisionComponent ( |
||
|
RemoveGrassMap() |
||
|
RemoveInvalidWeightmaps() |
||
|
RemoveLayerData ( |
||
|
RenderGrassMap() |
Creates and destroys cooked grass data stored in the map |
|
|
RenderWPOHeightmap ( |
Renders the heightmap of this component (including material world-position-offset) at the specified LOD |
|
|
ReplaceLayer ( |
Replaces one layerinfo on this component with another |
|
|
RequestDeferredClientUpdate() |
||
|
RequestEditingClientUpdate() |
||
|
RequestHeightmapUpdate |
||
|
RequestWeightmapUpdate |
||
|
SerializeStateHashes ( |
Serialize all hashes/guids that record the current state of this component |
|
|
SetEditingLayer ( |
||
|
SetHeightmap ( |
||
|
SetLightingGuid() |
||
|
SetLOD |
||
|
SetSectionBase ( |
||
|
SetWeightmapLayerAllocations ( |
||
|
SetWeightmapTextures ( |
||
|
SetWeightmapTexturesUsage ( |
||
|
UpdateCachedBounds ( |
Recalculate cached bounds using height values. |
|
|
UpdateCollisionData ( |
Updates collision component height data for the entire component, locking and unlocking heightmap textures |
|
|
UpdateCollisionHeightBuffer ( |
||
|
UpdateCollisionHeightData |
Create or updates collision component height data |
|
|
UpdateCollisionLayerData |
Update collision component dominant layer data |
|
|
UpdateCollisionLayerData() |
Update collision component dominant layer data for the whole component, locking and unlocking the weightmap textures. |
|
|
UpdateDataMips ( |
||
|
UpdateDirtyCollisionHeightData ( |
Cumulates component's dirtied collision region that will need to be updated (used by Layer System) |
|
|
UpdateDominantLayerBuffer |
||
|
UpdatedSharedPropertiesFromActor() |
Updates the values of component-level properties exposed by the Landscape Actor |
|
|
UpdateEditToolRenderData() |
||
|
UpdateLayerWhitelistFromPaintedLayers() |
Update layer whitelist to include the currently painted layers. |
|
|
UpdateMaterialInstances() |
Update the MaterialInstance parameters to match the layer and weightmaps for this component Creates the MaterialInstance if it doesn't exist. |
|
|
UpdateMaterialInstances ( |
Update the MaterialInstance parameters to match the layer and weightmaps for this component Creates the MaterialInstance if it doesn't exist. |
|
|
UpdateMaterialInstances_Internal ( |
Internal implementation of UpdateMaterialInstances, not safe to call directly. |
|
|
UpdateMipsTempl ( |
Update mipmaps for existing weightmap texture |
|
|
UpdateNavigationRelevance() |
Updates navigation properties to match landscape's master switch |
|
|
UpdateRejectNavmeshUnderneath() |
Updates the reject navmesh underneath flag in the collision component |
|
|
UpdateWeightmapMips ( |
Name | Description | ||
---|---|---|---|
|
AddMapBuildDataGUIDs |
Add the used GUIDs from UMapBuildDataRegistry::MeshBuildData. |
|
|
ComponentIsTouchingSelectionBox ( |
Determines whether the supplied bounding box intersects with the component. |
|
|
ComponentIsTouchingSelectionFrustum ( |
Determines whether the supplied frustum intersects with the component. |
|
|
FPrimitiveSc... |
CreateSceneProxy() |
Creates a proxy to represent the primitive to the scene manager in the rendering thread. |
|
GetLightAndShadowMapMemoryUsage |
Returns the light and shadow map memory for this primitive in its out variables. |
|
|
GetLightMapResolution |
Returns the lightmap resolution used for this primitive instance in the case of it supporting texture light/ shadow maps. |
|
|
UMaterialInt... |
GetMaterial ( |
Returns the material used by the element at the specified index |
|
GetNumMaterials() |
Return number of material elements in this primitive |
|
|
GetRuntimeVirtualTextures() |
Get the array of runtime virtual textures into which we render the mesh for this actor. |
|
|
ELightMapInt... |
GetStaticLightingType() |
Requests whether the component will use texture, vertex or no lightmaps. |
|
GetStaticLightMapResolution() |
Returns the static lightmap resolution used for this primitive. |
|
|
GetStreamingRenderAssetInfo ( |
Enumerates the streaming textures/meshes used by the primitive. |
|
|
GetUsedMaterials ( |
Retrieves the materials used in this component |
|
|
ERuntimeVirt... |
GetVirtualTextureRenderPassType() |
Get the runtime virtual texture pass settings. |
|
SetMaterial ( |
Changes the material applied to an element of the mesh. |
|
|
SupportsStaticLighting() |
Whether the component type supports static lighting. |
Name | Description | ||
---|---|---|---|
|
FBoxSphereBo... |
CalcBounds ( |
Calculate the bounds of the component. Default behavior is a bounding box/sphere of zero size. |
|
IsPrecomputedLightingValid() |
True if our precomputed lighting is up to date |
|
|
PreFeatureLevelChange ( |
Called to update any visuals needed for a feature level change |
|
|
PropagateLightingScenarioChange() |
Updates any visuals after the lighting has changed |
Name | Description | ||
---|---|---|---|
|
DestroyComponent ( |
Unregister the component, remove it from its outer Actor's Components array and mark for pending kill. |
|
|
InvalidateLightingCacheDetailed |
Called when this actor component has moved, allowing it to discard statically cached lighting information. |
|
|
OnRegister() |
Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called. |
|
|
OnUnregister() |
Called when a component is unregistered. |
Name | Description | ||
---|---|---|---|
|
BeginCacheForCookedPlatformData ( |
Starts caching of platform specific data for the target platform Called when cooking before serialization so that object can prepare platform specific data Not called during normal loading of objects |
|
|
BeginDestroy() |
Called before destroying the object. |
|
|
ExportCustomProperties ( |
Exports the property values for the specified object as text to the output device. |
|
|
GetResourceSizeEx ( |
Get the size of the object/resource for use in memory tools or to display to artists/LDs in the Editor This is the extended version which separates up the used memory into different memory regions (the actual definition of which may be platform specific). |
|
|
ImportCustomProperties ( |
Exports the property values for the specified object as text to the output device. |
|
|
PostDuplicate ( |
Called after duplication & serialization and before PostLoad. |
|
|
PostEditChangeProperty ( |
Called when a property on this object has been modified externally |
|
|
PostEditUndo() |
Called after applying a transaction to the object. |
|
|
PostInitProperties() |
Called after the C++ constructor and after the properties have been initialized, including those loaded from config. |
|
|
PostLoad() |
Do any object-specific cleanup required immediately after loading an object. |
|
|
PreEditChange ( |
This is called when a property is about to be modified externally |
|
|
Serialize ( |
Handles reading, writing, and reference collecting using FArchive. |
Name | Description | ||
---|---|---|---|
|
IrrelevantLights_DEPRECATED |
Legacy irrelevant lights |
|
|
MaterialInstance_DEPRECATED |
||
|
MobileCombinationMaterialInstance_DEPRECATED |
||
|
MobileMaterialInterface_DEPRECATED |