CARLA
Public Member Functions | Protected Member Functions | List of all members
ACarlaActorFactoryBlueprint Class Reference

Base class for Blueprints implementing ACarlaActorFactory interface. More...

#include <CarlaActorFactoryBlueprint.h>

+ Inheritance diagram for ACarlaActorFactoryBlueprint:
+ Collaboration diagram for ACarlaActorFactoryBlueprint:

Public Member Functions

TArray< FActorDefinitionGetDefinitions () final
 Retrieve the list of actor definitions that this class is able to spawn. More...
 
FActorSpawnResult SpawnActor (const FTransform &SpawnAtTransform, const FActorDescription &ActorDescription) final
 Spawn an actor based on ActorDescription and Transform. More...
 
- Public Member Functions inherited from ACarlaActorFactory
 ACarlaActorFactory (const FObjectInitializer &ObjectInitializer)
 

Protected Member Functions

TArray< FActorDefinitionGenerateDefinitions ()
 
void SpawnActor (const FTransform &SpawnAtTransform, const FActorDescription &ActorDescription, FActorSpawnResult &SpawnResult)
 

Detailed Description

Base class for Blueprints implementing ACarlaActorFactory interface.

Blueprints deriving from this class are expected to override GetDefinitions and SpawnActor functions.

Definition at line 21 of file CarlaActorFactoryBlueprint.h.

Member Function Documentation

◆ GenerateDefinitions()

TArray<FActorDefinition> ACarlaActorFactoryBlueprint::GenerateDefinitions ( )
protected

◆ GetDefinitions()

TArray<FActorDefinition> ACarlaActorFactoryBlueprint::GetDefinitions ( )
inlinefinalvirtual

Retrieve the list of actor definitions that this class is able to spawn.

Reimplemented from ACarlaActorFactory.

Definition at line 27 of file CarlaActorFactoryBlueprint.h.

◆ SpawnActor() [1/2]

FActorSpawnResult ACarlaActorFactoryBlueprint::SpawnActor ( const FTransform &  SpawnAtTransform,
const FActorDescription ActorDescription 
)
inlinefinalvirtual

Spawn an actor based on ActorDescription and Transform.

Precondition
ActorDescription is expected to be derived from one of the definitions retrieved with GetDefinitions.

Reimplemented from ACarlaActorFactory.

Definition at line 32 of file CarlaActorFactoryBlueprint.h.

◆ SpawnActor() [2/2]

void ACarlaActorFactoryBlueprint::SpawnActor ( const FTransform &  SpawnAtTransform,
const FActorDescription ActorDescription,
FActorSpawnResult SpawnResult 
)
protected

The documentation for this class was generated from the following file: