DefaultSplineMeshTexture

DefaultSplineMeshTexture

#Overview

name: DefaultSplineMeshTexture

The value of this variable can be defined or overridden in .ini config files. 1 .ini config file referencing this setting variable.

It is referenced in 3 C++ source files.

#Summary

#Usage in the C++ source code

The purpose of DefaultSplineMeshTexture is to provide a default texture for the spline mesh used in the CineCameraRigRail component when speed visualization is turned off. This setting variable is part of the visual representation system for camera rig rails in Unreal Engine 5.

This setting variable is primarily used within the CineCameraRigs plugin, specifically in the CineCameraRigRail module. It’s utilized in the ACineCameraRigRail class, which is responsible for managing camera rig rails in cinematic scenes.

The value of this variable is set in the UCineCameraRigRailSettings class, which is likely configured through the project settings or a configuration file. It’s defined as a TSoftObjectPtr, allowing for lazy loading of the texture asset.

DefaultSplineMeshTexture interacts with the SplineMeshTexture variable in the ACineCameraRigRail class. When speed visualization is off or when the rail is being driven by Sequencer, the DefaultSplineMeshTexture is loaded and assigned to SplineMeshTexture.

Developers should be aware that this texture is loaded synchronously when needed, which could potentially cause performance issues if the texture is large or if it’s accessed frequently. It’s important to ensure that the referenced texture asset is available and properly set in the project settings.

Best practices when using this variable include:

  1. Choosing an appropriate, lightweight texture for the default spline mesh to minimize loading times.
  2. Ensuring the referenced texture asset is included in the project and properly set in the CineCameraRigRailSettings.
  3. Consider preloading the texture if it’s going to be used frequently to avoid synchronous loading during runtime.
  4. Be mindful of memory usage, especially if creating multiple instances of CineCameraRigRail in a scene.

#Setting Variables

#References In INI files

Location: <Workspace>/Engine/Plugins/Experimental/CineCameraRigs/Config/BaseCineCameraRigs.ini:3, section: [/Script/CineCameraRigs.CineCameraRigRailSettings]

#References in C++ code

#Callsites

This variable is referenced in the following C++ source code:

#Loc: <Workspace>/Engine/Plugins/Experimental/CineCameraRigs/Source/CineCameraRigs/Private/CineCameraRigRail.cpp:49

Scope (from outer to inner):

file
function     ACineCameraRigRail::ACineCameraRigRail

Source code excerpt:

	}

	UTexture2D* DefaultTexture = GetDefault<UCineCameraRigRailSettings>()->DefaultSplineMeshTexture.LoadSynchronous();
	if (DefaultTexture)
	{
		SplineMeshTexture = DefaultTexture;
	}

	bLockOrientationToRail = true;

#Loc: <Workspace>/Engine/Plugins/Experimental/CineCameraRigs/Source/CineCameraRigs/Private/CineCameraRigRail.cpp:472

Scope (from outer to inner):

file
function     void ACineCameraRigRail::UpdateSpeedHeatmap

Source code excerpt:

	if (!bDisplaySpeedHeatmap || IsSequencerDriven())
	{
		UTexture2D* DefaultTexture = GetDefault<UCineCameraRigRailSettings>()->DefaultSplineMeshTexture.LoadSynchronous();
		if (DefaultTexture)
		{
			SplineMeshTexture = DefaultTexture;
		}
		return;
	}

#Loc: <Workspace>/Engine/Plugins/Experimental/CineCameraRigs/Source/CineCameraRigs/Public/CineCameraRigsSettings.h:21

Scope (from outer to inner):

file
class        class UCineCameraRigRailSettings : public UObject

Source code excerpt:

	/* Path to the default spline mesh texture used when speed visualization is off*/
	UPROPERTY(config, EditAnywhere, BlueprintReadWrite, Category = CineCameraRigRail)
	TSoftObjectPtr<UTexture2D> DefaultSplineMeshTexture;

	/* Path to the texture used in the speed visualization when drive mode is Speed*/
	UPROPERTY(config, EditAnywhere, BlueprintReadWrite, Category = CineCameraRigRail)
	TSoftObjectPtr<UTexture2D> SpeedModeSplineMeshTexture;
};