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

References

   
Module Landscape
Header /Engine/Source/Runtime/Landscape/Public/LandscapeEditLayerRenderer.h
Include #include "LandscapeEditLayerRenderer.h"

Syntax

struct FEditLayerTargetTypeState

Remarks

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.

Constructors

  Type Name Description
Public function    
Public function  

FEditLayerTargetTypeState ( ELandscapeToolTargetTypeFlags InTargetTypeMask,
const TArrayView< const FName >& InSupportedWeightmaps
)

  

Functions

  Type Name Description
Public function void Adds the target type in parameter to the mask of active target types
Public function void Appends the target type mask in parameter to the mask of active target types
Public function void

AddWeightmap ( FName InWeightmapLayerName
)

 Adds a weightmap to the list of active weightmaps (make sure ELandscapeToolTargetType::Weightmap is amongst the supported target types)
Public function Const const TArray< FName > & Returns the currently active weightmaps, if Weightmap is amongst the supported target types
Public function Const ELandscapeToolTargetTypeFlags Returns the target type mask (i.e. same as ELandscapeToolTargetType, but as bit flags)
Public function Const FEditLayerTargetTypeState Returns the "intersection" (AND operation) between the target type state and the one in parameter.
Public function Const bool

IsActive ( ELandscapeToolTargetType InTargetType,
FName InWeightmapLayerName
)

 Indicates whether a given target type is currently active in this state
Public function void Removes a single target type from the mask of active target types
Public function void Removes the target type mask in parameter from the mask of active target types
Public function void

RemoveWeightmap ( FName InWeightmapLayerName
)

 Removes a weightmap from the list of active weightmaps
Public function void Sets the target type mask (i.e. same as ELandscapeToolTargetType, but as bit flags)
Public function Const FString  

Operators

  Type Name Description
Public function Const bool  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page