Navigation
API > API/Plugins > API/Plugins/PCG
Apply some noise to an attribute/property. You can select the mode you want and a noise range. Support all numerical types and vectors/rotators.
| Name | UPCGAttributeNoiseSettings |
| Type | class |
| Header File | /Engine/Plugins/PCG/Source/PCG/Public/Elements/PCGAttributeNoise.h |
| Include Path | #include "Elements/PCGAttributeNoise.h" |
Syntax
UCLASS (MinimalAPI, BlueprintType, ClassGroup=(Procedural))
class UPCGAttributeNoiseSettings : public UPCGSettings
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UPCGData → UPCGSettingsInterface → UPCGSettings → UPCGAttributeNoiseSettings
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UPCGAttributeNoiseSettings() |
Elements/PCGAttributeNoise.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bClampResult | bool | Clamp the result between 0 and 1. Always applied if we apply noise to the density. | Elements/PCGAttributeNoise.h |
|
| bHasCustomSeedSource | bool | Elements/PCGAttributeNoise.h |
|
|
| bHasSpatialToPointDeprecation | bool | Hidden value to indicate that Spatial -> Point deprecation is on where pins are not explicitly points. | Elements/PCGAttributeNoise.h | |
| bInvertSource | bool | Attribute = 1 - Attribute before applying the operation | Elements/PCGAttributeNoise.h |
|
| CustomSeedSource | FPCGAttributePropertyInputSelector | Elements/PCGAttributeNoise.h |
|
|
| InputSource | FPCGAttributePropertyInputSelector | Elements/PCGAttributeNoise.h |
|
|
| Mode | EPCGAttributeNoiseMode | Attribute = (Original op Noise), Noise in [NoiseMin, NoiseMax] | Elements/PCGAttributeNoise.h |
|
| NoiseMax | float | Elements/PCGAttributeNoise.h |
|
|
| NoiseMin | float | Elements/PCGAttributeNoise.h |
|
|
| OutputTarget | FPCGAttributePropertyOutputSelector | Elements/PCGAttributeNoise.h |
|
Functions
Public
Overridden from UPCGSettings
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
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/PCGAttributeNoise.h | |
virtual void ApplyPreconfiguredSettings
(
const FPCGPreConfiguredSettingsInfo& PreconfigureInfo |
Elements/PCGAttributeNoise.h | ||
virtual FName GetDefaultNodeName() |
Elements/PCGAttributeNoise.h | ||
virtual FText GetDefaultNodeTitle() |
Elements/PCGAttributeNoise.h | ||
virtual TArray< FPCGPreConfiguredSettingsInfo > GetPreconfiguredInfo() |
Expose 2 nodes: Density noise and Attribute Noise that will not have the same defaults. | Elements/PCGAttributeNoise.h | |
virtual EPCGSettingsType GetType() |
Elements/PCGAttributeNoise.h | ||
virtual bool GroupPreconfiguredSettings() |
If there are preconfigured info, decide if they are grouped in the palette in a folder with the node name, or if they are not grouped. | Elements/PCGAttributeNoise.h | |
virtual bool HasDynamicPins() |
If the node has any dynamic pins that can change based on input or settings | Elements/PCGAttributeNoise.h | |
virtual bool OnlyExposePreconfiguredSettings() |
If there are preconfigured info, we can skip the default settings and only expose pre-configured actions in the editor palette | Elements/PCGAttributeNoise.h | |
virtual bool UseSeed () |
By default, settings do not use a seed. | Elements/PCGAttributeNoise.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void PostLoad() |
Elements/PCGAttributeNoise.h |
Protected
Overridden from UPCGSettings
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FPCGElementPtr CreateElement() |
Elements/PCGAttributeNoise.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/PCGAttributeNoise.h | |
virtual TArray< FPCGPinProperties > OutputPinProperties() |
Elements/PCGAttributeNoise.h |
Deprecated Variables
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bInvertSourceDensity_DEPRECATED | bool | Elements/PCGAttributeNoise.h | ||
| bOutputTargetDifferentFromInputSource_DEPRECATED | bool | Elements/PCGAttributeNoise.h | ||
| DensityMode_DEPRECATED | EPCGAttributeNoiseMode | Previous names. | Elements/PCGAttributeNoise.h | |
| DensityNoiseMax_DEPRECATED | float | Elements/PCGAttributeNoise.h | ||
| DensityNoiseMin_DEPRECATED | float | Elements/PCGAttributeNoise.h |