Skip to content

Template Class TImitationScholaEnvironment

Template Class TImitationScholaEnvironment

  • Defined in File ImitationEnvironmentInterface.h

Inheritance Relationships

Base Types

template <typename T>
class TImitationScholaEnvironment : public TScriptInterface<T>,
public IImitationScholaEnvironment

Source: Source/Schola/Imitation/Public/Environment/ImitationEnvironmentInterface.h

Dependencies: FImitationAgentState, FInitialAgentState, FInteractionDefinition, IImitationScholaEnvironment, IMultiAgentImitationScholaEnvironment

Template wrapper that adapts Blueprint-implementable environment interfaces to IImitationScholaEnvironment.

This template bridges Blueprint-exposed environment implementations with the type-erased IImitationScholaEnvironment interface for polymorphic usage.

Template Parameters:

T – The Blueprint interface type (e.g., IMultiAgentImitationScholaEnvironment)


Public Functions

SymbolDetails
~TImitationScholaEnvironmentDefault destructor.
TImitationScholaEnvironmentConstructs the environment wrapper from a UObject implementing the interface.
InitializeEnvironmentInitialize the environment and retrieve agent definitions.
ResetReset the environment to its initial state.
StepExecute one step of the environment with expert demonstrations.
SetEnvironmentOptionsConfigure environment options.
SeedEnvironmentSet the random seed for the environment.

~TImitationScholaEnvironment

~TImitationScholaEnvironment() = default

Default destructor.

Source: Source/Schola/Imitation/Public/Environment/ImitationEnvironmentInterface.h

TImitationScholaEnvironment

inline TImitationScholaEnvironment(UObject *InObject)

Constructs the environment wrapper from a UObject implementing the interface.

Parameters

InObject – [in] The UObject that implements the environment interface

#DirectionNameTypeDescription
1InObjectUObject *The UObject that implements the environment interface

Attributes: inline

Source: Source/Schola/Imitation/Public/Environment/ImitationEnvironmentInterface.h

InitializeEnvironment

inline virtual void InitializeEnvironment(
TMap<FString, FInteractionDefinition> &OutDefinition) override

Initialize the environment and retrieve agent definitions.

Parameters

OutAgentDefinitions – [out] Map of agent names to their interaction definitions

#DirectionNameTypeDescription
1OutAgentDefinitionsTMap< FString, FInteractionDefinition > &Map of agent names to their interaction definitions

Attributes: inline, virtual

Source: Source/Schola/Imitation/Public/Environment/ImitationEnvironmentInterface.h

Reset

inline virtual void
Reset(TMap<FString, FInitialAgentState> &OutAgentState) override

Reset the environment to its initial state.

Parameters

OutAgentState – [out] Map of agent names to their initial states

#DirectionNameTypeDescription
1OutAgentStateTMap< FString, FInitialAgentState > &Map of agent names to their initial states

Attributes: inline, virtual

Source: Source/Schola/Imitation/Public/Environment/ImitationEnvironmentInterface.h

Step

inline virtual void
Step(TMap<FString, FImitationAgentState> &OutAgentStates) override

Execute one step of the environment with expert demonstrations.

Parameters

OutAgentStates – [out] Map of agent names to their imitation states

#DirectionNameTypeDescription
1OutAgentStatesTMap< FString, FImitationAgentState > &Map of agent names to their imitation states

Attributes: inline, virtual

Source: Source/Schola/Imitation/Public/Environment/ImitationEnvironmentInterface.h

SetEnvironmentOptions

inline virtual void
SetEnvironmentOptions(const TMap<FString, FString> &Options) override

Configure environment options.

Parameters

Options – [in] Map of option names to their string values

#DirectionNameTypeDescription
1Optionsconst TMap< FString, FString > &Map of option names to their string values

Attributes: inline, virtual

Source: Source/Schola/Imitation/Public/Environment/ImitationEnvironmentInterface.h

SeedEnvironment

inline virtual void SeedEnvironment(int Seed) override

Set the random seed for the environment.

Parameters

Seed – [in] The random seed value

#DirectionNameTypeDescription
1SeedintThe random seed value

Attributes: inline, virtual

Source: Source/Schola/Imitation/Public/Environment/ImitationEnvironmentInterface.h