unreal.DMMaterialProperty

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

Bases: DMMaterialComponent

Base Color, Specular, Opacity, etc

C++ Source:

  • Plugin: DynamicMaterial

  • Module: DynamicMaterialEditor

  • File: DMMaterialProperty.h

Editor Properties: (see get_editor_property/set_editor_property)

  • component_dirty (bool): [Read-Only]

  • component_state (DMComponentLifetimeState): [Read-Only]

  • components (Map[Name, DMMaterialComponent]): [Read-Only] Components of this property. Not necessarily owned or controlled by this property.

  • editable_properties (Array[Name]): [Read-Only]

  • enabled (bool): [Read-Only] Whether this property is enabled. If it is not enabled, it will generate no expressions.

  • input_connection_map (DMMaterialStageConnection): [Read-Only] The map of expressions connected to this property’s input node.

  • input_connector_type (DMValueType): [Read-Only] The value type used to connect to this property. Will be either VT_Float1, VT_Float3_RGB or VT_Float3_XYZ.

  • material_property (DMMaterialPropertyType): [Read-Only] The property type of this property.

  • output_processor (MaterialFunctionInterface): [Read-Only] An optional material function which is applied in between the property and its inputs.

property components: None

[Read-Only] Components of this property. Not necessarily owned or controlled by this property.

Type:

(Map[Name, DMMaterialComponent])

property enabled: bool

[Read-Only] Whether this property is enabled. If it is not enabled, it will generate no expressions.

Type:

(bool)

get_description() → Text

The description of this property based on the EDMMaterialPropertyType enum.

Return type:

Text

get_input_connection_map() → DMMaterialStageConnection
Returns:

Get the expressions which connect to this property, mapped per channel.

Return type:

DMMaterialStageConnection

get_input_connector_type() → DMValueType
Returns:

The value type of this property. Will be either VT_Float1, VT_Float3_RGB or VT_Float3_XYZ.

Return type:

DMValueType

get_material_model_editor_only_data() → DynamicMaterialModelEditorOnlyData

Get Material Model Editor Only Data

Return type:

DynamicMaterialModelEditorOnlyData

get_material_property() → DMMaterialPropertyType

Get Material Property

Return type:

DMMaterialPropertyType

get_output_processor() → MaterialFunctionInterface

The output process is an optional material function which is applied in between the property and its inputs.

Returns:

The current output processor.

Return type:

MaterialFunctionInterface

property input_connection_map: DMMaterialStageConnection

[Read-Only] The map of expressions connected to this property’s input node.

Type:

(DMMaterialStageConnection)

property input_connector_type: DMValueType

[Read-Only] The value type used to connect to this property. Will be either VT_Float1, VT_Float3_RGB or VT_Float3_XYZ.

Type:

(DMValueType)

is_enabled() → bool

Is Enabled

Return type:

bool

is_material_pin() → bool

Whether this property represents a material pin. Only materials properties with a pin will be generated by default.

Return type:

bool

property material_property: DMMaterialPropertyType

[Read-Only] The property type of this property.

Type:

(DMMaterialPropertyType)

property output_processor: MaterialFunctionInterface

[Read-Only] An optional material function which is applied in between the property and its inputs.

Type:

(MaterialFunctionInterface)

reset_input_connection_map() → None

Empty the connection map and recalculate the input types.

set_enabled(enabled) → None

Set Enabled

Parameters:

enabled (bool)

set_output_processor(function) → None

The output process is an optional material function which is applied in between the property and its inputs.

Parameters:

function (MaterialFunctionInterface) – The new output processor.