unreal.GeometryScriptSimplifyMeshOptions

class unreal.GeometryScriptSimplifyMeshOptions(method: GeometryScriptRemoveMeshSimplificationType = Ellipsis, allow_seam_collapse: bool = False, allow_seam_smoothing: bool = False, allow_seam_splits: bool = False, preserve_vertex_positions: bool = False, retain_quadric_memory: bool = False, edge_length_weight_map: GeometryScriptWeightMapDensity = Ellipsis, geometric_tolerance_weight_map: GeometryScriptWeightMapDensity = Ellipsis, quadric_error_weight_map: GeometryScriptWeightMapDensity = Ellipsis, regularize_weight: float = 0.0, auto_compact: bool = False, quadric_variant: GeometryScriptMeshSimplificationQuadricVariant = Ellipsis, normal_attribute_weight: float = 0.0, tangent_attribute_weight: float = 0.0, color_attribute_weight: float = 0.0, tex_coord_attribute_weight: float = 0.0, scale_correction: float = 0.0)

Bases: StructBase

Geometry Script Simplify Mesh Options

C++ Source:

  • Plugin: GeometryScripting

  • Module: GeometryScriptingCore

  • File: MeshSimplifyFunctions.h

Editor Properties: (see get_editor_property/set_editor_property)

  • allow_seam_collapse (bool): [Read-Write]

  • allow_seam_smoothing (bool): [Read-Write]

  • allow_seam_splits (bool): [Read-Write]

  • auto_compact (bool): [Read-Write] If enabled, the simplified mesh is automatically compacted to remove gaps in the index space. This is expensive and can be disabled by advanced users.

  • color_attribute_weight (float): [Read-Write] Control the influence of color channels to the simplification metric. alpha is ignored but preserved. (for attribute-aware quadrics)

  • edge_length_weight_map (GeometryScriptWeightMapDensity): [Read-Write] Optional weight map to scale measured edge lengths

  • geometric_tolerance_weight_map (GeometryScriptWeightMapDensity): [Read-Write] Optional weight map to scale measured geometric errors

  • method (GeometryScriptRemoveMeshSimplificationType): [Read-Write]

  • normal_attribute_weight (float): [Read-Write] Control the influence of the normals to the simplification metric (for attribute-aware quadrics)

  • preserve_vertex_positions (bool): [Read-Write]

  • quadric_error_weight_map (GeometryScriptWeightMapDensity): [Read-Write] Optional weight map to scale measured quadric error

  • quadric_variant (GeometryScriptMeshSimplificationQuadricVariant): [Read-Write]

  • regularize_weight (float): [Read-Write] Setting a very small RegularizeWeight value (e.g., 0.000001) can improve triangle quality and the effect of the QuadricErrorWeightMap in flat regions

  • retain_quadric_memory (bool): [Read-Write]

  • scale_correction (float): [Read-Write] The behavior of the simplifier is not scale invariant: scaling an object by X will impact the geometry terms X^2 times more than it will impact the attributes and change the relative impact. To facilitate rebalancing, while working with the same attribute weights, this setting can be used. Its meaning corresponds to the scale of the object relative to the scale at which the attribute weights were initially calibrated for. This means, setting this value to X results in the same behavior as if the object was scaled down by a factor of X and rescaled back up after simplification. Only supported for attribute aware method.

  • tangent_attribute_weight (float): [Read-Write] Control the influence of tangents and bitangents to the simplification metric (for attribute-aware quadrics)

  • tex_coord_attribute_weight (float): [Read-Write] Control the influence of texture coordinates the simplification metric (all available channels). (for attribute-aware quadrics)

property allow_seam_collapse: bool

[Read-Write]

Type:

(bool)

property allow_seam_smoothing: bool

[Read-Write]

Type:

(bool)

property allow_seam_splits: bool

[Read-Write]

Type:

(bool)

property auto_compact: bool

[Read-Write] If enabled, the simplified mesh is automatically compacted to remove gaps in the index space. This is expensive and can be disabled by advanced users.

Type:

(bool)

property color_attribute_weight: float

[Read-Write] Control the influence of color channels to the simplification metric. alpha is ignored but preserved. (for attribute-aware quadrics)

Type:

(float)

property edge_length_weight_map: GeometryScriptWeightMapDensity

[Read-Write] Optional weight map to scale measured edge lengths

Type:

(GeometryScriptWeightMapDensity)

property geometric_tolerance_weight_map: GeometryScriptWeightMapDensity

[Read-Write] Optional weight map to scale measured geometric errors

Type:

(GeometryScriptWeightMapDensity)

property method: GeometryScriptRemoveMeshSimplificationType

[Read-Write]

Type:

(GeometryScriptRemoveMeshSimplificationType)

property normal_attribute_weight: float

[Read-Write] Control the influence of the normals to the simplification metric (for attribute-aware quadrics)

Type:

(float)

property preserve_vertex_positions: bool

[Read-Write]

Type:

(bool)

property quadric_error_weight_map: GeometryScriptWeightMapDensity

[Read-Write] Optional weight map to scale measured quadric error

Type:

(GeometryScriptWeightMapDensity)

property quadric_variant: GeometryScriptMeshSimplificationQuadricVariant

[Read-Write]

Type:

(GeometryScriptMeshSimplificationQuadricVariant)

property regularize_weight: float

[Read-Write] Setting a very small RegularizeWeight value (e.g., 0.000001) can improve triangle quality and the effect of the QuadricErrorWeightMap in flat regions

Type:

(float)

property retain_quadric_memory: bool

[Read-Write]

Type:

(bool)

property scale_correction: float

scaling an object by X will impact the geometry terms X^2 times more than it will impact the attributes and change the relative impact. To facilitate rebalancing, while working with the same attribute weights, this setting can be used. Its meaning corresponds to the scale of the object relative to the scale at which the attribute weights were initially calibrated for. This means, setting this value to X results in the same behavior as if the object was scaled down by a factor of X and rescaled back up after simplification. Only supported for attribute aware method.

Type:

(float)

Type:

[Read-Write] The behavior of the simplifier is not scale invariant

property tangent_attribute_weight: float

[Read-Write] Control the influence of tangents and bitangents to the simplification metric (for attribute-aware quadrics)

Type:

(float)

property tex_coord_attribute_weight: float

[Read-Write] Control the influence of texture coordinates the simplification metric (all available channels). (for attribute-aware quadrics)

Type:

(float)