unreal.GeometryScriptTransferBoneWeightsOptions

class unreal.GeometryScriptTransferBoneWeightsOptions(transfer_method: TransferBoneWeightsMethod = Ellipsis, output_target_mesh_bones: OutputTargetMeshBones = Ellipsis, source_profile: GeometryScriptBoneWeightProfile = Ellipsis, target_profile: GeometryScriptBoneWeightProfile = Ellipsis, radius_percentage: float = 0.0, normal_threshold: float = 0.0, layered_mesh_support: bool = False, num_smoothing_iterations: int = 0, smoothing_strength: float = 0.0, inpaint_mask: Name = 'None')

Bases: StructBase

Geometry Script Transfer Bone Weights Options

C++ Source:

  • Plugin: GeometryScripting

  • Module: GeometryScriptingCore

  • File: MeshBoneWeightFunctions.h

Editor Properties: (see get_editor_property/set_editor_property)

  • inpaint_mask (Name): [Read-Write] Optional weight attribute name where a non-zero value indicates that we want the skinning weights for the vertex to be computed automatically instead of it being copied over from the source mesh.

  • layered_mesh_support (bool): [Read-Write] If true, when the closest point doesn’t pass the normal threshold test, will try again with a flipped normal. This helps with layered meshes where the “inner” and “outer” layers are close to each other but whose normals are pointing in the opposite directions.

  • normal_threshold (double): [Read-Write] Maximum angle (in degrees) difference between the target and the source point normals to be considred a match. If negative, normals are ignored. Only used in the InpaintWeights algorithm.

  • num_smoothing_iterations (int32): [Read-Write] The number of optional post-processing smoothing iterations applied to the vertices without the match.

  • output_target_mesh_bones (OutputTargetMeshBones): [Read-Write] Chooses which bone attributes to use for transferring weights to the TargetMesh.

  • radius_percentage (double): [Read-Write] Defines the search radius as the RadiusPercentage * (input mesh bounding box diagonal). All points not within the search radius will be ignored. If negative, all points are considered. Only used in the InpaintWeights algorithm.

  • smoothing_strength (float): [Read-Write] The strength of each post-processing smoothing iteration.

  • source_profile (GeometryScriptBoneWeightProfile): [Read-Write] The identifier for the source bone/skin weight profile used to transfer the weights from.

  • target_profile (GeometryScriptBoneWeightProfile): [Read-Write] The identifier for the source bone/skin weight profile used to transfer the weights to.

  • transfer_method (TransferBoneWeightsMethod): [Read-Write] The type of algorithm to use for transferring the bone weights.

property inpaint_mask: Name

[Read-Write] Optional weight attribute name where a non-zero value indicates that we want the skinning weights for the vertex to be computed automatically instead of it being copied over from the source mesh.

Type:

(Name)

property layered_mesh_support: bool

[Read-Write] If true, when the closest point doesn’t pass the normal threshold test, will try again with a flipped normal. This helps with layered meshes where the “inner” and “outer” layers are close to each other but whose normals are pointing in the opposite directions.

Type:

(bool)

property normal_threshold: float

[Read-Write] Maximum angle (in degrees) difference between the target and the source point normals to be considred a match. If negative, normals are ignored. Only used in the InpaintWeights algorithm.

Type:

(double)

property num_smoothing_iterations: int

[Read-Write] The number of optional post-processing smoothing iterations applied to the vertices without the match.

Type:

(int32)

property output_target_mesh_bones: OutputTargetMeshBones

[Read-Write] Chooses which bone attributes to use for transferring weights to the TargetMesh.

Type:

(OutputTargetMeshBones)

property radius_percentage: float

[Read-Write] Defines the search radius as the RadiusPercentage * (input mesh bounding box diagonal). All points not within the search radius will be ignored. If negative, all points are considered. Only used in the InpaintWeights algorithm.

Type:

(double)

property smoothing_strength: float

[Read-Write] The strength of each post-processing smoothing iteration.

Type:

(float)

property source_profile: GeometryScriptBoneWeightProfile

[Read-Write] The identifier for the source bone/skin weight profile used to transfer the weights from.

Type:

(GeometryScriptBoneWeightProfile)

property target_profile: GeometryScriptBoneWeightProfile

[Read-Write] The identifier for the source bone/skin weight profile used to transfer the weights to.

Type:

(GeometryScriptBoneWeightProfile)

property transfer_method: TransferBoneWeightsMethod

[Read-Write] The type of algorithm to use for transferring the bone weights.

Type:

(TransferBoneWeightsMethod)