1. Epic GamesDeveloper
  3. ALightWeightInstanceManager

ALightWeightInstanceManager

API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/GameFramework

Inheritance Hierarchy

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Classes/GameFramework/LightWeightInstanceManager.h
Include #include "GameFramework/LightWeightInstanceManager.h"

Syntax

class ALightWeightInstanceManager : public AActor

Variables

  Type Name Description
Protected variable TSubclassOf< AActor > AcceptedClass  
Protected variable TMap< int32, TObjectPtr< AActor > > Actors Keep track of which instances are currently represented by an actor
Protected variable FString BaseInstanceName  
Protected variable TArray< int32 > DestroyedActorIndices  
Protected variable TArray< int32 > FreeIndices List of indices that we are no longer using
Protected variable TArray< int32 > InstanceToActorConversionsInProgress  
Protected variable TArray< FTransform > InstanceTransforms Current per instance transforms.
Protected variable TSubclassOf< AActor > RepresentedClass  
Protected variable TArray< bool > ValidIndices Handy way to check indices quickly so we don't need to iterate through the free indices list

Constructors

  Type Name Description
Public function  

ALightWeightInstanceManager ( const FObjectInitializer& ObjectInitializer
)

  

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Protected function int32

AddNewInstance ( FLWIData* InitData
)

 Takes a polymorphic struct to set the initial data for a new instance.
Protected function Virtual void

AddNewInstanceAt ( FLWIData* InitData,
int32 Index
)

 Adds a new instance at the specified index.
Protected function Virtual Const FLWIData * Allocates the appropriate subclass of FLWIData to initialize instances for this manager. The caller is responsible for freeing the memory when they are finished.
Public function FActorInstanceHandle Returns a handle to a light weight instance representing the same object as InActor and calls destroy on InActor if successful.
Public function Virtual Const int32 Returns the index used internally by the light weight instance manager that is associated with the instance referred to by InIndex used by collision and rendering.
Protected function Virtual Const int32

ConvertHandleIndexToInternalIndex ( int32 InHandleIndex
)

  
Protected function AActor * Creates an actor to replace the instance specified by Handle.
Protected function Virtual Const int32

ConvertInternalIndexToHandleIndex ( int32 InInternalIndex
)

 Helper functions for converting between our internal storage indices and the indices used by external bookkeeping.
Public function Virtual Const int32 Returns the index used by collision and rendering that is associated with the instance referred to by InIndex.
Public function Const FInt32Vector3

ConvertPositionToCoord ( const FVector& InPosition
)

 Helper that converts a position (world space) into a coordinate for the LWI grid.
Public function Const FBox

ConvertPositionToGridBounds ( const FVector& InPosition
)

 Helper that retrieve the world space bounds of the LWI grid cell encompassing the provided coordinate.
Protected function UObject * Create an object that implements interfaces for the light weight instance specified by Handle.
Public function Const bool

DoesAcceptClass ( const UClass* OtherClass
)

 Returns true if this manager is capable of representing objects of type OtherClass.
Public function Const bool

DoesRepresentClass ( const UClass* OtherClass
)

 Returns true if this manager stores instances that can be turned into full weight objects of class OtherClass.
Public function AActor * Returns the actor associated with Handle if one exists.
Public function I *  
Protected function Const bool Checks if we already have an actor for this handle. If an actor already exists we set the Actor variable on Handle and return true.
Public function AActor *

FindActorForInstanceIndex ( const int32 InstanceIndex
)

  
Public function Const int32

FindIndexForActor ( const AActor* InActor
)

 Returns the index of the light weight instance associated with InActor if one exists; otherwise we return INDEX_NONE.
Public function Const UClass * Returns the base class of types that this can manage.
Protected function Virtual Const UClass * Returns the class to use when spawning a new actor.
Public function Virtual Const int32 LWI grid size to use for this manager.
Protected function Virtual Const UClass * Gets the class that implements interfaces for light weight instances owned by this manager.
Public function Const FVector

GetLocation ( const FActorInstanceHandle& Handle
)

 Returns the location of the instance specified by Handle.
Public function Const FString

GetName ( const FActorInstanceHandle& Handle
)

 Returns the name of the instance specified by Handle.
Public function Const UClass * Returns the specific class that this manages.
Public function Const FRotator

GetRotation ( const FActorInstanceHandle& Handle
)

 Returns the rotation of the instance specified by Handle.
Public function Const FTransform Returns the transform of the instance specified by Handle.
Protected function Virtual void Increases the size of all of our data arrays to NewSize.
Public function Const bool  
Protected function Const bool

IsIndexValid ( int32 Index
)

 Returns true if we have current information for an instance at Index.
Public function Const bool  
Protected function Virtual void  
Protected function Virtual void

OnSpawnedActorDestroyed ( AActor* DestroyedActor,
const int32 DestroyedActorInstanceIndex
)

 Called after a spawned actor is destroyed.
Protected function Virtual void Called after spawning a new actor from a light weight instance.
Protected function Virtual void

PreSpawnInitalization ( const FActorInstanceHandle& Handle,
AActor* SpawnedActor
)

 Called after actor construction but before other systems see this actor spawn.
Protected function Virtual void

RemoveInstance ( int32 Index
)

 Removes the instance.
Protected function Virtual Const bool

SetDataFromActor ( FLWIData* InData,
AActor* InActor
)

 Gathers info from InActor and stores it in InData. Returns true if the relevant data was successfully copied.
Public function Virtual void

SetRepresentedClass ( UClass* ActorClass
)

 Sets the specific class that this manages.
Protected function Virtual void Sets the parameters for actor spawning.
Protected function Virtual void

UpdateDataAtIndex ( FLWIData* InData,
int32 Index
)

 Populates the data array entries at Index with the data stored in InData;.

Overridden from AActor

  Type Name Description
Public function Virtual void

Tick ( float DeltaSeconds
)

 Function called every frame on this Actor.

Overridden from UObject

  Type Name Description
Public function Virtual Const void Data and replication functions
Protected function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Editor functions

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page