#include <InstancedActor.h>

Inheritance diagram for AInstancedActor:

[legend]

Collaboration diagram for AInstancedActor:

[legend]

Public Member Functions
	AInstancedActor (const FObjectInitializer &ObjectInitializer)

virtual void	BeginPlay () override

virtual void	EndPlay (const EEndPlayReason::Type EndPlayReason) override

bool	CanAddToInstancedRenderer ()

void	InstanceAdded ()

void	SetTypeAndModel (const FString &Type, const FString &Model)

bool	IsTreeActor () const

void	UpdatePreviousTransform (const FTransform &NewTransform)

bool	IsAddedToInstancedRendering () const

UStaticMeshComponent *	GetStaticMeshComponent () const

int32	GetInstanceStartCullDistance () const

int32	GetInstanceEndCullDistance () const

bool	UpdateTransformAutomatically () const

FString	GetTypeIDString () const

FString	GetModelIDString () const

bool	HasAlternativeMaterial () const

bool	IsCustomDepthSetup () const

bool	GetAllowWorldPositionOffsetDisable () const

FTransform	GetPreviousTransform () const

virtual FText	GetInteractableName_Implementation () const override

virtual FTransform	GetInteractableWorldTransform_Implementation () const override

virtual FString	GetActorID_Implementation () const override

virtual FString	GetActorName_Implementation () const override

virtual void	SetActorName_Implementation (const FString &NewActorName) override

virtual void	SetActorIDAndName_Implementation (const FString &NewActorName, const FString &NewID) override

Public Member Functions inherited from IInteractable
FText	GetInteractableName () const

FTransform	GetInteractableWorldTransform () const

Public Member Functions inherited from IActorInformation
FString	GetActorID () const

FString	GetActorName () const

FString	GetActorInformation () const

void	SetActorName (const FString &NewActorName)

void	SetActorIDAndName (const FString &NewActorName, const FString &NewID)

Public Attributes
UStaticMeshComponent *	StaticMeshComponent = nullptr

bool	AllowWorldPositionOffsetDisable = false

bool	AddToInstancedRenderer = true

int32	InstanceStartCullDistanceInCm = 45000

int32	InstanceEndCullDistanceInCm = 46500

bool	ShouldUpdateTransformAutomatically = false

bool	AlternativeMaterial = false

FText	InteractableName

Private Attributes
FString	ActorName

FString	ActorID

FTransform	PreviousTransform

bool	AddedToInstancedRenderer = false

FString	TypeID = "none"

FString	ModelID = "none"

bool	CustomDepthSetup = false

Additional Inherited Members
Static Public Member Functions inherited from IActorInformation
static void	SetAndValidateActorIDAndName (FString &ActorName, FString &ActorID, TWeakObjectPtr< AActor > Actor)

static bool	DestroyActorByID (const FString &ID)

static AActor *	GetActorByID (const FString &ID)

template<typename T >
static TArray< T * >	GetActorsWithInterface ()

static void	PrintAllIds ()

Detailed Description

Instanced Actor class for efficient rendering. The corresponding InstancedActorRenderer Actor handles rendering of all Actors of this type using a single UInstancedStaticMeshComponent.

Usage:

Create a Blueprint based on this Actor class in the Unreal Editor.
In the Blueprint, assign the desired Static Mesh to the StaticMeshComponent.
Place multiple instances of the Blueprint in the world as needed.

For optimal loading times:

Convert the placed Actors into instances in the Editor.
To do this navigate to Content/Agrarsense/Blueprints/Editor
Open the "EUW_Agrarsense_editor_tools" widget.
Click the "Add existing InstancedActors to InstancedRenderer" button.

Definition at line 38 of file InstancedActor.h.

Constructor & Destructor Documentation

◆ AInstancedActor()

AInstancedActor::AInstancedActor ( const FObjectInitializer & ObjectInitializer )

Definition at line 12 of file InstancedActor.cpp.

                                                                            : Super(ObjectInitializer)
{
    StaticMeshComponent = CreateDefaultSubobject<UStaticMeshComponent>(TEXT("StaticMeshComponent"));
    RootComponent = StaticMeshComponent;
    PrimaryActorTick.bCanEverTick = false;
    InteractableName = NSLOCTEXT("Agrarsense", "StaticInstancedActorInteractableName", "Prop");
}

References InteractableName, and StaticMeshComponent.

Member Function Documentation

◆ BeginPlay()

void AInstancedActor::BeginPlay ( )

overridevirtual

Definition at line 20 of file InstancedActor.cpp.

{
    Super::BeginPlay();
 
    if (StaticMeshComponent)
    {
        // Check if Custom Depth has been setup in Editor, if not Tagger.cpp needs to do this runtime.
        CustomDepthSetup = (StaticMeshComponent->bRenderCustomDepth && StaticMeshComponent->CustomDepthStencilValue == 0) ? true : false;
    }
 
    PreviousTransform = GetActorTransform();
}

References CustomDepthSetup, PreviousTransform, and StaticMeshComponent.

◆ CanAddToInstancedRenderer()

bool AInstancedActor::CanAddToInstancedRenderer ( )

Add this InstancedActor to Instanced rendering if it wasn't already added.

Returns: True if the InstancedActor was successfully added to Instanced rendering.

Definition at line 48 of file InstancedActor.cpp.

{
    if (AddedToInstancedRenderer || !AddToInstancedRenderer || ShouldUpdateTransformAutomatically)
    {
        return false;
    }
    return true;
}

References AddedToInstancedRenderer, AddToInstancedRenderer, and ShouldUpdateTransformAutomatically.

Referenced by AInstancedRendererManager::BeginPlay().

◆ EndPlay()

void AInstancedActor::EndPlay ( const EEndPlayReason::Type EndPlayReason )

overridevirtual

Definition at line 33 of file InstancedActor.cpp.

{
    Super::EndPlay(EndPlayReason);
 
    if (EndPlayReason != EEndPlayReason::Type::EndPlayInEditor)
    {
        if (StaticMeshComponent)
        {
            StaticMeshComponent->UnregisterComponent();
            StaticMeshComponent->DestroyComponent();
            StaticMeshComponent = nullptr;
        }
    }
}

References StaticMeshComponent.

◆ GetActorID_Implementation()

virtual FString AInstancedActor::GetActorID_Implementation ( ) const

inlineoverridevirtual

Definition at line 188 of file InstancedActor.h.

    {
        return ActorID;
    }

◆ GetActorName_Implementation()

virtual FString AInstancedActor::GetActorName_Implementation ( ) const

inlineoverridevirtual

Definition at line 193 of file InstancedActor.h.

    {
        return ActorName;
    }

◆ GetAllowWorldPositionOffsetDisable()

bool AInstancedActor::GetAllowWorldPositionOffsetDisable ( ) const

inline

Definition at line 142 of file InstancedActor.h.

    {
        return AllowWorldPositionOffsetDisable;
    }

Referenced by AInstancedActorRenderer::SetupFromInstancedActor().

◆ GetInstanceEndCullDistance()

int32 AInstancedActor::GetInstanceEndCullDistance ( ) const

inline

Definition at line 109 of file InstancedActor.h.

    {
        return InstanceEndCullDistanceInCm;
    }

Referenced by AInstancedActorRenderer::SetupFromInstancedActor().

◆ GetInstanceStartCullDistance()

int32 AInstancedActor::GetInstanceStartCullDistance ( ) const

inline

Definition at line 103 of file InstancedActor.h.

    {
        return InstanceStartCullDistanceInCm;
    }

Referenced by AInstancedActorRenderer::SetupFromInstancedActor().

◆ GetInteractableName_Implementation()

virtual FText AInstancedActor::GetInteractableName_Implementation ( ) const

inlineoverridevirtual

Definition at line 178 of file InstancedActor.h.

    {
        return InteractableName;
    }

◆ GetInteractableWorldTransform_Implementation()

virtual FTransform AInstancedActor::GetInteractableWorldTransform_Implementation ( ) const

inlineoverridevirtual

Definition at line 183 of file InstancedActor.h.

    {
        return GetActorTransform();
    }

◆ GetModelIDString()

FString AInstancedActor::GetModelIDString ( ) const

inline

Definition at line 127 of file InstancedActor.h.

    {
        return ModelID;
    }

◆ GetPreviousTransform()

FTransform AInstancedActor::GetPreviousTransform ( ) const

inline

Definition at line 147 of file InstancedActor.h.

    {
        return PreviousTransform;
    }

◆ GetStaticMeshComponent()

UStaticMeshComponent * AInstancedActor::GetStaticMeshComponent ( ) const

inline

Definition at line 97 of file InstancedActor.h.

    {
        return StaticMeshComponent;
    }

Referenced by AInstancedRendererManager::AddActorToInstancedRendering(), and AInstancedActorRenderer::SetupFromInstancedActor().

◆ GetTypeIDString()

FString AInstancedActor::GetTypeIDString ( ) const

inline

Definition at line 121 of file InstancedActor.h.

    {
        return TypeID;
    }

◆ HasAlternativeMaterial()

bool AInstancedActor::HasAlternativeMaterial ( ) const

inline

Definition at line 132 of file InstancedActor.h.

    {
        return AlternativeMaterial;
    }

◆ InstanceAdded()

void AInstancedActor::InstanceAdded ( )

Definition at line 57 of file InstancedActor.cpp.

{
    if (StaticMeshComponent)
    {
        StaticMeshComponent->SetVisibility(false);
        StaticMeshComponent->SetComponentTickEnabled(false);
        AddedToInstancedRenderer = true;
    }
}

References AddedToInstancedRenderer, and StaticMeshComponent.

Referenced by AInstancedRendererManager::AddActorToInstancedRendering(), and AInstancedActorRenderer::SetupFromInstancedActor().

◆ IsAddedToInstancedRendering()

bool AInstancedActor::IsAddedToInstancedRendering ( ) const

inline

Check if this InstancedActor is already added to Instanced rendering.

Returns: True if the InstancedActor is added to Instanced rendering. false otherwise.

Definition at line 91 of file InstancedActor.h.

    {
        return AddedToInstancedRenderer;
    }

◆ IsCustomDepthSetup()

bool AInstancedActor::IsCustomDepthSetup ( ) const

inline

Definition at line 137 of file InstancedActor.h.

    {
        return CustomDepthSetup;
    }

◆ IsTreeActor()

bool AInstancedActor::IsTreeActor ( ) const

Definition at line 67 of file InstancedActor.cpp.

{
    if (StaticMeshComponent)
    {
        UStaticMesh* Mesh = StaticMeshComponent->GetStaticMesh();
        if (Mesh)
        {
            FString Path = Mesh->GetPathName();
            if (Path.Contains("Tree"))
            {
                return true;
            }
        }
    }
 
    return false;
}

References StaticMeshComponent.

Referenced by AInstancedActorRenderer::SetupFromInstancedActor().

◆ SetActorIDAndName_Implementation()

virtual void AInstancedActor::SetActorIDAndName_Implementation	(	const FString &	NewActorName,
		const FString &	NewID
	)

inlineoverridevirtual

Definition at line 203 of file InstancedActor.h.

    {
        ActorName = NewActorName;
        ActorID = NewID;
        SetAndValidateActorIDAndName(ActorName, ActorID, TWeakObjectPtr<AActor>(this));
    }

◆ SetActorName_Implementation()

virtual void AInstancedActor::SetActorName_Implementation ( const FString & NewActorName )

inlineoverridevirtual

Definition at line 198 of file InstancedActor.h.

    {
        ActorName = NewActorName;
    }

◆ SetTypeAndModel()

void AInstancedActor::SetTypeAndModel	(	const FString &	Type,
		const FString &	Model
	)

inline

Set Type and Model strings for this InstancedActor This is used when exporting InstancedActor(s) into JSON files

Definition at line 65 of file InstancedActor.h.

    {
        TypeID = Type;
        ModelID = Model;
    }

Referenced by UAssetLibrary::SpawnFoliage(), and UAssetLibrary::SpawnProp().

◆ UpdatePreviousTransform()

void AInstancedActor::UpdatePreviousTransform ( const FTransform & NewTransform )

inline

Updates the 'PreviousTransform' member variable with a new transform.

Parameters

NewTransform The new transform to be assigned to 'PreviousTransform'.

Definition at line 81 of file InstancedActor.h.

    {
        PreviousTransform = NewTransform;
    }

◆ UpdateTransformAutomatically()

bool AInstancedActor::UpdateTransformAutomatically ( ) const

inline

Definition at line 115 of file InstancedActor.h.

    {
        return ShouldUpdateTransformAutomatically;
    }

Referenced by AInstancedRendererManager::AddActorToInstancedRendering().

Member Data Documentation

◆ ActorID

FString AInstancedActor::ActorID

private

Definition at line 216 of file InstancedActor.h.

◆ ActorName

FString AInstancedActor::ActorName

private

Definition at line 213 of file InstancedActor.h.

◆ AddedToInstancedRenderer

bool AInstancedActor::AddedToInstancedRenderer = false

private

Definition at line 220 of file InstancedActor.h.

Referenced by CanAddToInstancedRenderer(), and InstanceAdded().

◆ AddToInstancedRenderer

bool AInstancedActor::AddToInstancedRenderer = true

Definition at line 159 of file InstancedActor.h.

Referenced by CanAddToInstancedRenderer(), and AInstancedActorRenderer::SpawnInstanceBackToActor().

◆ AllowWorldPositionOffsetDisable

bool AInstancedActor::AllowWorldPositionOffsetDisable = false

Definition at line 156 of file InstancedActor.h.

◆ AlternativeMaterial

bool AInstancedActor::AlternativeMaterial = false

Definition at line 173 of file InstancedActor.h.

Referenced by AInstancedRendererManager::AddActorToInstancedRendering().

◆ CustomDepthSetup

bool AInstancedActor::CustomDepthSetup = false

private

Definition at line 226 of file InstancedActor.h.

Referenced by BeginPlay().

◆ InstanceEndCullDistanceInCm

int32 AInstancedActor::InstanceEndCullDistanceInCm = 46500

Definition at line 165 of file InstancedActor.h.

◆ InstanceStartCullDistanceInCm

int32 AInstancedActor::InstanceStartCullDistanceInCm = 45000

Definition at line 162 of file InstancedActor.h.

◆ InteractableName

FText AInstancedActor::InteractableName

Definition at line 176 of file InstancedActor.h.

Referenced by AInstancedActor().

◆ ModelID

FString AInstancedActor::ModelID = "none"

private

Definition at line 224 of file InstancedActor.h.

◆ PreviousTransform

FTransform AInstancedActor::PreviousTransform

private

Definition at line 218 of file InstancedActor.h.

Referenced by BeginPlay().

◆ ShouldUpdateTransformAutomatically

bool AInstancedActor::ShouldUpdateTransformAutomatically = false

Definition at line 169 of file InstancedActor.h.

Referenced by CanAddToInstancedRenderer().

◆ StaticMeshComponent

UStaticMeshComponent* AInstancedActor::StaticMeshComponent = nullptr

Definition at line 153 of file InstancedActor.h.

Referenced by AInstancedActor(), BeginPlay(), EndPlay(), InstanceAdded(), and IsTreeActor().

◆ TypeID

FString AInstancedActor::TypeID = "none"

private

Definition at line 222 of file InstancedActor.h.

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

Unreal/Agrarsense/Source/Agrarsense/InstancedRendering/InstancedActor.h
Unreal/Agrarsense/Source/Agrarsense/InstancedRendering/InstancedActor.cpp

Public Member Functions

Public Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ AInstancedActor()

Member Function Documentation

◆ BeginPlay()

◆ CanAddToInstancedRenderer()

◆ EndPlay()

◆ GetActorID_Implementation()

◆ GetActorName_Implementation()

◆ GetAllowWorldPositionOffsetDisable()

◆ GetInstanceEndCullDistance()

◆ GetInstanceStartCullDistance()

◆ GetInteractableName_Implementation()

◆ GetInteractableWorldTransform_Implementation()

◆ GetModelIDString()

◆ GetPreviousTransform()

◆ GetStaticMeshComponent()

◆ GetTypeIDString()

◆ HasAlternativeMaterial()

◆ InstanceAdded()

◆ IsAddedToInstancedRendering()

◆ IsCustomDepthSetup()

◆ IsTreeActor()

◆ SetActorIDAndName_Implementation()

◆ SetActorName_Implementation()

◆ SetTypeAndModel()

◆ UpdatePreviousTransform()

◆ UpdateTransformAutomatically()

Member Data Documentation

◆ ActorID

◆ ActorName

◆ AddedToInstancedRenderer

◆ AddToInstancedRenderer

◆ AllowWorldPositionOffsetDisable

◆ AlternativeMaterial

◆ CustomDepthSetup

◆ InstanceEndCullDistanceInCm

◆ InstanceStartCullDistanceInCm

◆ InteractableName

◆ ModelID

◆ PreviousTransform

◆ ShouldUpdateTransformAutomatically

◆ StaticMeshComponent

◆ TypeID