unreal.IKRetargetBodyIntersectIKOpSettings

class unreal.IKRetargetBodyIntersectIKOpSettings(enabled: bool = False, lod_threshold: int = 0, target_physics_asset_override: PhysicsAsset = Ellipsis, enable_goal_intersect: bool = False, intersect_goal_settings: None = [], prop_intersect_settings: None = [], intersect_bodies: None = [], enable_pole_vector_intersect: bool = False, pole_vector_intersect_settings: None = [])

Bases: IKRetargetOpSettingsBase

Body Intersect IK Settings

C++ Source:

  • Plugin: RelativeIKOp

  • Module: BodyIntersectIKOp

  • File: BodyIntersectIKOp.h

Editor Properties: (see get_editor_property/set_editor_property)

  • enable_goal_intersect (bool): [Read-Write] Apply intersection delta to goals

  • enable_pole_vector_intersect (bool): [Read-Write] Check bodies in Pole Vector Intersect Settings for intersection and try to fixup using pole vector rotation

  • enabled (bool): [Read-Write] Enable/disable the entire operation. Disabled ops are skipped entirely and do not run at all.

  • intersect_bodies (Array[Name]): [Read-Write] Bone names with attached physics bodies to do trivial intersection against NOTE: Only Sphere, Capsule and Box bodies currently supported

  • intersect_goal_settings (Array[IKGoalIntersectShapeSettings]): [Read-Write] IK Goals Shape intersect against physics asset bodies

  • lod_threshold (int32): [Read-Write] The maximum LOD that this Op is allowed to run at. For example if you have LODThreshold of 2, the Op will run until LOD 2 (based on 0 index). When the component LOD becomes 3, it will stop running. A value of -1 forces the Op to execute at all LOD levels. Default is -1.

  • pole_vector_intersect_settings (Array[IKPoleVectorIntersectSettings]): [Read-Write] Body settings for pole vector intersection fixup

  • prop_intersect_settings (Array[IKPropIntersectSettings]): [Read-Write] Prop intersection shape and bone info (must match goal intersect names if moving together)

  • target_physics_asset_override (PhysicsAsset): [Read-Write] Target physics asset for checking intersections against

property enable_goal_intersect: bool

[Read-Write] Apply intersection delta to goals

Type:

(bool)

property enable_pole_vector_intersect: bool

[Read-Write] Check bodies in Pole Vector Intersect Settings for intersection and try to fixup using pole vector rotation

Type:

(bool)

property intersect_bodies: None

[Read-Write] Bone names with attached physics bodies to do trivial intersection against NOTE: Only Sphere, Capsule and Box bodies currently supported

Type:

(Array[Name])

property intersect_goal_settings: None

[Read-Write] IK Goals Shape intersect against physics asset bodies

Type:

(Array[IKGoalIntersectShapeSettings])

property pole_vector_intersect_settings: None

[Read-Write] Body settings for pole vector intersection fixup

Type:

(Array[IKPoleVectorIntersectSettings])

property prop_intersect_settings: None

[Read-Write] Prop intersection shape and bone info (must match goal intersect names if moving together)

Type:

(Array[IKPropIntersectSettings])

property target_physics_asset_override: PhysicsAsset

[Read-Write] Target physics asset for checking intersections against

Type:

(PhysicsAsset)