FTaperedCylinderSpecializeSamplingHelper::ComputeGoldenSpiralPoints

Use the golden spiral method to generate evenly spaced points on a tapered cylinder (truncated cone).

Windows
MacOS
Linux

References

Module

Chaos

Header

/Engine/Source/Runtime/Experimental/Chaos/Public/Chaos/TaperedCylinder.h

Include

#include "Chaos/TaperedCylinder.h"

Syntax

static void ComputeGoldenSpiralPoints
(
    TArray< FVec3 > & Points,
    const FVec3 & Origin,
    const FVec3 & Axis,
    const FReal Radius1,
    const FReal Radius2,
    const FReal Height,
    const int32 NumPoints,
    const bool IncludeEndCaps,
    int32 SpiralSeed
)

Remarks

Use the golden spiral method to generate evenly spaced points on a tapered cylinder (truncated cone).

The "golden" part is derived from the golden ratio; stand at the center, turn a golden ratio of whole turns, then emit a point in that direction.

Points are generated starting from the bottom of the cylinder, ending at the top. Contiguous entries in `Points_ generally will not be spatially adjacent.

Points_ to append to. Origin is the bottom-most point of the tapered cylinder. `Axis is the orientation of the tapered cylinder. Radius1_ is the first radius of the tapered cylinder. Radius2 is the second radius of the tapered cylinder. `Height is the height of the tapered cylinder. NumPoints_ is the number of points to generate. IncludeEndCaps determines whether or not points are generated on the end caps of the tapered cylinder. `SpiralSeed is the starting index for golden spiral generation. When using this method to continue a spiral started elsewhere, `SpiralSeed_ should equal the number of particles already created.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss