unreal.ComputeNegativeSpaceOptions

class unreal.ComputeNegativeSpaceOptions(sample_method: NegativeSpaceSampleMethod = Ellipsis, require_search_sample_coverage: bool = False, only_connected_to_hull: bool = False, max_voxels_per_dim: int = 0, target_num_samples: int = 0, min_sample_spacing: float = 0.0, negative_space_tolerance: float = 0.0, min_radius: float = 0.0)

Bases: StructBase

Options controlling how to sample the negative space of shapes, e.g. to define a region that must be avoided when merging collision shapes

C++ Source:

• Plugin: GeometryScripting

• Module: GeometryScriptingCore

• File: CollisionFunctions.h

Editor Properties: (see get_editor_property/set_editor_property)

• max_voxels_per_dim (int32): [Read-Write] When performing Voxel Search, maximum number of voxels to use along each dimension

• min_radius (double): [Read-Write] Spheres smaller than this are not included in the negative space

• min_sample_spacing (double): [Read-Write] Minimum desired spacing between sphere centers; if > 0, will attempt not to place sphere centers closer than this

• negative_space_tolerance (double): [Read-Write] Amount of space to leave between convex hulls and protected negative space

• only_connected_to_hull (bool): [Read-Write] When performing Voxel Search, only look for negative space that is connected out to the convex hull. This removes inaccessable internal negative space from consideration. Only applies to Voxel Search.

• require_search_sample_coverage (bool): [Read-Write] Whether to require that all candidate locations identified by Voxel Search are covered by negative space samples, up to the specified Min Sample Spacing. Only applies to Voxel Search.

• sample_method (NegativeSpaceSampleMethod): [Read-Write] Method to use to find and sample negative space

• target_num_samples (int32): [Read-Write] Approximate number of spheres to consider when covering negative space

property max_voxels_per_dim: int

[Read-Write] When performing Voxel Search, maximum number of voxels to use along each dimension

Type:

(int32)

property min_radius: float

[Read-Write] Spheres smaller than this are not included in the negative space

Type:

(double)

property min_sample_spacing: float

[Read-Write] Minimum desired spacing between sphere centers; if > 0, will attempt not to place sphere centers closer than this

Type:

(double)

property negative_space_tolerance: float

[Read-Write] Amount of space to leave between convex hulls and protected negative space

Type:

(double)

property only_connected_to_hull: bool

[Read-Write] When performing Voxel Search, only look for negative space that is connected out to the convex hull. This removes inaccessable internal negative space from consideration. Only applies to Voxel Search.

Type:

(bool)

property require_search_sample_coverage: bool

[Read-Write] Whether to require that all candidate locations identified by Voxel Search are covered by negative space samples, up to the specified Min Sample Spacing. Only applies to Voxel Search.

Type:

(bool)

property sample_method: NegativeSpaceSampleMethod

[Read-Write] Method to use to find and sample negative space

Type:

(NegativeSpaceSampleMethod)

property target_num_samples: int

[Read-Write] Approximate number of spheres to consider when covering negative space

Type:

(int32)