Class InstancedStaticMeshComponent

A component that efficiently renders multiple instances of the same StaticMesh.

Inheritance
System.Object
UObject
ActorComponent
SceneComponent
PrimitiveComponent
MeshComponent
StaticMeshComponent
InstancedStaticMeshComponent
HierarchicalInstancedStaticMeshComponent
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: UE4.Engine
Assembly: UE4DotNet.dll
Syntax
public class InstancedStaticMeshComponent : StaticMeshComponent

Properties

| Improve this Doc View Source

DefaultObject

Get UE4 Default Object for this Class

Declaration
public static InstancedStaticMeshComponent DefaultObject { get; }
Property Value
Type Description
InstancedStaticMeshComponent
| Improve this Doc View Source

InstanceEndCullDistance

Distance from camera at which each instance completely fades out.

Declaration
public int InstanceEndCullDistance { get; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

InstanceStartCullDistance

Distance from camera at which each instance begins to fade out.

Declaration
public int InstanceStartCullDistance { get; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

InstancingRandomSeed

Value used to seed the random number stream that generates random numbers for each of this mesh's instances.

Declaration
public int InstancingRandomSeed { get; set; }
Property Value
Type Description
System.Int32
Remarks

The random number is stored in a buffer accessible to materials through the PerInstanceRandom expression. If this is set to zero (default), it will be populated automatically by the editor.

| Improve this Doc View Source

NumPendingLightmaps

Number of pending lightmaps still to be calculated (Apply()'d).

Declaration
public int NumPendingLightmaps { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

StaticClass

Get UE4 Class

Declaration
public static Class StaticClass { get; }
Property Value
Type Description
Class

Methods

| Improve this Doc View Source

AddInstance(Transform)

Add an instance to this component. Transform is given in local space of this component.

Declaration
public int AddInstance(Transform InstanceTransform)
Parameters
Type Name Description
Transform InstanceTransform
Returns
Type Description
System.Int32
| Improve this Doc View Source

AddInstanceWorldSpace(Transform)

Add an instance to this component. Transform is given in world space.

Declaration
public int AddInstanceWorldSpace(Transform WorldTransform)
Parameters
Type Name Description
Transform WorldTransform
Returns
Type Description
System.Int32
| Improve this Doc View Source

ClearInstances()

Clear all instances being rendered by this component.

Declaration
public void ClearInstances()
| Improve this Doc View Source

GetInstanceCount()

Get the number of instances in this component.

Declaration
public int GetInstanceCount()
Returns
Type Description
System.Int32
| Improve this Doc View Source

GetInstancesOverlappingBox(Box, Boolean)

Returns the instances with instance bounds overlapping the specified box. The return value is an array of instance indices.

Declaration
public IReadOnlyCollection<int> GetInstancesOverlappingBox(Box Box, bool bBoxInWorldSpace)
Parameters
Type Name Description
Box Box
System.Boolean bBoxInWorldSpace
Returns
Type Description
System.Collections.Generic.IReadOnlyCollection<System.Int32>
| Improve this Doc View Source

GetInstancesOverlappingSphere(Vector, Single, Boolean)

Returns the instances with instance bounds overlapping the specified sphere. The return value is an array of instance indices.

Declaration
public IReadOnlyCollection<int> GetInstancesOverlappingSphere(Vector Center, float Radius, bool bSphereInWorldSpace)
Parameters
Type Name Description
Vector Center
System.Single Radius
System.Boolean bSphereInWorldSpace
Returns
Type Description
System.Collections.Generic.IReadOnlyCollection<System.Int32>
| Improve this Doc View Source

GetInstanceTransform(Int32, Boolean)

Get the transform for the instance specified. Instance is returned in local space of this component unless bWorldSpace is set. Returns True on success.

Declaration
public (Transform, bool) GetInstanceTransform(int InstanceIndex, bool bWorldSpace)
Parameters
Type Name Description
System.Int32 InstanceIndex
System.Boolean bWorldSpace
Returns
Type Description
System.ValueTuple<Transform, System.Boolean>
| Improve this Doc View Source

New(UObject, Name)

Spawn an object of this class

Declaration
public static InstancedStaticMeshComponent New(UObject obj = null, Name name = default(Name))
Parameters
Type Name Description
UObject obj
Name name
Returns
Type Description
InstancedStaticMeshComponent
| Improve this Doc View Source

RemoveInstance(Int32)

Remove the instance specified. Returns True on success. Note that this will leave the array in order, but may shrink it.

Declaration
public bool RemoveInstance(int InstanceIndex)
Parameters
Type Name Description
System.Int32 InstanceIndex
Returns
Type Description
System.Boolean
| Improve this Doc View Source

SetCullDistances(Int32, Int32)

Sets the fading start and culling end distances for this component.

Declaration
public void SetCullDistances(int StartCullDistance, int EndCullDistance)
Parameters
Type Name Description
System.Int32 StartCullDistance
System.Int32 EndCullDistance
| Improve this Doc View Source

UpdateInstanceTransform(Int32, Transform, Boolean, Boolean, Boolean)

Update the transform for the instance specified.

Declaration
public bool UpdateInstanceTransform(int InstanceIndex, Transform NewInstanceTransform, bool bWorldSpace, bool bMarkRenderStateDirty, bool bTeleport)
Parameters
Type Name Description
System.Int32 InstanceIndex
Transform NewInstanceTransform
System.Boolean bWorldSpace
System.Boolean bMarkRenderStateDirty
System.Boolean bTeleport
Returns
Type Description
System.Boolean
Remarks

@param InstanceIndex The index of the instance to update @param NewInstanceTransform The new transform @param bWorldSpace If true, the new transform interpreted as a World Space transform, otherwise it is interpreted as Local Space @param 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. @param bTeleport Whether or not the instance's physics should be moved normally, or teleported (moved instantly, ignoring velocity). @return True on success.

Operators

| Improve this Doc View Source

Implicit(IntPtr to InstancedStaticMeshComponent)

Convert from IntPtr to UObject

Declaration
public static implicit operator InstancedStaticMeshComponent(IntPtr p)
Parameters
Type Name Description
System.IntPtr p
Returns
Type Description
InstancedStaticMeshComponent