unreal.DynamicMaterialModel

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

Bases: DynamicMaterialModelBase

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] Material generated by the Model.

  • dynamic_material_instance (DynamicMaterialInstance): [Read-Only] Material Designer Material representing the MID for this Model.

  • editor_only_data_si (Object): [Read-Only] Object holding the editor-only data used by this model.

  • global_ambient_occlusion_parameter_value (DMMaterialValue): [Read-Write]

  • global_anisotropy_parameter_value (DMMaterialValue): [Read-Write]

  • global_base_color_parameter_value (DMMaterialValue): [Read-Write]

  • global_displacement_parameter_value (DMMaterialValue): [Read-Write]

  • global_emissive_color_parameter_value (DMMaterialValue): [Read-Write]

  • global_metallic_parameter_value (DMMaterialValue): [Read-Write]

  • global_normal_parameter_value (DMMaterialValue): [Read-Write]

  • global_offset_parameter_value (DMMaterialValue): [Read-Write]

  • global_opacity_parameter_value (DMMaterialValue): [Read-Write]

  • global_pixel_depth_offset_parameter_value (DMMaterialValue): [Read-Write]

  • global_refraction_parameter_value (DMMaterialValue): [Read-Write]

  • global_rotation_parameter_value (DMMaterialValue): [Read-Write]

  • global_roughness_parameter_value (DMMaterialValue): [Read-Write]

  • global_specular_parameter_value (DMMaterialValue): [Read-Write]

  • global_subsurface_color_parameter_value (DMMaterialValue): [Read-Write]

  • global_surface_thickness_parameter_value (DMMaterialValue): [Read-Write]

  • global_tangent_parameter_value (DMMaterialValue): [Read-Write]

  • global_tiling_parameter_value (DMMaterialValue): [Read-Write]

  • global_world_position_offset_parameter_value (DMMaterialValue): [Read-Write]

  • parameter_map (Map[Name, DMMaterialParameter]): [Read-Only] Map of parameter names to the objects representing that parameter.

  • runtime_components (Set[DMMaterialComponent]): [Read-Only] References to runtime components outered to this model which are not otherwise referenced.

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

add_value(value_class) → DMMaterialValue

Creates a new value of the given class and returns it.

Parameters:

value_class (type(Class))

Return type:

DMMaterialValue

bp_get_editor_only_data() → DynamicMaterialModelEditorOnlyDataInterface

Returns the editor only data for this model.

Return type:

DynamicMaterialModelEditorOnlyDataInterface

property dynamic_material: Material

[Read-Only] Material generated by the Model.

Type:

(Material)

property dynamic_material_instance: DynamicMaterialInstance

[Read-Only] Material Designer Material representing the MID for this Model.

Type:

(DynamicMaterialInstance)

property editor_only_data_si: Object

[Read-Only] Object holding the editor-only data used by this model.

Type:

(Object)

get_component_by_path(path) → DMMaterialComponent

Searches the model for a specific component based on a path.

Parameters:

path (str)

Return type:

DMMaterialComponent

get_global_opacity_value() → DMMaterialValueFloat1

Get Global Opacity Value

Return type:

DMMaterialValueFloat1

get_global_parameter_value(name) → DMMaterialValue

Returns a specific global parameter value (such as global opacity) of the given object name (see global parameter FNames) or nullptr.

Parameters:

name (Name)

Return type:

DMMaterialValue

get_global_parameter_value_for_material_property(property_) → DMMaterialValue

Returns a specific global parameter value (such as global opacity) for the given material property or nullptr.

Parameters:

property (DMMaterialPropertyType)

Return type:

DMMaterialValue

get_value_by_name(name) → DMMaterialValue

Returns a specific (non-global parameter) value of the given object name.

Parameters:

name (Name)

Return type:

DMMaterialValue

get_values() → Array[DMMaterialValue]

Returns an array of the (non-global parameter) values used in this Model.

Return type:

Array[DMMaterialValue]

property global_ambient_occlusion_parameter_value: DMMaterialValue

[Read-Only]

Type:

(DMMaterialValue)

property global_anisotropy_parameter_value: DMMaterialValue

[Read-Only]

Type:

(DMMaterialValue)

property global_base_color_parameter_value: DMMaterialValue

[Read-Only]

Type:

(DMMaterialValue)

property global_displacement_parameter_value: DMMaterialValue

[Read-Only]

Type:

(DMMaterialValue)

property global_emissive_color_parameter_value: DMMaterialValue

[Read-Only]

Type:

(DMMaterialValue)

property global_metallic_parameter_value: DMMaterialValue

[Read-Only]

Type:

(DMMaterialValue)

property global_normal_parameter_value: DMMaterialValue

[Read-Only]

Type:

(DMMaterialValue)

property global_offset_parameter_value: DMMaterialValue

[Read-Only]

Type:

(DMMaterialValue)

property global_opacity_parameter_value: DMMaterialValue

[Read-Only]

Type:

(DMMaterialValue)

property global_pixel_depth_offset_parameter_value: DMMaterialValue

[Read-Only]

Type:

(DMMaterialValue)

property global_refraction_parameter_value: DMMaterialValue

[Read-Only]

Type:

(DMMaterialValue)

property global_rotation_parameter_value: DMMaterialValue

[Read-Only]

Type:

(DMMaterialValue)

property global_roughness_parameter_value: DMMaterialValue

[Read-Only]

Type:

(DMMaterialValue)

property global_specular_parameter_value: DMMaterialValue

[Read-Only]

Type:

(DMMaterialValue)

property global_subsurface_color_parameter_value: DMMaterialValue

[Read-Only]

Type:

(DMMaterialValue)

property global_surface_thickness_parameter_value: DMMaterialValue

[Read-Only]

Type:

(DMMaterialValue)

property global_tangent_parameter_value: DMMaterialValue

[Read-Only]

Type:

(DMMaterialValue)

property global_tiling_parameter_value: DMMaterialValue

[Read-Only]

Type:

(DMMaterialValue)

property global_world_position_offset_parameter_value: DMMaterialValue

[Read-Only]

Type:

(DMMaterialValue)

has_parameter_name(parameter_name) → bool

Returns true if a parameter has with the given name exists on this Model. Will not include automatically generated component parameter names.

Parameters:

parameter_name (Name)

Return type:

bool

is_model_valid() → bool

Returns this if this is IsValid() and isn’t isn’t being destroyed.

Return type:

bool

property runtime_components: None

[Read-Only] References to runtime components outered to this model which are not otherwise referenced.

Type:

(Set[DMMaterialComponent])

property values: None

[Read-Only] Global values

Type:

(Array[DMMaterialValue])