unreal.DMMaterialLayerObject
¶
- class unreal.DMMaterialLayerObject(outer: Object | None = None, name: Name | str = 'None')¶
Bases:
DMMaterialComponent
DMMaterial Layer Object
C++ Source:
Plugin: DynamicMaterial
Module: DynamicMaterialEditor
File: DMMaterialLayer.h
Editor Properties: (see get_editor_property/set_editor_property)
component_dirty
(bool): [Read-Only]component_state
(DMComponentLifetimeState): [Read-Only]editable_properties
(Array[Name]): [Read-Only]effect_stack
(DMMaterialEffectStack): [Read-Only]enabled
(bool): [Read-Only]layer_name
(Text): [Read-Only]linked_u_vs
(bool): [Read-Only]material_property
(DMMaterialPropertyType): [Read-Only]stages
(Array[DMMaterialStage]): [Read-Only]
- are_all_stages_enabled(stage_scope) bool ¶
Checks if both stages are enabled and valid
- Parameters:
stage_scope (DMMaterialLayerStage) –
- Return type:
- are_all_stages_valid(stage_scope) bool ¶
Are All Stages Valid
- Parameters:
stage_scope (DMMaterialLayerStage) –
- Return type:
- can_move_layer_above(layer) bool ¶
Can Move Layer Above
- Parameters:
layer (DMMaterialLayerObject) –
- Return type:
- can_move_layer_below(layer) bool ¶
Can Move Layer Below
- Parameters:
layer (DMMaterialLayerObject) –
- Return type:
- classmethod create_layer(slot, material_property, stages) DMMaterialLayerObject ¶
Create Layer
- Parameters:
slot (DMMaterialSlot) –
material_property (DMMaterialPropertyType) –
stages (Array[DMMaterialStage]) –
- Return type:
- property effect_stack: DMMaterialEffectStack¶
[Read-Only]
- Type:
- find_index() int32 ¶
Find Index
- Return type:
int32
- get_effect_stack() DMMaterialEffectStack ¶
Get Effect Stack
- Return type:
- get_first_enabled_stage(stage_scope) DMMaterialStage ¶
Checks for the first enabled and valid stage.
- Parameters:
stage_scope (DMMaterialLayerStage) –
- Return type:
- get_first_stage_being_edited(stage_scope) DMMaterialStage ¶
Get First Stage Being Edited
- Parameters:
stage_scope (DMMaterialLayerStage) –
- Return type:
- get_first_valid_stage(stage_scope) DMMaterialStage ¶
Get First Valid Stage
- Parameters:
stage_scope (DMMaterialLayerStage) –
- Return type:
- get_last_enabled_stage(stage_scope) DMMaterialStage ¶
Checks for the last enabled and valid stage.
- Parameters:
stage_scope (DMMaterialLayerStage) –
- Return type:
- get_last_valid_stage(stage_scope) DMMaterialStage ¶
Get Last Valid Stage
- Parameters:
stage_scope (DMMaterialLayerStage) –
- Return type:
- get_material_property() DMMaterialPropertyType ¶
Get Material Property
- Return type:
- get_next_layer(using_property, search_for) DMMaterialLayerObject ¶
Get Next Layer
- Parameters:
using_property (DMMaterialPropertyType) –
search_for (DMMaterialLayerStage) –
- Return type:
- get_previous_layer(using_property, search_for) DMMaterialLayerObject ¶
Get Previous Layer
- Parameters:
using_property (DMMaterialPropertyType) –
search_for (DMMaterialLayerStage) –
- Return type:
- get_slot() DMMaterialSlot ¶
Get Slot
- Return type:
- get_stage(stage_type=DMMaterialLayerStage.ALL, check_enabled=False) DMMaterialStage ¶
Get Stage
- Parameters:
stage_type (DMMaterialLayerStage) –
check_enabled (bool) –
- Return type:
- get_stage_type(stage) DMMaterialLayerStage ¶
Get Stage Type
- Parameters:
stage (DMMaterialStage) –
- Return type:
- get_stages(stage_type=DMMaterialLayerStage.ALL, check_enabled=False) Array[DMMaterialStage] ¶
Get Stages
- Parameters:
stage_type (DMMaterialLayerStage) –
check_enabled (bool) –
- Return type:
- has_valid_stage(stage) bool ¶
Has Valid Stage
- Parameters:
stage (DMMaterialStage) –
- Return type:
- has_valid_stage_of_type(stage_scope=DMMaterialLayerStage.ALL) bool ¶
Has Valid Stage Of Type
- Parameters:
stage_scope (DMMaterialLayerStage) –
- Return type:
- is_stage_being_edited(stage_scope=DMMaterialLayerStage.ALL) bool ¶
Is Stage Being Edited
- Parameters:
stage_scope (DMMaterialLayerStage) –
- Return type:
- is_stage_enabled(stage_scope=DMMaterialLayerStage.ALL) bool ¶
Is Stage Enabled
- Parameters:
stage_scope (DMMaterialLayerStage) –
- Return type:
- property material_property: DMMaterialPropertyType¶
[Read-Only]
- Type:
- set_material_property(material_property) bool ¶
Set Material Property
- Parameters:
material_property (DMMaterialPropertyType) –
- Return type:
- set_stage(stage_type, stage) bool ¶
Set Stage
- Parameters:
stage_type (DMMaterialLayerStage) –
stage (DMMaterialStage) –
- Return type: