Navigation
API > API/Plugins > API/Plugins/PCG
| Name | UPCGSurfaceSamplerSettings |
| Type | class |
| Header File | /Engine/Plugins/PCG/Source/PCG/Public/Elements/PCGSurfaceSampler.h |
| Include Path | #include "Elements/PCGSurfaceSampler.h" |
Syntax
UCLASS (MinimalAPI, BlueprintType, ClassGroup=(Procedural))
class UPCGSurfaceSamplerSettings : public UPCGSettings
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UPCGData → UPCGSettingsInterface → UPCGSettings → UPCGSurfaceSamplerSettings
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UPCGSurfaceSamplerSettings() |
Elements/PCGSurfaceSampler.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bApplyDensityToPoints | bool | Elements/PCGSurfaceSampler.h |
|
|
| bKeepZeroDensityPoints | bool | Elements/PCGSurfaceSampler.h |
|
|
| bUnbounded | bool | If no Bounding Shape input is provided, the actor bounds are used to limit the sample generation domain. | Elements/PCGSurfaceSampler.h |
|
| bUseLegacyGridCreationMethod | bool | Controls whether the prior grid creation mechanism (with cells being extents * (1 + steepness), then filtered by points by squared meters) is used. | Elements/PCGSurfaceSampler.h |
|
| Looseness | float | Controls how points are placed in their cell with 0 being in the center and 1 being anywhere inside the full cell size. | Elements/PCGSurfaceSampler.h |
|
| PointExtents | FVector | Extents of the points to create (e.g. half their total size) | Elements/PCGSurfaceSampler.h |
|
| PointsPerSquaredMeter | float | Controls the grid cell size, down to a minimum size defined by the Point Extents. | Elements/PCGSurfaceSampler.h |
|
| PointSteepness | float | Each PCG point represents a discretized, volumetric region of world space. | Elements/PCGSurfaceSampler.h |
|
Functions
Public
Overridden from UPCGSettings
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void ApplyDeprecation
(
UPCGNode* InOutNode |
Any final migration/recovery that can be done after pins are finalized. | Elements/PCGSurfaceSampler.h | |
virtual void ApplyDeprecationBeforeUpdatePins
(
UPCGNode* InOutNode, |
UpdatePins will kick off invalid edges, so this is useful for moving edges around in case of pin changes. | Elements/PCGSurfaceSampler.h | |
virtual FName GetDefaultNodeName() |
Elements/PCGSurfaceSampler.h | ||
virtual FText GetDefaultNodeTitle() |
Elements/PCGSurfaceSampler.h | ||
virtual FText GetNodeTooltipText() |
Elements/PCGSurfaceSampler.h | ||
virtual EPCGSettingsType GetType() |
Elements/PCGSurfaceSampler.h | ||
virtual bool IsPinUsedByNodeExecution
(
const UPCGPin* InPin |
Returns true if InPin is in use by node (assuming node enabled). | Elements/PCGSurfaceSampler.h | |
virtual bool UseSeed () |
By default, settings do not use a seed. | Elements/PCGSurfaceSampler.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void PostLoad() |
Elements/PCGSurfaceSampler.h | ||
virtual void Serialize
(
FArchive& Ar |
Elements/PCGSurfaceSampler.h |
Protected
Overridden from UPCGSettings
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FPCGElementPtr CreateElement() |
Elements/PCGSurfaceSampler.h | ||
virtual TArray< FPCGPinProperties > InputPinProperties() |
Returns an array of all the input pin properties. You should not add manually a "params" pin, it is handled automatically by FillOverridableParamsPins. | Elements/PCGSurfaceSampler.h | |
virtual TArray< FPCGPinProperties > OutputPinProperties() |
Elements/PCGSurfaceSampler.h |
Deprecated Variables
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| PointRadius_DEPRECATED | float | Elements/PCGSurfaceSampler.h |