IHolePathOptions

class IHolePathOptions

Bases: ImpactCOMWrapperBase

Summary:

Defines the settings to be used when hole-finding with the IHoleFinder object.

Remarks:

For a better understanding of these properties, you may wish to look at the Path/Hole Finding master tool settings in Impact. Introduced in Impact 8.0.0.74

Wraps a COM object or another wrapper instance. Accepts: - A valid impact_object - An existing impact_com_wrapper_base-derived instance

property do_interior_holes

Gets do_interior_holes.

Summary:

Specifies whether to process interior holes.

Remarks:

Introduced in Impact 8.0.0.74

Returns:

The value of do_interior_holes.

Return type:

do_interior_holes (bool)

property do_interior_paths

Gets do_interior_paths.

Summary:

Specifies whether to process interior paths.

Remarks:

Introduced in Impact 8.0.0.74

Returns:

The value of do_interior_paths.

Return type:

do_interior_paths (bool)

property do_interiors

Gets do_interiors.

Summary:

Specifies whether to process interior shapes.

Remarks:

Introduced in Impact 8.0.0.74

Returns:

The value of do_interiors.

Return type:

do_interiors (bool)

property do_left_out_offset

Gets do_left_out_offset.

Summary:

Specifies whether to offset to the left/outside of the path or hole.

Remarks:

Introduced in Impact 8.0.0.74

Returns:

The value of do_left_out_offset.

Return type:

do_left_out_offset (bool)

property do_right_in_offset

Gets do_right_in_offset.

Summary:

Specifies whether to offset to the right/inside of the path or hole.

Remarks:

Introduced in Impact 8.0.0.74

Returns:

The value of do_right_in_offset.

Return type:

do_right_in_offset (bool)

property interior_block_name

Gets interior_block_name.

Summary:

The name of the block to be created for interiors.

Remarks:

Introduced in Impact 8.0.0.74

Returns:

The value of interior_block_name.

Return type:

interior_block_name (str)

property interior_into_blocks

Gets interior_into_blocks.

Summary:

Specifies whether to place interior entities into a block.

Remarks:

Introduced in Impact 8.0.0.74

Returns:

The value of interior_into_blocks.

Return type:

interior_into_blocks (bool)

property interior_merge_entities

Gets interior_merge_entities.

Summary:

Specifies whether to merge the entities for interiors.

Remarks:

Introduced in Impact 8.0.0.74

Returns:

The value of interior_merge_entities.

Return type:

interior_merge_entities (bool)

property interior_palette

Gets interior_palette.

Summary:

The name of the palete to be used for interiors.

Remarks:

Introduced in Impact 8.0.0.74

Returns:

The value of interior_palette.

Return type:

interior_palette (str)

property interior_sharp_corners

Gets interior_sharp_corners.

Summary:

Specifies wehther to generate sharp corners (as opposed to rounded) for interiors.

Remarks:

Introduced in Impact 8.0.0.74

Returns:

The value of interior_sharp_corners.

Return type:

interior_sharp_corners (bool)

property interior_use_palette

Gets interior_use_palette.

Summary:

Specifies if the named palette is to be used for interiors.

Remarks:

Introduced in Impact 8.0.0.74

Returns:

The value of interior_use_palette.

Return type:

interior_use_palette (bool)

property leave_interior_original_hole

Gets leave_interior_original_hole.

Summary:

Specifies whether to copy the original geometry for interior holes.

Remarks:

Introduced in Impact 8.0.0.74

Returns:

The value of leave_interior_original_hole.

Return type:

leave_interior_original_hole (bool)

property leave_interior_original_paths

Gets leave_interior_original_paths.

Summary:

Specifies whether to copy the original geometry for interior paths.

Remarks:

Introduced in Impact 8.0.0.74

Returns:

The value of leave_interior_original_paths.

Return type:

leave_interior_original_paths (bool)

property leave_original

Gets leave_original.

Summary:

Specifies whether to copy the original geometry.

Remarks:

Introduced in Impact 8.0.0.74

Returns:

The value of leave_original.

Return type:

leave_original (bool)

property left_out_block_name

Gets left_out_block_name.

Summary:

The name of the block to be created for left/outside.

Remarks:

Introduced in Impact 8.0.0.74

Returns:

The value of left_out_block_name.

Return type:

left_out_block_name (str)

property left_out_initial_offset_dist

Gets left_out_initial_offset_dist.

Summary:

Initial offset distance for left/outside.

Remarks:

Introduced in Impact 8.0.0.74

Returns:

The value of left_out_initial_offset_dist.

Return type:

left_out_initial_offset_dist (float)

property left_out_leave_selected

Gets left_out_leave_selected.

Summary:

Specifies whether to leave entities selected for left/outside.

Remarks:

Introduced in Impact 8.0.0.74

Returns:

The value of left_out_leave_selected.

Return type:

left_out_leave_selected (bool)

property left_out_merge_entities

Gets left_out_merge_entities.

Summary:

Specifies whether to merge the entities for left/outside.

Remarks:

Introduced in Impact 8.0.0.74

Returns:

The value of left_out_merge_entities.

Return type:

left_out_merge_entities (bool)

property left_out_number

Gets left_out_number.

Summary:

The number of offset paths to generate for left/outside.

Remarks:

Introduced in Impact 8.0.0.74

Returns:

The value of left_out_number.

Return type:

left_out_number (int)

property left_out_offset_deadends

Gets left_out_offset_deadends.

Summary:

Specifies whether to offset dead-ends for left/outside.

Remarks:

Introduced in Impact 8.0.0.74

Returns:

The value of left_out_offset_deadends.

Return type:

left_out_offset_deadends (bool)

property left_out_offset_dist

Gets left_out_offset_dist.

Summary:

Standard offset distance for left/outside.

Remarks:

Introduced in Impact 8.0.0.74

Returns:

The value of left_out_offset_dist.

Return type:

left_out_offset_dist (float)

property left_out_palette

Gets left_out_palette.

Summary:

The name of the palete to be used for left/outside.

Remarks:

Introduced in Impact 8.0.0.74

Returns:

The value of left_out_palette.

Return type:

left_out_palette (str)

property left_out_sharp_corners

Gets left_out_sharp_corners.

Summary:

Specifies wehther to generate sharp corners (as opposed to rounded) for left/outside.

Remarks:

Introduced in Impact 8.0.0.74

Returns:

The value of left_out_sharp_corners.

Return type:

left_out_sharp_corners (bool)

property left_out_sub_block

Gets left_out_sub_block.

Summary:

Specifies whether to place the entities into a block for left/outside.

Remarks:

Introduced in Impact 8.0.0.74

Returns:

The value of left_out_sub_block.

Return type:

left_out_sub_block (bool)

property left_out_use_initial_offset

Gets left_out_use_initial_offset.

Summary:

Specicifies whether to use an initial offset distance for left/outside.

Remarks:

Introduced in Impact 8.0.0.74

Returns:

The value of left_out_use_initial_offset.

Return type:

left_out_use_initial_offset (bool)

property left_out_use_palette

Gets left_out_use_palette.

Summary:

Specifies if the named palette is to be used for left/outside.

Remarks:

Introduced in Impact 8.0.0.74

Returns:

The value of left_out_use_palette.

Return type:

left_out_use_palette (bool)

property offset_dist_interior_holes_inside

Gets offset_dist_interior_holes_inside.

Summary:

Distace for inside offset for interior holes.

Remarks:

Introduced in Impact 8.0.0.74

Returns:

The value of offset_dist_interior_holes_inside.

Return type:

offset_dist_interior_holes_inside (float)

property offset_dist_interior_holes_outside

Gets offset_dist_interior_holes_outside.

Summary:

Distace for outside offset for interior holes.

Remarks:

Introduced in Impact 8.0.0.74

Returns:

The value of offset_dist_interior_holes_outside.

Return type:

offset_dist_interior_holes_outside (float)

property offset_interior_holes_inside

Gets offset_interior_holes_inside.

Summary:

Specifies whether to generate inside offset for interior holes.

Remarks:

Introduced in Impact 8.0.0.74

Returns:

The value of offset_interior_holes_inside.

Return type:

offset_interior_holes_inside (bool)

property offset_interior_holes_outside

Gets offset_interior_holes_outside.

Summary:

Specifies whether to generate outside offset for interior holes.

Remarks:

Introduced in Impact 8.0.0.74

Returns:

The value of offset_interior_holes_outside.

Return type:

offset_interior_holes_outside (bool)

property original_block_name

Gets original_block_name.

Summary:

The name of the block to be created for the copied original entities.

Remarks:

Introduced in Impact 8.0.0.74

Returns:

The value of original_block_name.

Return type:

original_block_name (str)

property original_leave_selected

Gets original_leave_selected.

Summary:

Specifies whether to leave copied original entities selected.

Remarks:

Introduced in Impact 8.0.0.74

Returns:

The value of original_leave_selected.

Return type:

original_leave_selected (bool)

property original_merge_entities

Gets original_merge_entities.

Summary:

Specifies whether to merge the copied original entities.

Remarks:

Introduced in Impact 8.0.0.74

Returns:

The value of original_merge_entities.

Return type:

original_merge_entities (bool)

property original_palette

Gets original_palette.

Summary:

The name of the palete to be used for copied original entities.

Remarks:

Introduced in Impact 8.0.0.74

Returns:

The value of original_palette.

Return type:

original_palette (str)

property original_sub_block

Gets original_sub_block.

Summary:

Specifies whether to place copied original entities into a block.

Remarks:

Introduced in Impact 8.0.0.74

Returns:

The value of original_sub_block.

Return type:

original_sub_block (bool)

property original_use_palette

Gets original_use_palette.

Summary:

Specifies if the named palette is to be used for copied original entities.

Remarks:

Introduced in Impact 8.0.0.74

Returns:

The value of original_use_palette.

Return type:

original_use_palette (bool)

property pocket_dist_interior_paths

Gets pocket_dist_interior_paths.

Summary:

Distace for pocket offset for interior paths.

Remarks:

Introduced in Impact 8.0.0.74

Returns:

The value of pocket_dist_interior_paths.

Return type:

pocket_dist_interior_paths (float)

property pocket_interior_paths

Gets pocket_interior_paths.

Summary:

Specifies whether to generate pocket for interior paths.

Remarks:

Introduced in Impact 8.0.0.74

Returns:

The value of pocket_interior_paths.

Return type:

pocket_interior_paths (bool)

property right_in_auto_fill

Gets right_in_auto_fill.

Summary:

Specifies whether to auto-fill for right/inside.

Remarks:

Introduced in Impact 8.0.0.74

Returns:

The value of right_in_auto_fill.

Return type:

right_in_auto_fill (bool)

property right_in_block_name

Gets right_in_block_name.

Summary:

The name of the block to be created for right/inside.

Remarks:

Introduced in Impact 8.0.0.74

Returns:

The value of right_in_block_name.

Return type:

right_in_block_name (str)

property right_in_initial_offset_dist

Gets right_in_initial_offset_dist.

Summary:

Initial offset distance for right/inside.

Remarks:

Introduced in Impact 8.0.0.74

Returns:

The value of right_in_initial_offset_dist.

Return type:

right_in_initial_offset_dist (float)

property right_in_leave_selected

Gets right_in_leave_selected.

Summary:

Specifies whether to leave entities selected for right/inside.

Remarks:

Introduced in Impact 8.0.0.74

Returns:

The value of right_in_leave_selected.

Return type:

right_in_leave_selected (bool)

property right_in_merge_entities

Gets right_in_merge_entities.

Summary:

Specifies whether to merge the entities for right/inside.

Remarks:

Introduced in Impact 8.0.0.74

Returns:

The value of right_in_merge_entities.

Return type:

right_in_merge_entities (bool)

property right_in_number

Gets right_in_number.

Summary:

The number of offset paths to generate for right/inside.

Remarks:

Introduced in Impact 8.0.0.74

Returns:

The value of right_in_number.

Return type:

right_in_number (int)

property right_in_offset_deadends

Gets right_in_offset_deadends.

Summary:

Specifies whether to offset dead-ends for right/inside.

Remarks:

Introduced in Impact 8.0.0.74

Returns:

The value of right_in_offset_deadends.

Return type:

right_in_offset_deadends (bool)

property right_in_offset_dist

Gets right_in_offset_dist.

Summary:

Standard offset distance for right/inside.

Remarks:

Introduced in Impact 8.0.0.74

Returns:

The value of right_in_offset_dist.

Return type:

right_in_offset_dist (float)

property right_in_palette

Gets right_in_palette.

Summary:

The name of the palete to be used for right/inside.

Remarks:

Introduced in Impact 8.0.0.74

Returns:

The value of right_in_palette.

Return type:

right_in_palette (str)

property right_in_sharp_corners

Gets right_in_sharp_corners.

Summary:

Specifies wehther to generate sharp corners (as opposed to rounded) for right/inside.

Remarks:

Introduced in Impact 8.0.0.74

Returns:

The value of right_in_sharp_corners.

Return type:

right_in_sharp_corners (bool)

property right_in_sub_block

Gets right_in_sub_block.

Summary:

Specifies whether to place the entities into a block for right/inside.

Remarks:

Introduced in Impact 8.0.0.74

Returns:

The value of right_in_sub_block.

Return type:

right_in_sub_block (bool)

property right_in_use_initial_offset

Gets right_in_use_initial_offset.

Summary:

Specicifies whether to use an initial offset distance for right/inside.

Remarks:

Introduced in Impact 8.0.0.74

Returns:

The value of right_in_use_initial_offset.

Return type:

right_in_use_initial_offset (bool)

property right_in_use_palette

Gets right_in_use_palette.

Summary:

Specifies if the named palette is to be used for right/inside.

Remarks:

Introduced in Impact 8.0.0.74

Returns:

The value of right_in_use_palette.

Return type:

right_in_use_palette (bool)

apply_master_setting(value)
Summary:

Sets the IHolePathOptions properties from the values in a Path/Hole Finding master tool setting.

Remarks:

Introduced in Impact 8.0.0.74

Parameters:

value (IMasterSetting) – The master tool settings object.

isNone()

Checks if the COM object is None. This is useful for determining if the wrapper has been initialized with a valid COM object.

Examples