1. Epic GamesDeveloper
  3. FEditLayerTargetTypeState

FEditLayerTargetTypeState

[FEditLayerTargetTypeState](API\Runtime\Landscape\FEditLayerTargetTypeState) fully describes the state of an edit layer renderer wrt its target types.

API > API/Runtime > API/Runtime/Landscape

FEditLayerTargetTypeState fully describes the state of an edit layer renderer wrt its target types. It's named after the enum "ELandscapeToolTargetType" in order to tell whether the renderer's heightmaps and/or visibility and/or weightmaps are enabled (and if so, which weightmap is enabled exactly) It is meant to be provided by the edit layer renderer's GetRendererStateInfo implementation.

   
Name FEditLayerTargetTypeState
Type class
Header File /Engine/Source/Runtime/Landscape/Public/LandscapeEditLayerTargetTypeState.h
Include Path #include "LandscapeEditLayerTargetTypeState.h"

Syntax

class FEditLayerTargetTypeState

Constructors

Name Remarks Include Path Unreal Specifiers

FEditLayerTargetTypeState ( const FMergeContext* InMergeContext
)

 Constructs an empty FEditLayerTargetTypeState (all target types turned off, no active weightmaps) LandscapeEditLayerTargetTypeState.h  
Private constructor : either use the constructors taking a merge context in parameter or use GetDummyTargetTypeState() LandscapeEditLayerTargetTypeState.h  

FEditLayerTargetTypeState ( const FMergeContext* InMergeContext,
ELandscapeToolTargetTypeFlags InTargetTypeMask,
const TArrayView< const FName >& InSupportedWeightmaps,
bool bInChecked
)

 Initializes a FEditLayerTargetTypeState with the target types and the weightmaps passed in parameter (by name) LandscapeEditLayerTargetTypeState.h  

FEditLayerTargetTypeState ( const FMergeContext* InMergeContext,
ELandscapeToolTargetTypeFlags InTargetTypeMask
)

 Initializes a FEditLayerTargetTypeState with the target types passed in parameter LandscapeEditLayerTargetTypeState.h  

FEditLayerTargetTypeState ( const FMergeContext* InMergeContext,
ELandscapeToolTargetTypeFlags InTargetTypeMask,
const TBitArray<>& InSupportedWeightmapLayerIndices
)

 Initializes a FEditLayerTargetTypeState with the target types and (optionally) the weightmaps passed in parameter (by bit index) LandscapeEditLayerTargetTypeState.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
FEditLayerRendererState friend   LandscapeEditLayerTargetTypeState.h  
ILandscapeEditLayerRenderer friend   LandscapeEditLayerTargetTypeState.h  
MergeContext const FMergeContext * Global context being used for this merge : contains generic information about the landscape, its available layer names, etc. LandscapeEditLayerTargetTypeState.h  
TargetTypeMask ELandscapeToolTargetTypeFlags Bitmask of the target types that are supported LandscapeEditLayerTargetTypeState.h  
WeightmapTargetLayerBitIndices TBitArray List of weightmaps that are supported for the ELandscapeToolTargetType::Weightmap/ELandscapeToolTargetTypeVisibility type. LandscapeEditLayerTargetTypeState.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddTargetType ( ELandscapeToolTargetType InTargetType
)

 Adds the target type in parameter to the mask of active target types LandscapeEditLayerTargetTypeState.h  

void AddTargetTypeMask ( ELandscapeToolTargetTypeFlags InTargetTypeMask
)

 Appends the target type mask in parameter to the mask of active target types LandscapeEditLayerTargetTypeState.h  

void AddWeightmap ( int32 InWeightmapLayerIndex
)

 Adds a weightmap to the list of active weightmaps (make sure ELandscapeToolTargetType::Weightmap is amongst the supported target types). LandscapeEditLayerTargetTypeState.h  

void AddWeightmap ( const FName& InWeightmapLayerName
)

 Adds a weightmap to the list of active weightmaps (make sure ELandscapeToolTargetType::Weightmap is amongst the supported target types) LandscapeEditLayerTargetTypeState.h  

void AddWeightmapChecked ( const FName& InWeightmapLayerName
)

 Adds a weightmap to the list of active weightmaps (make sure ELandscapeToolTargetType::Weightmap is amongst the supported target types). LandscapeEditLayerTargetTypeState.h  
Returns the currently active weightmaps : LandscapeEditLayerTargetTypeState.h  
Returns the currently active weightmaps : LandscapeEditLayerTargetTypeState.h  

ELandscapeToolTargetTypeFlags GetTargetTypeMask()

 Returns the target type mask (i.e. same as ELandscapeToolTargetType, but as bit flags) LandscapeEditLayerTargetTypeState.h  
Returns the "intersection" (AND operation) between the target type state and the one in parameter. LandscapeEditLayerTargetTypeState.h  

bool IsActive ( ELandscapeToolTargetType InTargetType,
int32 InWeightmapLayerIndex
) const

 Indicates whether a given target type is currently active in this state LandscapeEditLayerTargetTypeState.h  

bool IsActive ( ELandscapeToolTargetType InTargetType,
const FName& InWeightmapLayerName
) const

 Indicates whether a given target type is currently active in this state LandscapeEditLayerTargetTypeState.h  

bool IsActiveChecked ( ELandscapeToolTargetType InTargetType,
const FName& InWeightmapLayerName
) const

 Indicates whether a given target type is currently active in this state LandscapeEditLayerTargetTypeState.h  

void RemoveTargetType ( ELandscapeToolTargetType InTargetType
)

 Removes a single target type from the mask of active target types LandscapeEditLayerTargetTypeState.h  

void RemoveTargetTypeMask ( ELandscapeToolTargetTypeFlags InTargetTypeMask
)

 Removes the target type mask in parameter from the mask of active target types LandscapeEditLayerTargetTypeState.h  

void RemoveWeightmap ( int32 InWeightmapLayerIndex
)

 Removes a weightmap from the list of active weightmaps. LandscapeEditLayerTargetTypeState.h  

void RemoveWeightmap ( const FName& InWeightmapLayerName
)

 Removes a weightmap from the list of active weightmaps LandscapeEditLayerTargetTypeState.h  

void RemoveWeightmapChecked ( const FName& InWeightmapLayerName
)

 Removes a weightmap from the list of active weightmaps. LandscapeEditLayerTargetTypeState.h  

void SetTargetTypeMask ( ELandscapeToolTargetTypeFlags InTargetTypeMask
)

 Sets the target type mask (i.e. same as ELandscapeToolTargetType, but as bit flags) LandscapeEditLayerTargetTypeState.h  

FString ToString()

   LandscapeEditLayerTargetTypeState.h  

Static

Name Remarks Include Path Unreal Specifiers

static const FEditLayerTargetTypeState & GetDummyTargetTypeState()

   LandscapeEditLayerTargetTypeState.h  

Operators

Name Remarks Include Path Unreal Specifiers

bool operator== ( const FEditLayerTargetTypeState& InOther
) const

   LandscapeEditLayerTargetTypeState.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page