Skip to content

URotationActuator

Rotation actuator that applies rotation changes to an Actor.

Accepts a BoxPoint action where each dimension corresponds to Pitch, Yaw, or Roll rotation. Rotation can be applied as raw delta values or normalized [0,1] values that are rescaled.

class URotationActuator : public UActorComponent, public IScholaActuator

Methods

GetActionSpace_Implementation

virtual void
GetActionSpace_Implementation(FInstancedStruct &OutActionSpace) const

Get the action space for this actuator.

Parameters

  • OutActionSpace (FInstancedStruct)

ConvertActionToFRotator

FRotator ConvertActionToFRotator(const FBoxPoint &Action)

Convert a Box Point with values to an FRotator.

Parameters

  • Action (const FBoxPoint)

TakeAction_Implementation

virtual void TakeAction_Implementation(const FInstancedStruct &InAction)

Apply a rotation action to the owner actor.

Parameters

  • InAction (const FInstancedStruct)

GenerateId

FString GenerateId() const

Generate a unique ID string for this actuator.

Attributes

FBoxSpaceDimension

FBoxSpaceDimension PitchBounds = FBoxSpaceDimension(-180, 180)

The Min/Max value for the Pitch of the tracked rotation (rotation around Y-axis)

Parameters

  • -180

  • 180


FBoxSpaceDimension

FBoxSpaceDimension RollBounds = FBoxSpaceDimension(-180, 180)

The Min/Max value for the Roll of the tracked rotation (rotation around X-axis)

Parameters

  • -180

  • 180


FBoxSpaceDimension

FBoxSpaceDimension YawBounds = FBoxSpaceDimension(-180, 180)

The Min/Max value for the Yaw of the tracked rotation (rotation around Z-axis)

Parameters

  • -180

  • 180


bHasPitch

bool bHasPitch = true

Toggle for whether this actuator rotates the Agent along the Pitch dimension.


bHasRoll

bool bHasRoll = true

Toggle for whether this actuator rotates the Agent along the Roll dimension.


bHasYaw

bool bHasYaw = true

Toggle for whether this actuator rotates the Agent along the Yaw dimension.


TeleportType

ETeleportType TeleportType = ETeleportType::None

Type of teleportation to use.


bSweep

bool bSweep

Toggle for whether to sweep while teleporting the actor.


bNormalizeAndRescale

bool bNormalizeAndRescale = false

Toggle for whether to use a [0,1] scale that is then rescaled onto the whole range for each rotator.


OnRotationDelegate

FOnRotationInputSignature OnRotationDelegate

A delegate invoked when this actuator receives input from a brain.

Source: Source/ScholaInteractors/Public/Actuators/RotationActuator.h