Clash Detection Setting Identifiers#

Overview#

File Name: clash_detect_settings.py

SettingId Enum#

class SettingId#

An enumeration representing each clash detection setting.

SETTING_LOGGING: int = auto()#: Log info & perf results to console.

SETTING_DYNAMIC: int = auto()#: Tells the clash detection engine to run dynamic clash detection inspecting time sampled animations.

SETTING_DYNAMIC_START_TIME: int = auto()#: Start Time on Timeline in seconds. Works only when dynamic clash detection is enabled. 0 = timeline start time (auto-detected).

SETTING_DYNAMIC_END_TIME: int = auto()#: End Time on Timeline in seconds. Works only when dynamic clash detection is enabled. 0 = timeline end time (auto-detected).

SETTING_PURGE_PERMANENT_OVERLAPS: int = auto()#: If two objects overlap for the whole duration of the dynamic clash, such overlap is ignored. Works only when dynamic clash detection is enabled.

SETTING_QUANTIZED: int = auto()#: Quantized or not.

SETTING_SINGLE_THREADED: int = auto()#: Run single-threaded or multi-threaded code. Mainly for testing.

SETTING_NEW_TASK_MANAGER: int = auto()#: Use new task manager implementation. It manages number of spawned tasks automatically, so SETTING_NB_TASKS setting is ignored.

SETTING_FILTER_TEST: int = auto()#: Experimental filtering. Ignore pairs whose meshes have a direct similar sub-component.

SETTING_TIGHT_BOUNDS: int = auto()#: Use tight bounds for meshes.

SETTING_COPLANAR: int = auto()#: Detect collisions between coplanar triangles.

SETTING_NB_TASKS: int = auto()#: Number of tasks used when running multi-threaded. Generally speaking, the more the better.

SETTING_POSE_EPSILON: int = auto()#: Epsilon value used when comparing mesh poses. This is used when detecting ‘duplicate meshes’, i.e. meshes with the same vertex/triangle data in the same place.

SETTING_BOUNDS_EPSILON: int = auto()#: Epsilon value used to enlarge mesh bounds a bit. This ensures that flat bounds or bounds that are just touching are properly processed.

SETTING_AREA_EPSILON: int = auto()#: Epsilon value used to cull small triangles or slivers. Triangles whose area is lower than this value are ignored. Use 0 to keep all triangles.

SETTING_TRIS_PER_LEAF: int = auto()#: Number of triangles per leaf.

SETTING_TOLERANCE: int = auto()#: Tolerance distance for overlap queries. Use zero for hard clashes, non-zero for soft (clearance) clashes.

SETTING_ANY_HIT: int = auto()#: Any hit or all hits.

SETTING_OVERLAP_CODE: int = auto()#: Use alternative triangle-triangle overlap code.

SETTING_DUP_MESHES: int = auto()#: Instructs the clash detection engine to only report meshes that completely overlap with other identical meshes. Dynamic detection is not supported, only static clashes at current time on the timeline are. This option is exclusive - no other clashes are reported when this option is enabled!

SETTING_STATIC_TIME#
:type: int
:value: auto(): Time on Timeline in seconds for executing static clash detection. The value is clamped into timeline range if necessary. Taken into account only when performing static clash detection!