UMaterialParameterCollectionUtilities Class Reference

#include <MaterialParameterCollectionUtilities.h>

Inheritance diagram for UMaterialParameterCollectionUtilities:

Collaboration diagram for UMaterialParameterCollectionUtilities:

Static Public Member Functions
static bool	UpdateMaterialCollectionVectorValue (UMaterialParameterCollectionInstance *MPCInstance, const FName ParameterName, const FVector4 Value)
static bool	UpdateMaterialCollectionScalarValue (UMaterialParameterCollectionInstance *MPCInstance, const FName ParameterName, const float Value)
static UMaterialParameterCollectionInstance *	LoadMaterialParameterCollectionInstance (const UObject *WorldContextObject, const FString &Path)

Detailed Description

A utility class for loading and manipulating Material Parameter Collections.

Definition at line 18 of file MaterialParameterCollectionUtilities.h.

Member Function Documentation

LoadMaterialParameterCollectionInstance()

UMaterialParameterCollectionInstance * UMaterialParameterCollectionUtilities::LoadMaterialParameterCollectionInstance ( const UObject *  WorldContextObject, const FString &  Path  )

static

Loads a Material Parameter Collection Instance from a specified asset path.

Parameters

World	The world context where the Material Parameter Collection Instance is used.
Path	The asset path of the Material Parameter Collection to load, e.g., "/Game/Path/To/Collection".

Returns

UMaterialParameterCollectionInstance* The loaded Material Parameter Collection Instance, or nullptr if the load fails.

Definition at line 33 of file MaterialParameterCollectionUtilities.cpp.

{
    if (!WorldContextObject || !GEngine)
    {
        return nullptr;
    }
 
    UWorld* World = GEngine->GetWorldFromContextObject(WorldContextObject, EGetWorldErrorMode::LogAndReturnNull);
    UMaterialParameterCollection* Collection = LoadObject<UMaterialParameterCollection>(nullptr, *Path);
    if (Collection && World)
    {
        return World->GetParameterCollectionInstance(Collection);
    }
 
    return nullptr;
}

Referenced by USimulatorJsonParser::ParseAndSetSemanticColors().

UpdateMaterialCollectionScalarValue()

bool UMaterialParameterCollectionUtilities::UpdateMaterialCollectionScalarValue ( UMaterialParameterCollectionInstance *  MPCInstance, const FName  ParameterName, const float  Value  )

static

Updates a float parameter within a Material Parameter Collection Instance and returns success status.

Parameters

MPCInstance	The Material Parameter Collection Instance to update.
ParameterName	The name of the float parameter to update.
Value	The new float value to set for the parameter.

Returns

bool True if the parameter was successfully updated, False otherwise.

Definition at line 23 of file MaterialParameterCollectionUtilities.cpp.

{
    if (MPCInstance)
    {
        return MPCInstance->SetScalarParameterValue(ParameterName, Value);
    }
 
    return false;
}

UpdateMaterialCollectionVectorValue()

bool UMaterialParameterCollectionUtilities::UpdateMaterialCollectionVectorValue ( UMaterialParameterCollectionInstance *  MPCInstance, const FName  ParameterName, const FVector4  Value  )

static

Updates a Vector4 parameter within a Material Parameter Collection Instance and returns success status.

Parameters

MPCInstance	The Material Parameter Collection Instance to update.
ParameterName	The name of the Vector4 parameter to update.
Value	The new Vector4 value to set for the parameter.

Returns

bool True if the parameter was successfully updated, False otherwise.

Definition at line 13 of file MaterialParameterCollectionUtilities.cpp.

{
    if (MPCInstance)
    {
       return MPCInstance->SetVectorParameterValue(ParameterName, Value);
    }
 
    return false;
}

Referenced by USimulatorJsonParser::ParseAndSetSemanticColors().

---

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

• Unreal/Agrarsense/Source/Agrarsense/Utils/MaterialParameterCollectionUtilities.h
• Unreal/Agrarsense/Source/Agrarsense/Utils/MaterialParameterCollectionUtilities.cpp