Skip to main content

Circle

Base:
UBlueprintFunctionLibrary
Type:
UNCirclePickerLibrary / FNCirclePicker
Header File:
NexusActorPools/Public/NCirclePickerLibrary.h

Provides various functions for generating points in the plane of a circle using different random generation strategies (deterministic, non-deterministic, seeded).

The UNCirclePickerLibrary wraps the native FNCirclePicker functionality in a Blueprint friendly manner. Should you be wanting to utilize a picker in native code it is best to directly reference FNCirclePicker directly to avoid the abstraction layer as it has a similar API.

Methods​

Next Point (IO)​

Circle: Next Point

Generates a deterministic point [i]nside or [o]n the perimeter of a circle.

info

Uses FNRandom::Deterministic to ensure reproducible results.

Next Point Projected (IO)​

Circle: Next Point Projected

Generates a deterministic point [i]nside or [o]n the perimeter of a circle, then projects it to the world. The point is projected in the given direction until it hits something in the world.

info

Uses FNRandom::Deterministic to ensure reproducible results.

Random Point (IO)​

Circle: Random Point

Generates a random point [i]nside or [o]n the perimeter of a circle. Uses the non-deterministic random generator for true randomness.

Random Point Projected (IO)​

Circle: Random Point Projected

Generates a random point [i]nside or [o]n the perimeter of a circle, then projects it to the world. The point is projected in the given direction until it hits something in the world.

Random One-Shot Point (IO)​

Circle: Random One-Shot Point

Generates a random point [i]nside or [o]n the perimeter of a circle using a provided seed. Useful for one-time random point generation with reproducible results.

Random One-Shot Point Projected (IO)​

Circle: Random One-Shot Point Projected

Generates a random point [i]nside or [o]n the perimeter of a circle using a provided seed, then projects it to the world. The point is projected in the given direction until it hits something in the world.

Random Tracked Point (IO)​

Circle: Random Tracked Point

Generates a random point [i]nside or [o]n the perimeter of a circle while tracking the random seed state. Updates the seed value to enable sequential random point generation.

Random Tracked Point Projected (IO)​

Circle: Random Tracked Point Projected

Generates a random point [i]nside or [o]n the perimeter of a circle while tracking the random seed state, then projects it to the world. Updates the seed value to enable sequential random point generation. The point is projected in the given direction until it hits something in the world.

Parameters​

VariantParameterTypeDescriptionDefault
BaseOriginFVector&The center world point of the circle.
BaseMinimumRadiusfloatThe minimum radius of the circle (inner bound).
BaseMaximumRadiusfloatThe maximum radius of the circle (outer bound).
BaseRotationFRotatorOptional rotation to apply to the circle planeFRotator::ZeroRotator
ProjectedWorldContextObjectUObject*Object that provides access to the world, usally auto-filled in Blueprint.WorldContext
ProjectedProjectionFVectorDirection and distance for the line trace.FVector(0,0,-500.f)
ProjectedCollisionChannelECollisionChannelThe collision channel to use for tracing.ECC_WorldStatic
TrackedSeedint32&The seed to be used when generating, and altered for determinism.
One-ShotSeedint32The throw-away seed used when generating.