unreal.DynamicMaterialModel

class unreal.DynamicMaterialModel(outer: Object | None = None, name: Name | str = 'None')

Bases: Object

Dynamic Material Model

C++ Source:

  • Plugin: DynamicMaterial

  • Module: DynamicMaterial

  • File: DynamicMaterialModel.h

Editor Properties: (see get_editor_property/set_editor_property)

  • dynamic_material (Material): [Read-Only]

  • dynamic_material_instance (DynamicMaterialInstance): [Read-Only]

  • editor_only_data_si (DynamicMaterialModelEditorOnlyDataInterface): [Read-Only]

  • global_opacity_parameter (DMMaterialParameter): [Read-Only]

  • global_opacity_value (DMMaterialValueFloat1): [Read-Only]

  • parameter_map (Map[Name, DMMaterialParameter]): [Read-Only]

  • values (Array[DMMaterialValue]): [Read-Only]

add_value(type) → DMMaterialValue

Add Value

Parameters:

type (DMValueType) –

Return type:

DMMaterialValue

bp_get_editor_only_data() → DynamicMaterialModelEditorOnlyDataInterface

BP Get Editor Only Data

Return type:

DynamicMaterialModelEditorOnlyDataInterface

conditional_free_parameter(parameter) → bool

Removes this specific object from the parameter map if the name is in use by a different parameter. Returns true if, after this call, the object is not in the parameter map.

Parameters:

parameter (DMMaterialParameter) –

Return type:

bool

create_unique_parameter(base_name) → DMMaterialParameter

Creates a new parameter and assigns it a unique name.

Parameters:

base_name (Name) –

Return type:

DMMaterialParameter

property dynamic_material: Material

[Read-Only]

Type:

(Material)

property dynamic_material_instance: DynamicMaterialInstance

[Read-Only]

Type:

(DynamicMaterialInstance)

property editor_only_data_si: DynamicMaterialModelEditorOnlyDataInterface

[Read-Only]

Type:

(DynamicMaterialModelEditorOnlyDataInterface)

free_parameter(parameter) → None

Removes parameter by the name assigned to this parameter object.

Parameters:

parameter (DMMaterialParameter) –

get_component_by_path(path) → DMMaterialComponent

Get Component by Path

Parameters:

path (str) –

Return type:

DMMaterialComponent

get_generated_material() → Material

Get Generated Material

Return type:

Material

get_global_opacity_value() → DMMaterialValueFloat1

Get Global Opacity Value

Return type:

DMMaterialValueFloat1

get_value_by_index(index) → DMMaterialValue

Get Value by Index

Parameters:

index (int32) –

Return type:

DMMaterialValue

get_value_by_name(name) → DMMaterialValue

Get Value by Name

Parameters:

name (Name) –

Return type:

DMMaterialValue

get_values() → Array[DMMaterialValue]

Get Values

Return type:

Array[DMMaterialValue]

property global_opacity_parameter: DMMaterialParameter

[Read-Only]

Type:

(DMMaterialParameter)

property global_opacity_value: DMMaterialValueFloat1

[Read-Only]

Type:

(DMMaterialValueFloat1)

has_parameter_name(parameter_name) → bool

Has Parameter Name

Parameters:

parameter_name (Name) –

Return type:

bool

remove_value_by_index(index) → None

Remove Value by Index

Parameters:

index (int32) –

remove_value_by_name(name) → None

Remove Value by Name

Parameters:

name (Name) –

rename_parameter(parameter, base_name) → None

Updates the name on an existing parameter.

Parameters:
reset_data() → None

Reset Data

property values: None

[Read-Only]

Type:

(Array[DMMaterialValue])