Show / Hide Table of Contents

Class MaterialEditingLibrary

Blueprint library for creating/editing Materials

Inheritance
System.Object
UObject
BlueprintFunctionLibrary
MaterialEditingLibrary
Inherited Members
UObject.TransientPackage
UObject.CastTo<T>(UObject)
UObject.CastTo(UObject, Type)
UObject.RemoveObject(UObject)
UObject.MakeObjectArrayField<T>(NativeArray*)
UObject.NotImplemented<T>()
UObject.Construct()
UObject.GetHashCode()
UObject.GetName()
UObject.ToString()
UObject.Name
UObject._None
UObject.None
UObject.ObjPointer
UObject.LoadObjectFromClass(Class, UObject, String, String, LoadFlags, PackageMap, Boolean)
UObject.LoadClass(Class, UObject, String, String, LoadFlags, PackageMap)
UObject.GetPropertyFor<T>(Name)
UObject.ExecuteUbergraph
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.MaterialEditor
Assembly: UE4DotNet.dll
Syntax
public class MaterialEditingLibrary : BlueprintFunctionLibrary

Properties

| Improve this Doc View Source

DefaultObject

Get UE4 Default Object for this Class

Declaration
public static MaterialEditingLibrary DefaultObject { get; }
Property Value
Type Description
MaterialEditingLibrary
| 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

ClearAllMaterialInstanceParameters(MaterialInstanceConstant)

Clears all material parameters set by this Material Instance

Declaration
public static void ClearAllMaterialInstanceParameters(MaterialInstanceConstant Instance)
Parameters
Type Name Description
MaterialInstanceConstant Instance
| Improve this Doc View Source

ConnectMaterialExpressions(MaterialExpression, String, MaterialExpression, String)

Create connection between two material expressions @

Declaration
public static bool ConnectMaterialExpressions(MaterialExpression FromExpression, string FromOutputName, MaterialExpression ToExpression, string ToInputName)
Parameters
Type Name Description
MaterialExpression FromExpression
System.String FromOutputName
MaterialExpression ToExpression
System.String ToInputName
Returns
Type Description
System.Boolean
Remarks

param FromExpression Expression to make connection from @param FromOutputName Name of output of FromExpression to make connection from. Leave empty to use first output. @param ToExpression Expression to make connection to @param ToInputName Name of input of ToExpression to make connection to. Leave empty to use first input.

| Improve this Doc View Source

ConnectMaterialProperty(MaterialExpression, String, Byte)

Connect a material expression output to one of the material property inputs (e.

Declaration
public static bool ConnectMaterialProperty(MaterialExpression FromExpression, string FromOutputName, byte Property)
Parameters
Type Name Description
MaterialExpression FromExpression
System.String FromOutputName
System.Byte Property
Returns
Type Description
System.Boolean
Remarks

g. diffuse color, opacity etc) @param FromExpression Expression to make connection from @param FromOutputName Name of output of FromExpression to make connection from @param Property Property input on material to make connection to

| Improve this Doc View Source

CreateMaterialExpression(Material, SubclassOf<MaterialExpression>, Int32, Int32)

Create a new material expression node within the supplied material @

Declaration
public static MaterialExpression CreateMaterialExpression(Material Material, SubclassOf<MaterialExpression> ExpressionClass, int NodePosX, int NodePosY)
Parameters
Type Name Description
Material Material
SubclassOf<MaterialExpression> ExpressionClass
System.Int32 NodePosX
System.Int32 NodePosY
Returns
Type Description
MaterialExpression
Remarks

param Material Material asset to add an expression to @param ExpressionClass Class of expression to add @param NodePosX X position of new expression node @param NodePosY Y position of new expression node

| Improve this Doc View Source

CreateMaterialExpressionInFunction(MaterialFunction, SubclassOf<MaterialExpression>, Int32, Int32)

Create a new material expression node within the supplied material function @

Declaration
public static MaterialExpression CreateMaterialExpressionInFunction(MaterialFunction MaterialFunction, SubclassOf<MaterialExpression> ExpressionClass, int NodePosX, int NodePosY)
Parameters
Type Name Description
MaterialFunction MaterialFunction
SubclassOf<MaterialExpression> ExpressionClass
System.Int32 NodePosX
System.Int32 NodePosY
Returns
Type Description
MaterialExpression
Remarks

param MaterialFunction Material function asset to add an expression to @param ExpressionClass Class of expression to add @param NodePosX X position of new expression node @param NodePosY Y position of new expression node

| Improve this Doc View Source

DeleteAllMaterialExpressions(Material)

Delete all material expressions in the supplied material

Declaration
public static void DeleteAllMaterialExpressions(Material Material)
Parameters
Type Name Description
Material Material
| Improve this Doc View Source

DeleteAllMaterialExpressionsInFunction(MaterialFunction)

Delete all material expressions in the supplied material function

Declaration
public static void DeleteAllMaterialExpressionsInFunction(MaterialFunction MaterialFunction)
Parameters
Type Name Description
MaterialFunction MaterialFunction
| Improve this Doc View Source

DeleteMaterialExpression(Material, MaterialExpression)

Delete a specific expression from a material. Will disconnect from other expressions.

Declaration
public static void DeleteMaterialExpression(Material Material, MaterialExpression Expression)
Parameters
Type Name Description
Material Material
MaterialExpression Expression
| Improve this Doc View Source

DeleteMaterialExpressionInFunction(MaterialFunction, MaterialExpression)

Delete a specific expression from a material function. Will disconnect from other expressions.

Declaration
public static void DeleteMaterialExpressionInFunction(MaterialFunction MaterialFunction, MaterialExpression Expression)
Parameters
Type Name Description
MaterialFunction MaterialFunction
MaterialExpression Expression
| Improve this Doc View Source

GetMaterialInstanceScalarParameterValue(MaterialInstanceConstant, Name)

Get the current scalar (float) parameter value from a Material Instance

Declaration
public static float GetMaterialInstanceScalarParameterValue(MaterialInstanceConstant Instance, Name ParameterName)
Parameters
Type Name Description
MaterialInstanceConstant Instance
Name ParameterName
Returns
Type Description
System.Single
| Improve this Doc View Source

GetMaterialInstanceTextureParameterValue(MaterialInstanceConstant, Name)

Get the current texture parameter value from a Material Instance

Declaration
public static Texture GetMaterialInstanceTextureParameterValue(MaterialInstanceConstant Instance, Name ParameterName)
Parameters
Type Name Description
MaterialInstanceConstant Instance
Name ParameterName
Returns
Type Description
Texture
| Improve this Doc View Source

GetMaterialInstanceVectorParameterValue(MaterialInstanceConstant, Name)

Get the current vector parameter value from a Material Instance

Declaration
public static LinearColor GetMaterialInstanceVectorParameterValue(MaterialInstanceConstant Instance, Name ParameterName)
Parameters
Type Name Description
MaterialInstanceConstant Instance
Name ParameterName
Returns
Type Description
LinearColor
| Improve this Doc View Source

GetNumMaterialExpressions(Material)

Returns number of material expressions in the supplied material

Declaration
public static int GetNumMaterialExpressions(Material Material)
Parameters
Type Name Description
Material Material
Returns
Type Description
System.Int32
| Improve this Doc View Source

GetNumMaterialExpressionsInFunction(MaterialFunction)

Returns number of material expressions in the supplied material

Declaration
public static int GetNumMaterialExpressionsInFunction(MaterialFunction MaterialFunction)
Parameters
Type Name Description
MaterialFunction MaterialFunction
Returns
Type Description
System.Int32
| Improve this Doc View Source

New(UObject, Name)

Spawn an object of this class

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

RecompileMaterial(Material)

Trigger a recompile of a material. Must be performed after making changes to the graph to have changes reflected.

Declaration
public static void RecompileMaterial(Material Material)
Parameters
Type Name Description
Material Material
| Improve this Doc View Source

SetMaterialInstanceParent(MaterialInstanceConstant, MaterialInterface)

Set the parent Material or Material Instance to use for this Material Instance

Declaration
public static void SetMaterialInstanceParent(MaterialInstanceConstant Instance, MaterialInterface NewParent)
Parameters
Type Name Description
MaterialInstanceConstant Instance
MaterialInterface NewParent
| Improve this Doc View Source

SetMaterialInstanceScalarParameterValue(MaterialInstanceConstant, Name, Single)

Set the scalar (float) parameter value for a Material Instance

Declaration
public static bool SetMaterialInstanceScalarParameterValue(MaterialInstanceConstant Instance, Name ParameterName, float Value)
Parameters
Type Name Description
MaterialInstanceConstant Instance
Name ParameterName
System.Single Value
Returns
Type Description
System.Boolean
| Improve this Doc View Source

SetMaterialInstanceTextureParameterValue(MaterialInstanceConstant, Name, Texture)

Set the texture parameter value for a Material Instance

Declaration
public static bool SetMaterialInstanceTextureParameterValue(MaterialInstanceConstant Instance, Name ParameterName, Texture Value)
Parameters
Type Name Description
MaterialInstanceConstant Instance
Name ParameterName
Texture Value
Returns
Type Description
System.Boolean
| Improve this Doc View Source

SetMaterialInstanceVectorParameterValue(MaterialInstanceConstant, Name, LinearColor)

Set the vector parameter value for a Material Instance

Declaration
public static bool SetMaterialInstanceVectorParameterValue(MaterialInstanceConstant Instance, Name ParameterName, LinearColor Value)
Parameters
Type Name Description
MaterialInstanceConstant Instance
Name ParameterName
LinearColor Value
Returns
Type Description
System.Boolean
| Improve this Doc View Source

SetMaterialUsage(Material, Byte)

Enable a particular usage for the supplied material (e.

Declaration
public static (bool, bool) SetMaterialUsage(Material Material, byte Usage)
Parameters
Type Name Description
Material Material
System.Byte Usage
Returns
Type Description
System.ValueTuple<System.Boolean, System.Boolean>
Remarks

g. SkeletalMesh, ParticleSprite etc) @param Material Material to change usage for @param Usage New usage type to enable for this material @param bNeedsRecompile Returned to indicate if material needs recompiling after this change

| Improve this Doc View Source

UpdateMaterialFunction(MaterialFunctionInterface, Material)

Update a Material Function after edits have been made.

Declaration
public static void UpdateMaterialFunction(MaterialFunctionInterface MaterialFunction, Material PreviewMaterial)
Parameters
Type Name Description
MaterialFunctionInterface MaterialFunction
Material PreviewMaterial
Remarks

Will recompile any Materials that use the supplied Material Function.

| Improve this Doc View Source

UpdateMaterialInstance(MaterialInstanceConstant)

Called after making modifications to a Material Instance to recompile shaders etc.

Declaration
public static void UpdateMaterialInstance(MaterialInstanceConstant Instance)
Parameters
Type Name Description
MaterialInstanceConstant Instance

Operators

| Improve this Doc View Source

Implicit(IntPtr to MaterialEditingLibrary)

Convert from IntPtr to UObject

Declaration
public static implicit operator MaterialEditingLibrary(IntPtr p)
Parameters
Type Name Description
System.IntPtr p
Returns
Type Description
MaterialEditingLibrary
  • Improve this Doc
  • View Source
Back to top Generated by DocFX