UInstancedStaticMeshComponent::BatchUpdateInstancesTransform

Update the transform for a number of instances.

Choose your operating system:

Windows

macOS

Linux

Override Hierarchy

UInstancedStaticMeshComponent::BatchUpdateInstancesTransform()

UHierarchicalInstancedStaticMeshComponent::BatchUpdateInstancesTransform()

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/Components/InstancedStaticMeshComponent.h

Include

#include "Components/InstancedStaticMeshComponent.h"

Source

/Engine/Source/Runtime/Engine/Private/InstancedStaticMesh.cpp

Syntax

virtual bool BatchUpdateInstancesTransform
(
    int32 StartInstanceIndex,
    int32 NumInstances,
    const FTransform & NewInstancesTransform,
    bool bWorldSpace,
    bool bMarkRenderStateDirty,
    bool bTeleport
)

Remarks

Update the transform for a number of instances.

Returns

True on success.

Parameters

Parameter

Description

StartInstanceIndex

The starting index of the instances to update

NumInstances

The number of instances to update

NewInstancesTransform

The new transform

bWorldSpace

If true, the new transform is interpreted as a World Space transform, otherwise it is interpreted as Local Space

bMarkRenderStateDirty

If true, the change should be visible immediately. If you are updating many instances you should only set this to true for the last instance.

bTeleport

Whether or not the instances physics should be moved normally, or teleported (moved instantly, ignoring velocity).