Navigation
API > API/Plugins > API/Plugins/AvalancheModifiers > API/Plugins/AvalancheModifiers/Modifiers
Inheritance Hierarchy
- UObject
- UActorModifierCoreBase
- UAvaBaseModifier
- UAvaGeometryBaseModifier
- UAvaSplineSweepModifier
References
| Module | AvalancheModifiers |
| Header | /Engine/Plugins/Experimental/Avalanche/Source/AvalancheModifiers/Public/Modifiers/AvaSplineSweepModifier.h |
| Include | #include "Modifiers/AvaSplineSweepModifier.h" |
Syntax
UCLASS (MinimalAPI, BlueprintType)
class UAvaSplineSweepModifier :
public UAvaGeometryBaseModifier ,
public IAvaRenderStateUpdateHandler
Variables
| Type | Name | Description | |
|---|---|---|---|
| bool | bCapped | Whether start and end are closed, loop must be false | |
| bool | bLooped | Whether we close the whole spline path, if spline loops this will be true | |
| float | ProgressEnd | Sample end range of the spline | |
| float | ProgressOffset | Sample range offset of the spline, for closed loop spline range can wrap around | |
| float | ProgressStart | Sample start range of the spline | |
| float | SampleDistance | Custom sample distance for steps per distance mode | |
| EAvaSplineSweepSampleMode | SampleMode | How do we sample the spline | |
| float | ScaleEnd | End scale of the spline mesh | |
| float | ScaleStart | Start scale of the spline mesh | |
| TWeakObjectPtr< AActor > | SplineActorWeak | Spline actor to retrieve the USplineComponent from | |
| TWeakObjectPtr< USplineComponent > | SplineComponentWeak | Spline component to sample from | |
| TArray< FTransform > | SplineSamples | Sample points taken from the spline | |
| int32 | Steps | The sample count defines the precision of the sweep |
Functions
| Type | Name | Description | |
|---|---|---|---|
| bool | GetCapped () |
||
| bool | GetLooped () |
||
| float | |||
| float | |||
| float | |||
| float | |||
| EAvaSplineSweepSampleMode | |||
| float | GetScaleEnd () |
||
| float | |||
| AActor * | |||
| TWeakObjectPtr< AActor > | |||
| int32 | GetSteps () |
||
| void | |||
| void | |||
| void | |||
| bool | SampleSpline () |
||
| void | SetCapped
(
bool bInCapped |
||
| void | SetLooped
(
bool bInLooped |
||
| void | SetProgressEnd
(
float InEnd |
||
| void | SetProgressOffset
(
float InOffset |
||
| void | SetProgressStart
(
float InStart |
||
| void | SetSampleDistance
(
float InDistance |
||
| void | SetSampleMode
(
EAvaSplineSweepSampleMode InMode |
||
| void | SetScaleEnd
(
float InScaleEnd |
||
| void | SetScaleStart
(
float InScaleStart |
||
| void | SetSplineActor
(
AActor* InActor |
||
| void | SetSplineActorWeak
(
TWeakObjectPtr< AActor > InSplineActorWeak |
||
| void |
Overridden from UActorModifierCoreBase
| Type | Name | Description | |
|---|---|---|---|
| void | Apply () |
Override in child classes, apply this modifier on the actual actor, call Next or Fail to complete the modifier execution | |
| void | OnModifierAdded
(
EActorModifierCoreEnableReason InReason |
Called after the modifier was added to a stack and initialized after creation or serialization or duplication | |
| void | OnModifierCDOSetup
(
FActorModifierCoreMetadata& InMetadata |
Override metadata for this modifier, called only once before modifier CDO is registered | |
| void | PostEditChangeProperty
(
FPropertyChangedEvent& InPropertyChangedEvent |
Overridden from IAvaRenderStateUpdateHandler
| Type | Name | Description | |
|---|---|---|---|
| void | OnActorVisibilityChanged
(
AActor* InActor |
Callback when a tracked actor visibility has changed | |
| void | OnRenderStateUpdated
(
AActor* InActor, |
Callback when a render state actor in this world changes |
Constants
| Name | Description |
|---|---|
| MaxSampleCount | |
| PropertyChangeDispatcher | Used for PECP |