Navigation
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
(
FManagedArrayCollection& InCollection |
Facades/PVBranchFacade.h | ||
FBranchFacade
(
const FManagedArrayCollection& InCollection |
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 GetBranchHierarchyNumber
(
int32 Index |
Facades/PVBranchFacade.h | ||
int32 GetBranchIndexFromPointIndex
(
int32 PointIndex |
Facades/PVBranchFacade.h | ||
int32 GetBranchNumber
(
const int32 Index |
Facades/PVBranchFacade.h | ||
const TManagedArray< int32 > & GetBranchNumbers() |
Facades/PVBranchFacade.h | ||
int32 GetBranchSimulationGroupIndex
(
int32 Index |
Facades/PVBranchFacade.h | ||
int32 GetBranchSourceBudNumber
(
const int32 Index |
Facades/PVBranchFacade.h | ||
int32 GetBranchUVMaterial
(
const int32 Index |
Facades/PVBranchFacade.h | ||
const TArray< int32 > & GetChildren
(
const int32 Index |
Facades/PVBranchFacade.h | ||
int32 GetHierarchyGenerationNumber
(
const int32 Index |
Facades/PVBranchFacade.h | ||
int32 GetParentBranchIndex
(
const int32 BranchIndex |
Facades/PVBranchFacade.h | ||
TArray< int32 > GetParentBranchIndices
(
int BranchIndex |
Facades/PVBranchFacade.h | ||
int32 GetParentBranchNumber
(
const int32 BranchIndex |
Facades/PVBranchFacade.h | ||
int32 GetParentIndex
(
const int32 BranchIndex |
Facades/PVBranchFacade.h | ||
const TArray< int32 > & GetParents
(
const int32 Index |
Facades/PVBranchFacade.h | ||
const TArray< int32 > & GetPoints
(
const int32 Index |
Facades/PVBranchFacade.h | ||
void GetSortedBranchIndicesByHierarchy
(
TArray< int32 >& OutSortedIndices |
Facades/PVBranchFacade.h | ||
FString GetTrunkMaterialPath() |
Facades/PVBranchFacade.h | ||
const TArray< FVector2f > & GetTrunkURange() |
Facades/PVBranchFacade.h | ||
bool IsConst() |
Facades/PVBranchFacade.h | ||
bool IsValid() |
Facades/PVBranchFacade.h | ||
void SetBranchSimulationGroupIndex
(
int32 Index, |
Facades/PVBranchFacade.h | ||
void SetBranchUVMaterial
(
const int32 Index, |
Facades/PVBranchFacade.h | ||
void SetChildren
(
const int32 Index, |
Facades/PVBranchFacade.h | ||
void SetParents
(
const int32 Index, |
Facades/PVBranchFacade.h | ||
void SetPoints
(
const int32 Index, |
Facades/PVBranchFacade.h | ||
void SetTrunkMaterialPath
(
const FString& InPath |
Facades/PVBranchFacade.h | ||
void SetTrunkURange
(
const TArray< FVector2f >& InURange |
Facades/PVBranchFacade.h |
Overridden from IShrinkable
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void CopyEntry
(
const int32 FromIndex, |
Facades/PVBranchFacade.h | ||
virtual int32 GetElementCount() |
Facades/PVBranchFacade.h | ||
virtual void RemoveEntries
(
const int32 NumEntries, |
Facades/PVBranchFacade.h |