1. Epic GamesDeveloper
  3. UWaveFunctionCollapseBPLibrary

UWaveFunctionCollapseBPLibrary

API > API/Plugins > API/Plugins/WaveFunctionCollapse

   
Name UWaveFunctionCollapseBPLibrary
Type class
Header File /Engine/Plugins/Experimental/WaveFunctionCollapse/Source/WaveFunctionCollapse/Public/WaveFunctionCollapseBPLibrary.h
Include Path #include "WaveFunctionCollapseBPLibrary.h"

Syntax

UCLASS ()  
class UWaveFunctionCollapseBPLibrary : public UBlueprintFunctionLibrary

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UWaveFunctionCollapseBPLibrary ( const FObjectInitializer& ObjectInitializer
)

   WaveFunctionCollapseBPLibrary.h  

Functions

Public

Static

Name Remarks Include Path Unreal Specifiers

static void AddToAdjacencyToOptionsMap ( UPARAM(ref) FWaveFunctionCollapseAdjacencyToOptionsMap& AdjacencyToOptionsMap,
EWaveFunctionCollapseAdjacency Adjacency,
FWaveFunctionCollapseOption Option
)

 Add an entry to an AdjacencyToOptionsMap WaveFunctionCollapseBPLibrary.h
  • BlueprintCallable
  • Category="WaveFunctionCollapse"

static FWaveFunctionCollapseTile BuildInitialTile ( UWaveFunctionCollapseModel* WFCModel
)

 Builds the initial tile which adds every unique option in a model to its RemainingOptions array and calculates its entropy WaveFunctionCollapseBPLibrary.h
  • BlueprintCallable
  • Category="WaveFunctionCollapse"
  • Meta=(ScriptMethod)

static float CalculateShannonEntropy ( const TArray< FWaveFunctionCollapseOption >& Options,
UWaveFunctionCollapseModel* WFCModel
)

 Calculates Shannon Entropy from an array of options and a given model WaveFunctionCollapseBPLibrary.h
  • BlueprintCallable
  • Category="WaveFunctionCollapse"

static void DeriveModelFromActors ( UPARAM(ref) const TArray< AActor* >& Actors,
UWaveFunctionCollapseModel* WFCModel,
float TileSize,
bool bIsBorderEmptyOption,
bool bIsMinZFloorOption,
bool bUseUniformWeightDistribution,
bool bAutoDeriveZAxisRotationConstraints,
const TArray< FSoftObjectPath >& SpawnExclusionAssets,
const TArray< FSoftObjectPath >& IgnoreRotationAssets
)

 Derive constraints from a given layout of actors and append them to a model WaveFunctionCollapseBPLibrary.h
  • BlueprintCallable
  • Category="WaveFunctionCollapse"

static TMap< int32, EWaveFunctionCollapseAdjacency > GetAdjacentIndices ( int32 Index,
FIntVector Resolution
)

 Get adjacent indices of a given index and its adjacency WaveFunctionCollapseBPLibrary.h
  • BlueprintCallable
  • Category="WaveFunctionCollapse"

static TMap< FIntVector, EWaveFunctionCollapseAdjacency > GetAdjacentPositions ( FIntVector Position,
FIntVector Resolution
)

 Get adjacent positions of a given position and its adjacency WaveFunctionCollapseBPLibrary.h
  • BlueprintCallable
  • Category="WaveFunctionCollapse"
Get the next adjacency in clockwise direction on a Z-axis for a given adjacency. WaveFunctionCollapseBPLibrary.h
  • BlueprintPure
  • Category="WaveFunctionCollapse"
Get the opposite adjacency for a given adjacency. WaveFunctionCollapseBPLibrary.h
  • BlueprintPure
  • Category="WaveFunctionCollapse"

static bool GetPositionToOptionMapFromActor ( AActor* Actor,
float TileSize,
UPARAM(ref) TMap< FIntVector, FWaveFunctionCollapseOption >& PositionToOptionMap
)

 Get PositionToOptionsMap from a given actor that has ISM components. WaveFunctionCollapseBPLibrary.h
  • BlueprintCallable
  • Category="WaveFunctionCollapse"

static FIntVector IndexAsPosition ( int32 Index,
FIntVector Resolution
)

 Convert 2D array index to 3D grid position WaveFunctionCollapseBPLibrary.h
  • BlueprintPure
  • Category="WaveFunctionCollapse"

static bool IsOptionContained ( const FWaveFunctionCollapseOption& Option,
const TArray< FWaveFunctionCollapseOption >& Options
)

 Is the option contained in the given options array WaveFunctionCollapseBPLibrary.h
  • BlueprintPure
  • Category="WaveFunctionCollapse"

static bool IsSoftObjPathEqual ( const FSoftObjectPath& SoftObjectPathA,
const FSoftObjectPath& SoftObjectPathB
)

   WaveFunctionCollapseBPLibrary.h
  • BlueprintPure
  • Category="WaveFunctionCollapse"

static FWaveFunctionCollapseOption MakeBorderOption()

 Make FWaveFunctionCollapseOption of type: BorderOption WaveFunctionCollapseBPLibrary.h
  • BlueprintPure
  • Category="WaveFunctionCollapse"

static FWaveFunctionCollapseOption MakeEmptyOption()

 Make FWaveFunctionCollapseOption of type: EmptyOption WaveFunctionCollapseBPLibrary.h
  • BlueprintPure
  • Category="WaveFunctionCollapse"

static FWaveFunctionCollapseOption MakeVoidOption()

 Make FWaveFunctionCollapseOption of type: VoidOption WaveFunctionCollapseBPLibrary.h
  • BlueprintPure
  • Category="WaveFunctionCollapse"

static int32 PositionAsIndex ( FIntVector Position,
FIntVector Resolution
)

 Convert 3D grid position to 2D array index WaveFunctionCollapseBPLibrary.h
  • BlueprintPure
  • Category="WaveFunctionCollapse"

static FRotator SanitizeRotator ( FRotator Rotator
)

 Converts Rotator to Matrix and back to sanitize multiple representations of the same rotation to a common Rotator value WaveFunctionCollapseBPLibrary.h
  • BlueprintPure
  • Category="WaveFunctionCollapse"

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page