CARLA
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | List of all members
ACarlaActorFactory Class Reference

Base class for Carla actor factories. More...

#include <CarlaActorFactory.h>

+ Inheritance diagram for ACarlaActorFactory:

Public Member Functions

 ACarlaActorFactory (const FObjectInitializer &ObjectInitializer)
 
virtual TArray< FActorDefinition > GetDefinitions ()
 Retrieve the list of actor definitions that this class is able to spawn.
 
virtual void ReleaseContentPack (const FString &MountPoint)
 Drop every cached definition, parameter and loaded asset that refers to content under MountPoint ("/<Pack>/"), so a content pack can be unmounted; the dropped blueprints are gone until the next episode.
 
virtual FActorSpawnResult SpawnActor (const FTransform &SpawnAtTransform, const FActorDescription &ActorDescription)
 Spawn an actor based on ActorDescription and Transform.
 

Static Public Member Functions

static bool DefinitionReferencesPath (const FActorDefinition &Definition, const FString &MountPoint)
 True when the definition's class or any attribute/variation value points at content under MountPoint.
 

Detailed Description

Base class for Carla actor factories.

Definition at line 22 of file CarlaActorFactory.h.

Constructor & Destructor Documentation

◆ ACarlaActorFactory()

ACarlaActorFactory::ACarlaActorFactory ( const FObjectInitializer &  ObjectInitializer)
inline

Definition at line 28 of file CarlaActorFactory.h.

Member Function Documentation

◆ DefinitionReferencesPath()

static bool ACarlaActorFactory::DefinitionReferencesPath ( const FActorDefinition &  Definition,
const FString &  MountPoint 
)
inlinestatic

◆ GetDefinitions()

virtual TArray< FActorDefinition > ACarlaActorFactory::GetDefinitions ( )
inlinevirtual

◆ ReleaseContentPack()

virtual void ACarlaActorFactory::ReleaseContentPack ( const FString &  MountPoint)
inlinevirtual

Drop every cached definition, parameter and loaded asset that refers to content under MountPoint ("/<Pack>/"), so a content pack can be unmounted; the dropped blueprints are gone until the next episode.

Reimplemented in ABlueprintActorFactory, APropActorFactory, AVehicleActorFactory, AWalkerActorFactory, and AStaticMeshFactory.

Definition at line 54 of file CarlaActorFactory.h.

◆ SpawnActor()

virtual FActorSpawnResult ACarlaActorFactory::SpawnActor ( const FTransform &  SpawnAtTransform,
const FActorDescription &  ActorDescription 
)
inlinevirtual

Spawn an actor based on ActorDescription and Transform.

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

Reimplemented in ACarlaActorFactoryBlueprint, AStaticMeshFactory, AUtilActorFactory, AAIControllerFactory, ASensorFactory, ATriggerFactory, ABlueprintActorFactory, APropActorFactory, AVehicleActorFactory, and AWalkerActorFactory.

Definition at line 44 of file CarlaActorFactory.h.

Referenced by UActorDispatcher::Bind(), and UActorDispatcher::BindNewDefinitions().


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