FBranchFacade

[FBranchFacade](API\Plugins\ProceduralVegetation\FBranchFacade) is used to access and manipulate the data from Branch Group with in the ProceduralVegetation's [FManagedArrayCollection](API\Runtime\Chaos\FManagedArrayCollection) A branch is made up of multiple points.

API > API/Plugins > API/Plugins/ProceduralVegetation

FBranchFacade is used to access and manipulate the data from Branch Group with in the ProceduralVegetation's FManagedArrayCollection A branch is made up of multiple points. Each Branch will know about its parents and children, along with other attributes Only add the frequently used branch attributes and their access to this facade, for the specific access write a new facade

   
Name FBranchFacade
Type class
Header File /Engine/Plugins/Experimental/ProceduralVegetationEditor/Source/ProceduralVegetation/Public/Facades/PVBranchFacade.h
Include Path #include "Facades/PVBranchFacade.h"

Syntax

class FBranchFacade : public PV::Facades::IShrinkable

Constructors

Name Remarks Include Path Unreal Specifiers

FBranchFacade ( const FManagedArrayCollection& InCollection
)

   Facades/PVBranchFacade.h  
  Facades/PVBranchFacade.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
BranchFoliageIDs TManagedArrayAccessor< TArray< int32 > >   Facades/PVBranchFacade.h  
BranchHierarchyNumber TManagedArrayAccessor< int32 >   Facades/PVBranchFacade.h  
BranchNumbers TManagedArrayAccessor< int32 >   Facades/PVBranchFacade.h  
BranchParentNumbers TManagedArrayAccessor< int32 >   Facades/PVBranchFacade.h  
BranchPoints TManagedArrayAccessor< TArray< int32 > >   Facades/PVBranchFacade.h  
BranchSimulationGroupIndex TManagedArrayAccessor< int32 >   Facades/PVBranchFacade.h  
BranchSourceBudNumber TManagedArrayAccessor< int32 >   Facades/PVBranchFacade.h  
BranchUVMaterial TManagedArrayAccessor< int32 >   Facades/PVBranchFacade.h  
Children TManagedArrayAccessor< TArray< int32 > >   Facades/PVBranchFacade.h  
Collection FManagedArrayCollection *   Facades/PVBranchFacade.h  
Parents TManagedArrayAccessor< TArray< int32 > >   Facades/PVBranchFacade.h  
PlantNumbers TManagedArrayAccessor< int32 >   Facades/PVBranchFacade.h  
TrunkMaterialPathAttribute TManagedArrayAccessor< FString >   Facades/PVBranchFacade.h  
TrunkURangeAttribute TManagedArrayAccessor< TArray< FVector2f > >   Facades/PVBranchFacade.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

int32 AddElements ( int NumElements
)

   Facades/PVBranchFacade.h  

void FillBranchHierarchyNumber ( const TArray< int32 >& InputArray
)

   Facades/PVBranchFacade.h  

void FillBranchNumbers ( const TArray< int32 >& InputArray
)

   Facades/PVBranchFacade.h  

void FillBranchParentNumbers ( const TArray< int32 >& InputArray
)

   Facades/PVBranchFacade.h  

void FillBranchPoints ( const TArray< TArray< int32 > >& InputArray
)

   Facades/PVBranchFacade.h  

void FillBranchSourceBudNumber ( const TArray< int32 >& InputArray
)

   Facades/PVBranchFacade.h  

void FillChildren ( const TArray< TArray< int32 > >& InputArray
)

   Facades/PVBranchFacade.h  

void FillParents ( const TArray< TArray< int32 > >& InputArray
)

   Facades/PVBranchFacade.h  

void FillPlantNumbers ( const TArray< int32 >& InputArray
)

   Facades/PVBranchFacade.h  

const TArray< int32 > & GetBranchFoliageIDs ( int32 Index
) const

   Facades/PVBranchFacade.h  

void GetBranchHierarchyNumber ( int32 Index,
int32& OutValue
) const

   Facades/PVBranchFacade.h  

int32 GetBranchHierarchyNumber ( int32 Index
) const

   Facades/PVBranchFacade.h  

const TManagedArray< int32 > & GetBranchHierarchyNumbers()

   Facades/PVBranchFacade.h  

int32 GetBranchIndexFromPointIndex ( int32 PointIndex
) const

   Facades/PVBranchFacade.h  

void GetBranchNumber ( int32 Index,
int32& OutValue
) const

   Facades/PVBranchFacade.h  

int32 GetBranchNumber ( int32 Index
) const

   Facades/PVBranchFacade.h  

const TManagedArray< int32 > & GetBranchNumbers()

   Facades/PVBranchFacade.h  

void GetBranchParentNumber ( int32 Index,
int32& OutValue
) const

   Facades/PVBranchFacade.h  

int32 GetBranchPlantNumber ( int32 Index
) const

   Facades/PVBranchFacade.h  

void GetBranchPoints ( int32 Index,
TArray< int32 >& OutValue
) const

   Facades/PVBranchFacade.h  

int32 GetBranchSimulationGroupIndex ( int32 Index
) const

   Facades/PVBranchFacade.h  

void GetBranchSourceBudNumber ( int32 Index,
int32& OutValue
) const

   Facades/PVBranchFacade.h  

int32 GetBranchSourceBudNumber ( int32 Index
) const

   Facades/PVBranchFacade.h  

const TManagedArray< int32 > & GetBranchSourceBudNumbers()

   Facades/PVBranchFacade.h  

int32 GetBranchUVMaterial ( int32 Index
) const

   Facades/PVBranchFacade.h  

void GetChildren ( int32 Index,
TArray< int32 >& OutValue
) const

   Facades/PVBranchFacade.h  

const TArray< int32 > & GetChildren ( int32 Index
) const

   Facades/PVBranchFacade.h  

int32 GetHierarchyGenerationNumber ( int32 Index
) const

   Facades/PVBranchFacade.h  

TArray< int32 > GetImmediateChildren ( int32 Index
) const

   Facades/PVBranchFacade.h  

int32 GetParentBranchIndex ( int32 BranchIndex
) const

   Facades/PVBranchFacade.h  

TArray< int32 > GetParentBranchIndices ( int BranchIndex
) const

   Facades/PVBranchFacade.h  

int32 GetParentBranchNumber ( int32 BranchIndex
) const

   Facades/PVBranchFacade.h  

const TManagedArray< int32 > & GetParentBranchNumbers()

   Facades/PVBranchFacade.h  

int32 GetParentIndex ( int32 BranchIndex
) const

   Facades/PVBranchFacade.h  

void GetParents ( int32 Index,
TArray< int32 >& OutValue
) const

   Facades/PVBranchFacade.h  

const TArray< int32 > & GetParents ( int32 Index
) const

   Facades/PVBranchFacade.h  

void GetPlantNumber ( int32 Index,
int32& OutValue
) const

   Facades/PVBranchFacade.h  

const TArray< int32 > & GetPoints ( int32 Index
) const

   Facades/PVBranchFacade.h  

int32 GetRootPoint ( int32 Index
) const

   Facades/PVBranchFacade.h  

void GetSortedBranchIndicesByHierarchy ( TArray< int32 >& OutSortedIndices
) const

   Facades/PVBranchFacade.h  

FString GetTrunkMaterialPath()

   Facades/PVBranchFacade.h  

const TArray< FVector2f > & GetTrunkURange()

   Facades/PVBranchFacade.h  

bool GetValueFromAccessor ( TManagedArrayAccessor< T > Accessor,
T& OutValue,
int32 Index,
const T DefaultValue
) const

   Facades/PVBranchFacade.h  

bool IsConst()

   Facades/PVBranchFacade.h  

bool IsTrunk ( int32 Index
) const

   Facades/PVBranchFacade.h  

bool IsValid()

   Facades/PVBranchFacade.h  

void RecomputeBranchChildren()

   Facades/PVBranchFacade.h  

void RecomputeBranchParents()

   Facades/PVBranchFacade.h  

void SetBranchFoliageIDs ( int32 Index,
TArray< int32 > InBranchFoliageIDs
)

   Facades/PVBranchFacade.h  

void SetBranchHierarchyNumber ( int32 Index,
int32 InBranchHierarchyNumber
)

   Facades/PVBranchFacade.h  

void SetBranchHierarchyNumbersFromIndex ( const TArray< int32 >& InputArray,
const int32 StartIndex
)

   Facades/PVBranchFacade.h  

void SetBranchNumber ( int32 Index,
int32 InBranchNumber
)

   Facades/PVBranchFacade.h  

void SetBranchNumbersFromIndex ( const TArray< int32 >& InputArray,
const int32 StartIndex
)

   Facades/PVBranchFacade.h  

void SetBranchPlantNumber ( int32 Index,
int32 InPlantNumber
)

   Facades/PVBranchFacade.h  

void SetBranchSimulationGroupIndex ( int32 Index,
int32 InLogicalDepth
)

   Facades/PVBranchFacade.h  

void SetBranchSourceBudNumber ( int32 Index,
int32 InSourceBudNumber
)

   Facades/PVBranchFacade.h  

void SetBranchSourceBudNumbersFromIndex ( const TArray< int32 >& InputArray,
const int32 StartIndex
)

   Facades/PVBranchFacade.h  

void SetBranchUVMaterial ( int32 Index,
int32 InMaterial
)

   Facades/PVBranchFacade.h  

void SetChildren ( int32 Index,
TArray< int32 > InChildren
)

   Facades/PVBranchFacade.h  

void SetParentBranchNumber ( int32 BranchIndex,
int32 InParentBranchNumber
)

   Facades/PVBranchFacade.h  

void SetParentBranchNumbersFromIndex ( const TArray< int32 >& InputArray,
const int32 StartIndex
)

   Facades/PVBranchFacade.h  

void SetParents ( int32 Index,
TArray< int32 > InParents
)

   Facades/PVBranchFacade.h  

void SetPoints ( int32 Index,
TArray< int32 > InPoints
)

   Facades/PVBranchFacade.h  

void SetTrunkMaterialPath ( const FString& InPath
)

   Facades/PVBranchFacade.h  

void SetTrunkURange ( TArray< FVector2f > InURange
)

   Facades/PVBranchFacade.h  

Public Virtual

Overridden from IShrinkable

Name Remarks Include Path Unreal Specifiers

virtual void CopyEntry ( int32 FromIndex,
int32 ToIndex
)

   Facades/PVBranchFacade.h  

virtual int32 GetElementCount()

   Facades/PVBranchFacade.h  

virtual void RemoveEntries ( int32 NumEntries,
int32 StartIndex
)

   Facades/PVBranchFacade.h  

Static

Name Remarks Include Path Unreal Specifiers

static TArray< int32 > ComputeDescendantsForBranchNumber ( const int32 BranchNumber,
const TMap< int32, TArray< int32 > >& ImmediateChildren,
TMap< int32, TArray< int32 > >& Memo,
TSet< int32 >& VisitingSet
)

   Facades/PVBranchFacade.h  

static TArray< int32 > ComputeParentsForBranchNumber ( const int32 BranchNumber,
const TMap< int32, int32 >& BranchNumbersToBranchParentNumbers,
TMap< int32, TArray< int32 > >& Memo,
TSet< int32 >& VisitedParents
)

   Facades/PVBranchFacade.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page