UBoxFalloff

API > API/Runtime > API/Runtime/FieldSystemEngine

BoxFalloff


Name	UBoxFalloff
Type	class
Header File	/Engine/Source/Runtime/Experimental/FieldSystem/Source/FieldSystemEngine/Public/Field/FieldSystemObjects.h
Include Path	#include "Field/FieldSystemObjects.h"

Syntax

UCLASS (ClassGroup="Field",  
       Meta=(BlueprintSpawnableComponent, ToolTip="Box scalar field that will be defined only within a box"),  
       ShowCategories=("Field"), MinimalAPI)  
class UBoxFalloff : public UFieldNodeFloat

Inheritance Hierarchy

UObjectBase → UObjectBaseUtility → UObject → UActorComponent → UFieldNodeBase → UFieldNodeFloat → UBoxFalloff

Implements Interfaces

Constructors

Name	Remarks	Include Path	Unreal Specifiers
UBoxFalloff()		Field/FieldSystemObjects.h

Destructors

Name	Remarks	Include Path	Unreal Specifiers
virtual ~UBoxFalloff()		Field/FieldSystemObjects.h

Variables

Public

Name	Type	Remarks	Include Path	Unreal Specifiers
Default	float	The field value will be set to Default if the sample distance from the box is higher than the scale of the transform	Field/FieldSystemObjects.h	BlueprintReadWrite EditAnywhere Category="Field" DisplayName="Default Value"
Falloff	TEnumAsByte< EFieldFalloffType >	Type of falloff function used to model the evolution of the field from the box surface to the sample position	Field/FieldSystemObjects.h	BlueprintReadWrite EditAnywhere Category="Field" DisplayName="Falloff Type"
Magnitude	float	Magnitude of the box falloff field	Field/FieldSystemObjects.h	BlueprintReadWrite EditAnywhere Category="Field" DisplayName="Field Magnitude"
MaxRange	float	The initial function value between 0 and 1 will be scaled between MinRange and MaxRange before being multiplied by magnitude	Field/FieldSystemObjects.h	BlueprintReadWrite EditAnywhere Category="Field" DisplayName="Max Range"
MinRange	float	The initial function value between 0 and 1 will be scaled between MinRange and MaxRange before being multiplied by magnitude	Field/FieldSystemObjects.h	BlueprintReadWrite EditAnywhere Category="Field" DisplayName="Min Range"
Transform	FTransform	Translation, Rotation and Scale of the unit box	Field/FieldSystemObjects.h	BlueprintReadWrite EditAnywhere Category="Field" DisplayName="Box Transform"

Functions

Public

Name	Remarks	Include Path	Unreal Specifiers
UBoxFalloff * SetBoxFalloff ( float Magnitude, float MinRange, float MaxRange, float Default, FTransform Transform, EFieldFalloffType Falloff )	Box scalar field that will be defined only within a box	Field/FieldSystemObjects.h	BlueprintPure Category="Field" Meta=(Magnitude="1.0", MinRange="0.0", MaxRange="1.0")

Overridden from UFieldNodeBase

Name	Remarks	Include Path	Unreal Specifiers
virtual FFieldNodeBase * NewEvaluationGraph ( TArray< const UFieldNodeBase* >& Nodes ) const		Field/FieldSystemObjects.h

Can't find any content

Navigation

Syntax

Inheritance Hierarchy

Implements Interfaces

Constructors

Destructors

Variables

Public

Functions

Public

Overridden from UFieldNodeBase