1. Epic GamesDeveloper
  3. UPCGMeshSamplerSettings

UPCGMeshSamplerSettings

Sample points on a mesh.

API > API/Plugins > API/Plugins/PCGGeometryScriptInterop

Sample points on a mesh.

   
Name UPCGMeshSamplerSettings
Type class
Header File /Engine/Plugins/PCGInterops/PCGGeometryScriptInterop/Source/PCGGeometryScriptInterop/Public/Elements/PCGMeshSampler.h
Include Path #include "Elements/PCGMeshSampler.h"

Syntax

UCLASS (MinimalAPI, BlueprintType, ClassGroup=(Procedural))  
class UPCGMeshSamplerSettings : public UPCGSettings

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UPCGMeshSamplerSettings()

   Elements/PCGMeshSampler.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bExtractMeshFromInput bool Can provide a list of inputs to sample the meshes from. Elements/PCGMeshSampler.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Settings"
bExtractUVAsAttribute bool   Elements/PCGMeshSampler.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Settings|UVs"
  • Meta=(PCG_Overridable, EditCondition="SamplingMethod != EPCGMeshSamplingMethod::OnePointPerVertex")
bOutputMaterialInfo bool   Elements/PCGMeshSampler.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Settings|Extra"
  • Meta=(PCG_Overridable, EditCondition="SamplingMethod != EPCGMeshSamplingMethod::OnePointPerVertex")
bOutputTriangleIds bool   Elements/PCGMeshSampler.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Settings|Extra"
  • Meta=(PCG_Overridable, EditCondition="SamplingMethod != EPCGMeshSamplingMethod::OnePointPerVertex")
bRemoveHiddenTriangles bool Post-processing pass after voxelization to remove hidden triangles. Elements/PCGMeshSampler.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Settings|Voxelize Options"
  • Meta=(PCG_Overridable, EditCondition="bVoxelize")
bSynchronousLoad bool   Elements/PCGMeshSampler.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Settings|Debug"
bUseColorChannelAsDensity bool Will extract the color channel into the density. Elements/PCGMeshSampler.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Settings|Color & Density"
  • Meta=(PCG_Overridable, InlineEditConditionToggle, PCG_OverrideAliases="bUseRedAsDensity")
bVoxelize bool Enable voxelisation as a preparation pass. Can be more expensive given the VoxelSize. Elements/PCGMeshSampler.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Settings|Voxelize Options"
  • Meta=(PCG_Overridable)
ColorChannelAsDensity EPCGColorChannel   Elements/PCGMeshSampler.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Settings|Color & Density"
  • Meta=(PCG_Overridable, EditCondition="bUseColorChannelAsDensity")
InputSource FPCGAttributePropertyInputSelector Selector to read data from. Elements/PCGMeshSampler.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Settings"
  • Meta=(PCG_Overridable, EditCondition="bExtractMeshFromInput", EditConditionHides, ShowAfter="bExtractMeshFromInput")
MaterialAttributeName FName   Elements/PCGMeshSampler.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Settings|Extra"
  • Meta=(PCG_Overridable, EditCondition="SamplingMethod != EPCGMeshSamplingMethod::OnePointPerVertex && bOutputMaterialInfo", EditConditionHides)
MaterialIdAttributeName FName   Elements/PCGMeshSampler.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Settings|Extra"
  • Meta=(PCG_Overridable, EditCondition="SamplingMethod != EPCGMeshSamplingMethod::OnePointPerVertex && bOutputMaterialInfo", EditConditionHides)
NonUniformSamplingOptions FGeometryScriptNonUniformPointSamplingOptions   Elements/PCGMeshSampler.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Settings|Poisson sampling"
  • Meta=(PCG_Overridable, EditCondition="SamplingMethod == EPCGMeshSamplingMethod::PoissonSampling")
PointSteepness float Each PCG point represents a discretized, volumetric region of world space. Elements/PCGMeshSampler.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Settings|Points"
  • Meta=(ClampMin="0", ClampMax="1", PCG_Overridable)
RequestedLODIndex int32   Elements/PCGMeshSampler.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Settings|LODSettings"
  • Meta=(PCG_Overridable)
RequestedLODType EGeometryScriptLODType LOD type to use when creating DynamicMesh from specified StaticMesh. Elements/PCGMeshSampler.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Settings|LODSettings"
  • Meta=(PCG_Overridable)
SamplingMethod EPCGMeshSamplingMethod   Elements/PCGMeshSampler.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Settings"
SamplingOptions FGeometryScriptMeshPointSamplingOptions Poisson Sampling parameters. Elements/PCGMeshSampler.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Settings|Poisson sampling"
  • Meta=(PCG_Overridable, EditCondition="SamplingMethod == EPCGMeshSamplingMethod::PoissonSampling")
StaticMesh TSoftObjectPtr< UStaticMesh > Soft Object Path to the mesh to sample from. Will be loaded. Elements/PCGMeshSampler.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Settings"
  • Meta=(PCG_Overridable, EditCondition="!bExtractMeshFromInput", EditConditionHides, ShowAfter="bExtractMeshFromInput")
TriangleIdAttributeName FName   Elements/PCGMeshSampler.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Settings|Extra"
  • Meta=(PCG_Overridable, EditCondition="SamplingMethod != EPCGMeshSamplingMethod::OnePointPerVertex && bOutputTriangleIds", EditConditionHides)
UVAttributeName FName   Elements/PCGMeshSampler.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Settings|UVs"
  • Meta=(PCG_Overridable, EditCondition="SamplingMethod != EPCGMeshSamplingMethod::OnePointPerVertex && bExtractUVAsAttribute", EditConditionHides)
UVChannel int32   Elements/PCGMeshSampler.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Settings|UVs"
  • Meta=(PCG_Overridable, EditCondition="SamplingMethod != EPCGMeshSamplingMethod::OnePointPerVertex && bExtractUVAsAttribute", EditConditionHides)
VoxelSize float Size of a voxel for the voxelization. Elements/PCGMeshSampler.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Settings|Voxelize Options"
  • Meta=(PCG_Overridable, EditCondition="bVoxelize")

Functions

Public

Overridden from UPCGSettings

Name Remarks Include Path Unreal Specifiers

virtual bool CanDynamicallyTrackKeys()

   Elements/PCGMeshSampler.h  

virtual FName GetDefaultNodeName()

   Elements/PCGMeshSampler.h  

virtual FText GetDefaultNodeTitle()

   Elements/PCGMeshSampler.h  

virtual FText GetNodeTooltipText()

   Elements/PCGMeshSampler.h  

virtual void GetStaticTrackedKeys ( FPCGSelectionKeyToSettingsMap& OutKeysToSettings,
TArray< TObjectPtr< const UPCGGraph > >& OutVisitedGraphs
) const

   Elements/PCGMeshSampler.h  

virtual EPCGSettingsType GetType()

   Elements/PCGMeshSampler.h  

virtual TArray< FPCGPinProperties > InputPinProperties()

   Elements/PCGMeshSampler.h  

virtual TArray< FPCGPinProperties > OutputPinProperties()

   Elements/PCGMeshSampler.h  

virtual bool UseSeed()

   Elements/PCGMeshSampler.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostLoad()

   Elements/PCGMeshSampler.h  

Protected

Overridden from UPCGSettings

Name Remarks Include Path Unreal Specifiers

virtual FPCGElementPtr CreateElement()

   Elements/PCGMeshSampler.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
bUseRedAsDensity_DEPRECATED bool   Elements/PCGMeshSampler.h  
StaticMeshPath_DEPRECATED FSoftObjectPath Deprecated in UE 5.3 in favor of StaticMesh. Elements/PCGMeshSampler.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page