unreal.PlanarVelocityArrayObservation
¶
- class unreal.PlanarVelocityArrayObservation(outer: Object | None = None, name: Name | str = 'None')¶
Bases:
LearningAgentsObservation
An observation of an array of velocities projected onto a plane.
C++ Source:
Plugin: LearningAgents
Module: LearningAgents
File: LearningAgentsObservations.h
Editor Properties: (see get_editor_property/set_editor_property)
interactor
(LearningAgentsInteractor): [Read-Only] Reference to the Interactor this observation is associated with.
- classmethod add_planar_velocity_array_observation(interactor, name='None', velocity_num=1, scale=200.000000, axis0=[1.000000, 0.000000, 0.000000], axis1=[0.000000, 1.000000, 0.000000]) PlanarVelocityArrayObservation ¶
Adds a new planar velocity observation to the given agent interactor. The axis parameters define the plane. Call during ULearningAgentsInteractor::SetupObservations event.
- Parameters:
interactor (LearningAgentsInteractor) – The agent interactor to add this observation to.
name (Name) – The name of this new observation. Used for debugging.
velocity_num (int32) – The number of velocities in the array.
scale (float) – Used to normalize the data for the observation.
axis0 (Vector) – The forward axis of the plane.
axis1 (Vector) – The right axis of the plane.
- Returns:
The newly created observation.
- Return type:
- set_planar_velocity_array_observation(agent_id=-1, velocities, relative_rotation=[0.000000, 0.000000, 0.000000]) None ¶
Sets the data for this observation. The relative rotation can be used to make this observation relative to the agent’s perspective, e.g. by passing the agent’s forward rotation. Call during ULearningAgentsInteractor::SetObservations event.