1. Epic GamesDeveloper
  3. ProceduralVegetation

ProceduralVegetation

API > API/Plugins

   
Name ProceduralVegetation
Type Editor
Location /Engine/Plugins/Experimental/ProceduralVegetationEditor/Source/ProceduralVegetation/
Module Build Rules ProceduralVegetation.Build.cs

Classes

Name Remarks
FBoneFacade FBoneFacade is used to access and manipulate the Bone data from Bones Group with in the ProceduralVegetation's FManagedArrayCollection.
FBranchFacade 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.
FFoliageFacade FFoliageFacade is used to access and manipulate Foliage related data for a ProceduralVegetation's FManagedArrayCollection It presents access to foliage Mesh names, their respective Branch ids, and instancing transform data (Pivot point, Up Vector, and Scale) It lays out data in two Groups: FoliageNames and Foliage where Foliage references FoliageNames and Branch/Primitives with Ids It also adds Foliage entry Ids to the Branch/Primitives group.
FMetaInfoFacade  
FPlantFacade FPlantFacade is used to access and manipulate the data from Plants Group with in the ProceduralVegetation's FManagedArrayCollection A ProceduralVegetation asset can consist of multiple plants.
FPlantProfileFacade FTrunkProfileFacade is used to access and manipulate Trunk profile data for a ProceduralVegetation's FManagedArrayCollection
FPointFacade FPointFacade is used to access and manipulate the Point Group data from the ProceduralVegetation's FManagedArrayCollection Only add the frequently used Point attributes and their access to this facade, for the specific access write a new facade
FProceduralVegetationModule  
FPVBaseElement  
FPVOutputElement  
FPVRenderingFacade FPVRenderingFacade is used to build a collection that contains the render data required to render Procedural Vegetation Add functions to access and modify render data for Procedural Vegetation
UPlantProfileAsset  
UProceduralVegetation Asset type for procedural plant generation
UProceduralVegetationGraph  
UProceduralVegetationLink  
UProceduralVegetationPreset  
UPVBaseSettings  
UPVData  
UPVFoliageMeshData  
UPVGrowthData  
UPVMeshData  
UPVOutputSettings  
UPVWindSettings  

Structs

Name Remarks
FBoneNode FBoneNode contains the bone data and linked point and branch ids
FFoliageEntryData  
FPlantProfile  
FPVDataTypeInfoFoliageMesh  
FPVDataTypeInfoGrowth  
FPVDataTypeInfoMesh  
FPVDebugSettings  
FPVExportParams  
FPVFloatRamp  
FPVPresetVariationInfo  
FPVVisualizationSettings  

Interfaces

Name Remarks
IShrinkable Any Facade can implement IShrinkable to provide capability of removing arbitrary elements from the underlying Collection/Group in an optimal way.

Typedefs

Name Type Remarks Include Path
FFoliageComponentCreatedCallback TBaseDelegate_OneParam< void, UMeshComponent * >   Helpers/PVUtilities.h

Enums

Public

Name Remarks
EPVAssetReplacePolicy  
EPVCollisionGeneration  
EPVDebugType  
EPVDebugValueVisualizationMode  
EPVExportMeshType Copyright Epic Games, Inc. All Rights Reserved.
EPVRenderType  
PV::Analytics::EExportResult  

Constants

Name Type Remarks Include Path
PV::AttributeNames::BoneAbsolutePosition const FName   Facades/PVAttributesNames.h
PV::AttributeNames::BoneBranchIndex const FName   Facades/PVAttributesNames.h
PV::AttributeNames::BoneId const FName   Facades/PVAttributesNames.h
PV::AttributeNames::BoneName const FName Bone Attributes. Facades/PVAttributesNames.h
PV::AttributeNames::BoneParentIndex const FName   Facades/PVAttributesNames.h
PV::AttributeNames::BonePointIndex const FName   Facades/PVAttributesNames.h
PV::AttributeNames::BonePose const FName   Facades/PVAttributesNames.h
PV::AttributeNames::BranchChildren const FName   Facades/PVAttributesNames.h
PV::AttributeNames::BranchFoliageIDs const FName   Facades/PVAttributesNames.h
PV::AttributeNames::BranchGradient const FName   Facades/PVAttributesNames.h
PV::AttributeNames::BranchHierarchyNumber const FName   Facades/PVAttributesNames.h
PV::AttributeNames::BranchNumber const FName   Facades/PVAttributesNames.h
PV::AttributeNames::BranchParentNumber const FName   Facades/PVAttributesNames.h
PV::AttributeNames::BranchParents const FName Branch Attributes. Facades/PVAttributesNames.h
PV::AttributeNames::BranchPoints const FName   Facades/PVAttributesNames.h
PV::AttributeNames::BranchSimulationGroupIndex const FName   Facades/PVAttributesNames.h
PV::AttributeNames::BranchSourceBudNumber const FName   Facades/PVAttributesNames.h
PV::AttributeNames::BranchUVMaterial const FName   Facades/PVAttributesNames.h
PV::AttributeNames::BudDevelopment const FName   Facades/PVAttributesNames.h
PV::AttributeNames::BudDirection const FName   Facades/PVAttributesNames.h
PV::AttributeNames::BudHormoneLevels const FName   Facades/PVAttributesNames.h
PV::AttributeNames::BudLightDetected const FName   Facades/PVAttributesNames.h
PV::AttributeNames::BudNumber const FName   Facades/PVAttributesNames.h
PV::AttributeNames::FoliageBranchID const FName   Facades/PVAttributesNames.h
PV::AttributeNames::FoliageLengthFromRoot const FName   Facades/PVAttributesNames.h
PV::AttributeNames::FoliageName const FName FoliageNames Attributes. Facades/PVAttributesNames.h
PV::AttributeNames::FoliageNameID const FName Foliage Attributes. Facades/PVAttributesNames.h
PV::AttributeNames::FoliageNormalVector const FName   Facades/PVAttributesNames.h
PV::AttributeNames::FoliageParentBoneID const FName   Facades/PVAttributesNames.h
PV::AttributeNames::FoliagePath const FName   Facades/PVAttributesNames.h
PV::AttributeNames::FoliagePivotPoint const FName   Facades/PVAttributesNames.h
PV::AttributeNames::FoliageScale const FName   Facades/PVAttributesNames.h
PV::AttributeNames::FoliageUPVector const FName   Facades/PVAttributesNames.h
PV::AttributeNames::GroundGradient const FName   Facades/PVAttributesNames.h
PV::AttributeNames::Guid const FName   Facades/PVAttributesNames.h
PV::AttributeNames::HullGradient const FName   Facades/PVAttributesNames.h
PV::AttributeNames::LeafPhyllotaxy const FName Details Attributes. Facades/PVAttributesNames.h
PV::AttributeNames::LengthFromRoot const FName   Facades/PVAttributesNames.h
PV::AttributeNames::LengthFromSeed const FName   Facades/PVAttributesNames.h
PV::AttributeNames::MainTrunkGradient const FName   Facades/PVAttributesNames.h
PV::AttributeNames::NjordPixelId const FName   Facades/PVAttributesNames.h
PV::AttributeNames::NjordPixelIndex const FName   Facades/PVAttributesNames.h
PV::AttributeNames::PlantGradient const FName   Facades/PVAttributesNames.h
PV::AttributeNames::PlantNumber const FName   Facades/PVAttributesNames.h
PV::AttributeNames::PointPosition const FName Point Attributes. Facades/PVAttributesNames.h
PV::AttributeNames::PointScale const FName   Facades/PVAttributesNames.h
PV::AttributeNames::PointScaleGradient const FName   Facades/PVAttributesNames.h
PV::AttributeNames::ProfilePoints const FName PlantProfiles Attributes. Facades/PVAttributesNames.h
PV::AttributeNames::TextureCoordUOffset const FName   Facades/PVAttributesNames.h
PV::AttributeNames::TextureCoordV const FName   Facades/PVAttributesNames.h
PV::AttributeNames::TrunkMaterialPath const FName   Facades/PVAttributesNames.h
PV::AttributeNames::TrunkURange const FName   Facades/PVAttributesNames.h
PV::AttributeNames::URange const FName   Facades/PVAttributesNames.h
PV::AttributeNames::VertexPointIds const FName   Facades/PVAttributesNames.h
PV::GroupNames::BonesGroup const FName   Facades/PVAttributesNames.h
PV::GroupNames::BranchGroup const FName Group Names. Facades/PVAttributesNames.h
PV::GroupNames::DetailsGroup const FName   Facades/PVAttributesNames.h
PV::GroupNames::FoliageGroup const FName   Facades/PVAttributesNames.h
PV::GroupNames::FoliageNamesGroup const FName   Facades/PVAttributesNames.h
PV::GroupNames::PlantProfilesGroup const FName   Facades/PVAttributesNames.h
PV::GroupNames::PointGroup const FName   Facades/PVAttributesNames.h
PV::GroupNames::VerticesGroup const FName   Facades/PVAttributesNames.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool operator! ( EPVRenderType E
)

   DataTypes/PVData.h  

EPVRenderType operator& ( EPVRenderType Lhs,
EPVRenderType Rhs
)

   DataTypes/PVData.h  

EPVRenderType & operator&= ( EPVRenderType& Lhs,
EPVRenderType Rhs
)

   DataTypes/PVData.h  

EPVRenderType operator^ ( EPVRenderType Lhs,
EPVRenderType Rhs
)

   DataTypes/PVData.h  

EPVRenderType & operator^= ( EPVRenderType& Lhs,
EPVRenderType Rhs
)

   DataTypes/PVData.h  

EPVRenderType operator| ( EPVRenderType Lhs,
EPVRenderType Rhs
)

   DataTypes/PVData.h  

EPVRenderType & operator|= ( EPVRenderType& Lhs,
EPVRenderType Rhs
)

   DataTypes/PVData.h  

EPVRenderType operator~ ( EPVRenderType E
)

   DataTypes/PVData.h  

Static

Name Remarks Include Path Unreal Specifiers

static void PV::FillAttributes ( FManagedArrayCollection& Collection,
const FName Group,
const TSharedPtr< FJsonObject >& AttributesObject
)

   Helpers/PVJSONHelper.h  

static void PV::FillDetailsAttributes ( FManagedArrayCollection& Collection,
const FName Group,
const TSharedPtr< FJsonObject >& AttributesObject
)

   Helpers/PVJSONHelper.h  

static void PV::FillFoliageData ( FManagedArrayCollection& Collection,
const TSharedPtr< FJsonObject >& PrimitiveAttributesObject,
const FString& InPath
)

   Helpers/PVJSONHelper.h  

static void PV::FillPlantProfilesData ( FManagedArrayCollection& Collection,
const FName Group,
const TSharedPtr< FJsonObject >& AttributesObject
)

   Helpers/PVJSONHelper.h  

static bool PV::HasJsonFieldPath ( const TSharedPtr< FJsonObject >& JsonObject,
const FString& Path
)

   Helpers/PVJSONHelper.h  

static bool PV::LoadMegaPlantsJsonToCollection ( FManagedArrayCollection& Collection,
const FString& FilePath,
FString& OutErrorMessage
)

   Helpers/PVJSONHelper.h  

static TSharedPtr< FJsonObject > PV::LoadMetaFileIntoJsonObject ( const FString& FilePath,
FString& OutErrorMessage
)

   Helpers/PVJSONHelper.h  

static bool PV::LoadMetaJsonToCollection ( FManagedArrayCollection& Collection,
TSharedPtr< FJsonObject > LoadedData
)

   Helpers/PVJSONHelper.h  

static void PV::SetFoliagePaths ( FManagedArrayCollection& Collection,
const FString& FilePath
)

   Helpers/PVJSONHelper.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page