#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	AddToInstancedRendering ()

void	RemoveFromInstancedRendering (bool EnableStaticMeshComponent=true)

void	UpdateTransformPosition ()

void	InstanceAdded (int32 CompIndex, int32 InstanceNum)

void	UpdateIndex (int32 UpdatedIndex)

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

void	SetUpdateTransformAutomatically (bool UpdateAutomatically)

bool	IsTreeActor () const

void	UpdatePreviousTransform (const FTransform &NewTransform)

bool	IsAddedToInstancedRendering () const

UStaticMeshComponent *	GetStaticMeshComponent () const

int	GetInstanceStartCullDistance () const

int	GetInstanceEndCullDistance () const

bool	UpdateTransformAutomatically () const

FString	GetTypeIDString () const

FString	GetModelIDString () const

int	GetComponentIndex () const

int	GetInstanceIndex () 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

int	InstanceStartCullDistanceInCm = 45000

int	InstanceEndCullDistanceInCm = 46500

bool	ShouldUpdateTransformAutomatically = false

bool	AlternativeMaterial = false

FText	InteractableName

Private Attributes
FString	ActorName

FString	ActorID

FTransform	PreviousTransform

int32	ComponentIndex = 9999999

int32	InstanceNumber = 9999999

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. InstancedRenderer.cpp renders all of these Actors efficiently with UInstancedStaticMeshComponent. see InstancedRenderer.cpp

To use this:

Create blueprint based of this Actor class in Unreal Editor
Setup StaticMeshComponent to desired mesh in the blueprint.
Place the Actors to the World in any way.

Note. If you need to move the Actor, you either call UpdateTransformPosition() each time you change the position, or Set UpdateTransformAutomatically to true in Blueprint or call SetUpdateTransformAutomatically(true); It's recommeded to keep UpdateTransformAutomatically false or call SetUpdateTransformAutomatically(false); If you don't need any Transform updates since this adds some performance cost.

Definition at line 37 of file InstancedActor.h.

Constructor & Destructor Documentation

◆ AInstancedActor()

AInstancedActor::AInstancedActor ( const FObjectInitializer & ObjectInitializer )

Definition at line 14 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

◆ AddToInstancedRendering()

bool AInstancedActor::AddToInstancedRendering ( )

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 74 of file InstancedActor.cpp.

{
    if (AddedToInstancedRenderer)
    {
#if WITH_EDITOR
        UE_LOG(LogTemp, Warning, TEXT("InstancedActor.cpp: Already added to instanced rendering."));
#endif
        return false;
    }
 
    if (!AddToInstancedRenderer)
    {
#if WITH_EDITOR
        UE_LOG(LogTemp, Warning, TEXT("InstancedActor.cpp: %s Actor is not being renderered by UInstancedStaticMeshComponent. If you did not mean to do this, make sure AddToInstancedRenderer is set to true in blueprint."), *this->GetName());;
#endif
        return false;
    }
 
    AInstancedRenderer* InstanceRenderer = UAgrarsenseStatics::GetInstancedRenderer(GetWorld());
    if (InstanceRenderer)
    {
        return InstanceRenderer->AddActorToInstancedRendering(this);
    }
 
    return false;
}

References AInstancedRenderer::AddActorToInstancedRendering(), AddedToInstancedRenderer, AddToInstancedRenderer, and UAgrarsenseStatics::GetInstancedRenderer().

Referenced by BeginPlay().

◆ BeginPlay()

void AInstancedActor::BeginPlay ( )

overridevirtual

Definition at line 22 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();
 
    AddToInstancedRendering();
}

References AddToInstancedRendering(), CustomDepthSetup, PreviousTransform, and StaticMeshComponent.

◆ EndPlay()

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

overridevirtual

Definition at line 37 of file InstancedActor.cpp.

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

References RemoveFromInstancedRendering(), and StaticMeshComponent.

◆ GetActorID_Implementation()

virtual FString AInstancedActor::GetActorID_Implementation ( ) const

inlineoverridevirtual

Definition at line 226 of file InstancedActor.h.

    {
        return ActorID;
    }

◆ GetActorName_Implementation()

virtual FString AInstancedActor::GetActorName_Implementation ( ) const

inlineoverridevirtual

Definition at line 231 of file InstancedActor.h.

    {
        return ActorName;
    }

◆ GetAllowWorldPositionOffsetDisable()

bool AInstancedActor::GetAllowWorldPositionOffsetDisable ( ) const

inline

Definition at line 180 of file InstancedActor.h.

    {
        return AllowWorldPositionOffsetDisable;
    }

Referenced by AInstancedRenderer::FindOrAddUniqueMesh().

◆ GetComponentIndex()

int AInstancedActor::GetComponentIndex ( ) const

inline

Definition at line 160 of file InstancedActor.h.

    {
        return ComponentIndex;
    }

Referenced by AInstancedRenderer::UpdateInstancedActors().

◆ GetInstanceEndCullDistance()

int AInstancedActor::GetInstanceEndCullDistance ( ) const

inline

Definition at line 137 of file InstancedActor.h.

    {
        return InstanceEndCullDistanceInCm;
    }

Referenced by AInstancedRenderer::FindOrAddUniqueMesh().

◆ GetInstanceIndex()

int AInstancedActor::GetInstanceIndex ( ) const

inline

Definition at line 165 of file InstancedActor.h.

    {
        return InstanceNumber;
    }

Referenced by AInstancedRenderer::UpdateInstancedActors().

◆ GetInstanceStartCullDistance()

int AInstancedActor::GetInstanceStartCullDistance ( ) const

inline

Definition at line 131 of file InstancedActor.h.

    {
        return InstanceStartCullDistanceInCm;
    }

Referenced by AInstancedRenderer::FindOrAddUniqueMesh().

◆ GetInteractableName_Implementation()

virtual FText AInstancedActor::GetInteractableName_Implementation ( ) const

inlineoverridevirtual

Definition at line 216 of file InstancedActor.h.

    {
        return InteractableName;
    }

◆ GetInteractableWorldTransform_Implementation()

virtual FTransform AInstancedActor::GetInteractableWorldTransform_Implementation ( ) const

inlineoverridevirtual

Definition at line 221 of file InstancedActor.h.

    {
        return GetActorTransform();
    }

◆ GetModelIDString()

FString AInstancedActor::GetModelIDString ( ) const

inline

Definition at line 155 of file InstancedActor.h.

    {
        return ModelID;
    }

◆ GetPreviousTransform()

FTransform AInstancedActor::GetPreviousTransform ( ) const

inline

Definition at line 185 of file InstancedActor.h.

    {
        return PreviousTransform;
    }

Referenced by AInstancedRenderer::UpdateInstancedActors().

◆ GetStaticMeshComponent()

UStaticMeshComponent * AInstancedActor::GetStaticMeshComponent ( ) const

inline

Definition at line 125 of file InstancedActor.h.

    {
        return StaticMeshComponent;
    }

Referenced by AInstancedRenderer::AddActorToInstancedRendering(), UAgrarsenseConsoleCommands::SetInstacedTreesVisibilityEditor(), and UAgrarsenseConsoleCommands::SetInstancedActorsVisibilityEditor().

◆ GetTypeIDString()

FString AInstancedActor::GetTypeIDString ( ) const

inline

Definition at line 149 of file InstancedActor.h.

    {
        return TypeID;
    }

◆ HasAlternativeMaterial()

bool AInstancedActor::HasAlternativeMaterial ( ) const

inline

Definition at line 170 of file InstancedActor.h.

    {
        return AlternativeMaterial;
    }

Referenced by AInstancedRenderer::FindOrAddUniqueMesh().

◆ InstanceAdded()

void AInstancedActor::InstanceAdded	(	int32	CompIndex,
		int32	InstanceNum
	)

Notify that this Actor instance has been added to InstancedRenderer. This should only be called from InstancedRenderer.cpp

Definition at line 101 of file InstancedActor.cpp.

{
    // Hide StaticMeshComponent Visibility since InstancedRenderer
    // is now resposible for rendering this Actor's mesh.
    // Note. StaticMeshComponent is still resposible for collisions.
    if (StaticMeshComponent)
    {
        StaticMeshComponent->SetVisibility(false);
        StaticMeshComponent->SetComponentTickEnabled(false);
    }
 
    ComponentIndex = CompIndex;
    InstanceNumber = InstanceNum;
    AddedToInstancedRenderer = true;
}

References AddedToInstancedRenderer, ComponentIndex, InstanceNumber, and StaticMeshComponent.

Referenced by AInstancedRenderer::AddActorToInstancedRendering().

◆ 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 119 of file InstancedActor.h.

    {
        return AddedToInstancedRenderer;
    }

◆ IsCustomDepthSetup()

bool AInstancedActor::IsCustomDepthSetup ( ) const

inline

Definition at line 175 of file InstancedActor.h.

    {
        return CustomDepthSetup;
    }

Referenced by ATagger::TagActor().

◆ IsTreeActor()

bool AInstancedActor::IsTreeActor ( ) const

Definition at line 158 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 ADeletionVolume::DestroyOverlappingActors().

◆ RemoveFromInstancedRendering()

void AInstancedActor::RemoveFromInstancedRendering ( bool EnableStaticMeshComponent = true )

Remove this InstancedActor from Instanced rendering if it was added.

Parameters

EnableStaticMeshComponent If true, enables the StaticMeshComponent after removal.

Definition at line 54 of file InstancedActor.cpp.

{
    if (AddedToInstancedRenderer)
    {
        AInstancedRenderer* InstanceRenderer = UAgrarsenseStatics::GetInstancedRenderer(GetWorld());
        if (InstanceRenderer)
        {
            InstanceRenderer->RemoveInstance(ComponentIndex, InstanceNumber);
        }
    }
 
    AddedToInstancedRenderer = false;
 
    if (EnableStaticMeshComponent && StaticMeshComponent)
    {
        StaticMeshComponent->SetVisibility(true);
        StaticMeshComponent->SetComponentTickEnabled(true);
    }
}

References AddedToInstancedRenderer, ComponentIndex, UAgrarsenseStatics::GetInstancedRenderer(), InstanceNumber, AInstancedRenderer::RemoveInstance(), and StaticMeshComponent.

Referenced by EndPlay().

◆ SetActorIDAndName_Implementation()

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

inlineoverridevirtual

Definition at line 241 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 236 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 86 of file InstancedActor.h.

    {
        TypeID = Type;
        ModelID = Model;
    }

Referenced by UAssetLibrary::SpawnProp().

◆ SetUpdateTransformAutomatically()

void AInstancedActor::SetUpdateTransformAutomatically ( bool UpdateAutomatically )

Definition at line 141 of file InstancedActor.cpp.

{
    if (ShouldUpdateTransformAutomatically == UpdateAutomatically || !AddedToInstancedRenderer)
    {
        // No change, return
        return;
    }
 
    ShouldUpdateTransformAutomatically = UpdateAutomatically;
 
    AInstancedRenderer* InstanceRenderer = UAgrarsenseStatics::GetInstancedRenderer(GetWorld());
    if (InstanceRenderer)
    {
        InstanceRenderer->AddOrRemoveActorFromAutomaticTransformUpdates(ShouldUpdateTransformAutomatically, this);
    }
}

References AddedToInstancedRenderer, AInstancedRenderer::AddOrRemoveActorFromAutomaticTransformUpdates(), UAgrarsenseStatics::GetInstancedRenderer(), and ShouldUpdateTransformAutomatically.

◆ UpdateIndex()

void AInstancedActor::UpdateIndex ( int32 UpdatedIndex )

Update this Actor instance index. This should only be called from InstancedRenderer.cpp

Definition at line 117 of file InstancedActor.cpp.

{
    if (UpdatedIndex > InstanceNumber)
    {
        return;
    }
 
    --InstanceNumber;
}

References InstanceNumber.

Referenced by AInstancedRenderer::RemoveInstance().

◆ 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 109 of file InstancedActor.h.

    {
        PreviousTransform = NewTransform;
    }

Referenced by AInstancedRenderer::AddOrRemoveActorFromAutomaticTransformUpdates(), and AInstancedRenderer::UpdateInstancedActors().

◆ UpdateTransformAutomatically()

bool AInstancedActor::UpdateTransformAutomatically ( ) const

inline

Definition at line 143 of file InstancedActor.h.

    {
        return ShouldUpdateTransformAutomatically;
    }

Referenced by AInstancedRenderer::AddActorToInstancedRendering().

◆ UpdateTransformPosition()

void AInstancedActor::UpdateTransformPosition ( )

Updates this InstancedActor Transform location to the InstancedRenderer.

Definition at line 127 of file InstancedActor.cpp.

{
    if (ShouldUpdateTransformAutomatically) 
    {
        return;
    }
 
    AInstancedRenderer* InstanceRenderer = UAgrarsenseStatics::GetInstancedRenderer(GetWorld());
    if (InstanceRenderer)
    {
        InstanceRenderer->UpdateInstanceTransform(ComponentIndex, InstanceNumber, GetActorTransform());
    }
}

References ComponentIndex, UAgrarsenseStatics::GetInstancedRenderer(), InstanceNumber, ShouldUpdateTransformAutomatically, and AInstancedRenderer::UpdateInstanceTransform().

Referenced by UROSCommands::HandleTeleportActorByID().

Member Data Documentation

◆ ActorID

FString AInstancedActor::ActorID

private

Definition at line 254 of file InstancedActor.h.

◆ ActorName

FString AInstancedActor::ActorName

private

Definition at line 251 of file InstancedActor.h.

◆ AddedToInstancedRenderer

bool AInstancedActor::AddedToInstancedRenderer = false

private

Definition at line 262 of file InstancedActor.h.

Referenced by AddToInstancedRendering(), InstanceAdded(), RemoveFromInstancedRendering(), and SetUpdateTransformAutomatically().

◆ AddToInstancedRenderer

bool AInstancedActor::AddToInstancedRenderer = true

Definition at line 197 of file InstancedActor.h.

Referenced by AddToInstancedRendering().

◆ AllowWorldPositionOffsetDisable

bool AInstancedActor::AllowWorldPositionOffsetDisable = false

Definition at line 194 of file InstancedActor.h.

◆ AlternativeMaterial

bool AInstancedActor::AlternativeMaterial = false

Definition at line 211 of file InstancedActor.h.

◆ ComponentIndex

int32 AInstancedActor::ComponentIndex = 9999999

private

Definition at line 258 of file InstancedActor.h.

Referenced by InstanceAdded(), RemoveFromInstancedRendering(), and UpdateTransformPosition().

◆ CustomDepthSetup

bool AInstancedActor::CustomDepthSetup = false

private

Definition at line 268 of file InstancedActor.h.

Referenced by BeginPlay().

◆ InstanceEndCullDistanceInCm

int AInstancedActor::InstanceEndCullDistanceInCm = 46500

Definition at line 203 of file InstancedActor.h.

◆ InstanceNumber

int32 AInstancedActor::InstanceNumber = 9999999

private

Definition at line 260 of file InstancedActor.h.

Referenced by InstanceAdded(), RemoveFromInstancedRendering(), UpdateIndex(), and UpdateTransformPosition().

◆ InstanceStartCullDistanceInCm

int AInstancedActor::InstanceStartCullDistanceInCm = 45000

Definition at line 200 of file InstancedActor.h.

◆ InteractableName

FText AInstancedActor::InteractableName

Definition at line 214 of file InstancedActor.h.

Referenced by AInstancedActor().

◆ ModelID

FString AInstancedActor::ModelID = "none"

private

Definition at line 266 of file InstancedActor.h.

◆ PreviousTransform

FTransform AInstancedActor::PreviousTransform

private

Definition at line 256 of file InstancedActor.h.

Referenced by BeginPlay().

◆ ShouldUpdateTransformAutomatically

bool AInstancedActor::ShouldUpdateTransformAutomatically = false

Definition at line 207 of file InstancedActor.h.

Referenced by SetUpdateTransformAutomatically(), and UpdateTransformPosition().

◆ StaticMeshComponent

UStaticMeshComponent* AInstancedActor::StaticMeshComponent = nullptr

Definition at line 191 of file InstancedActor.h.

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

◆ TypeID

FString AInstancedActor::TypeID = "none"

private

Definition at line 264 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

◆ AddToInstancedRendering()

◆ BeginPlay()

◆ EndPlay()

◆ GetActorID_Implementation()

◆ GetActorName_Implementation()

◆ GetAllowWorldPositionOffsetDisable()

◆ GetComponentIndex()

◆ GetInstanceEndCullDistance()

◆ GetInstanceIndex()

◆ GetInstanceStartCullDistance()

◆ GetInteractableName_Implementation()

◆ GetInteractableWorldTransform_Implementation()

◆ GetModelIDString()

◆ GetPreviousTransform()

◆ GetStaticMeshComponent()

◆ GetTypeIDString()

◆ HasAlternativeMaterial()

◆ InstanceAdded()

◆ IsAddedToInstancedRendering()

◆ IsCustomDepthSetup()

◆ IsTreeActor()

◆ RemoveFromInstancedRendering()

◆ SetActorIDAndName_Implementation()

◆ SetActorName_Implementation()

◆ SetTypeAndModel()

◆ SetUpdateTransformAutomatically()

◆ UpdateIndex()

◆ UpdatePreviousTransform()

◆ UpdateTransformAutomatically()

◆ UpdateTransformPosition()

Member Data Documentation

◆ ActorID

◆ ActorName

◆ AddedToInstancedRenderer

◆ AddToInstancedRenderer

◆ AllowWorldPositionOffsetDisable

◆ AlternativeMaterial

◆ ComponentIndex

◆ CustomDepthSetup

◆ InstanceEndCullDistanceInCm

◆ InstanceNumber

◆ InstanceStartCullDistanceInCm

◆ InteractableName

◆ ModelID

◆ PreviousTransform

◆ ShouldUpdateTransformAutomatically

◆ StaticMeshComponent

◆ TypeID