IPlotOptions

class IPlotOptions

Bases: ImpactCOMWrapperBase

Description:

Defines the options required to plot. Most of these options represent settings in the Plot dialog.

Remarks:

This object is used in the ITools.plot method.

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

property close_after_plot

Gets close_after_plot.

Description:

Whether to close the original drawing (as opposed to the intermediate drawing) upon completion.

Returns:

The value of close_after_plot.

Return type:

close_after_plot (bool)

property feed_rate_table_name

Gets feed_rate_table_name.

Description:

Which feedrate table is to be used.

Returns:

The value of feed_rate_table_name.

Return type:

feed_rate_table_name (str)

property first_subroutine_number

Gets first_subroutine_number.

Description:

The number to be used for the first programme.

Returns:

The value of first_subroutine_number.

Return type:

first_subroutine_number (int)

property has_plot_dialog_data

Gets has_plot_dialog_data.

Description:

Determines whether the plot dialog will be initialised with values from this IPlotOptions object.

Returns:

The value of has_plot_dialog_data.

Return type:

has_plot_dialog_data (bool)

property horizontal_channel_width

Gets horizontal_channel_width.

Description:

Channel width adjustment for horizontal entities.

Returns:

The value of horizontal_channel_width.

Return type:

horizontal_channel_width (float)

property init_codes_name

Gets init_codes_name.

Description:

The name of the Machine Initialisation settings to be used.

Returns:

The value of init_codes_name.

Return type:

init_codes_name (str)

property material_thickness

Gets material_thickness.

Description:

The thickness of the material being output to.

Returns:

The value of material_thickness.

Return type:

material_thickness (float)

property mirror_x

Gets mirror_x.

Description:

Whether to mirror the output in the X direction.

Returns:

The value of mirror_x.

Return type:

mirror_x (bool)

property mirror_y

Gets mirror_y.

Description:

Whether to mirror the output in the Y direction.

Returns:

The value of mirror_y.

Return type:

mirror_y (bool)

property no_plot_dialog

Gets no_plot_dialog.

Description:

Whether to suppress the Plot dialog being displayed.

Returns:

The value of no_plot_dialog.

Return type:

no_plot_dialog (bool)

property number_of_copies

Gets number_of_copies.

Description:

How many copies are to be output.

Returns:

The value of number_of_copies.

Return type:

number_of_copies (int)

property optimise_crease_tools

Gets optimise_crease_tools.

Description:

Whether to optimise the crease tools.

Returns:

The value of optimise_crease_tools.

Return type:

optimise_crease_tools (bool)

property optimise_output

Gets optimise_output.

Description:

Whether the output is to be optimised.

Returns:

The value of optimise_output.

Return type:

optimise_output (bool)

property output_bridges

Gets output_bridges.

Description:

Whether to output bridges.

Returns:

The value of output_bridges.

Return type:

output_bridges (bool)

property output_from

Gets output_from.

Description:

Which layers are to be plotted.

Returns:

The value of output_from.

Return type:

output_from (ipPlotOutput)

property post_processor

Gets post_processor.

Description:

Which post-processor (and by implication which plot machine) is to be used.

Returns:

The value of post_processor.

Return type:

post_processor (IMasterSetting)

property rotation

Gets Rotation.

Description:

The angle of rotation for the output.

Returns:

The value of Rotation.

Return type:

rotation (float)

property sheet_feeder_distance

Gets sheet_feeder_distance.

Description:

The sheet feed distance (only relevant when use_sheet_feeder is set).

Returns:

The value of sheet_feeder_distance.

Return type:

sheet_feeder_distance (float)

property show_missing_palettes

Gets show_missing_palettes.

Description:

Whether to display a list of palettes which are not going to be output.

Returns:

The value of show_missing_palettes.

Return type:

show_missing_palettes (bool)

property symbols_at_bridge_ends

Gets symbols_at_bridge_ends.

Description:

Whether to place symbols at the ends of bridges.

Returns:

The value of symbols_at_bridge_ends.

Return type:

symbols_at_bridge_ends (int)

property tiled_optimisation

Gets tiled_optimisation.

Description:

Whether the optimisation is to be tiled (only relevant when optimise_output is set).

Returns:

The value of tiled_optimisation.

Return type:

tiled_optimisation (bool)

property use_palette_channel_widths

Gets use_palette_channel_widths.

Description:

Whether to determine the channel widths from the palettes.

Returns:

The value of use_palette_channel_widths.

Return type:

use_palette_channel_widths (bool)

property use_palette_visibility_settings

Gets use_palette_visibility_settings.

Description:

Whether to use the current visibility settings of the palettes.

Returns:

The value of use_palette_visibility_settings.

Return type:

use_palette_visibility_settings (bool)

property use_power_reduction

Gets use_power_reduction.

Description:

Whether the power reductions features are to be used.

Returns:

The value of use_power_reduction.

Return type:

use_power_reduction (bool)

property use_sheet_feeder

Gets use_sheet_feeder.

Description:

Whether to use the sheet feeder feature.

Returns:

The value of use_sheet_feeder.

Return type:

use_sheet_feeder (bool)

property use_side_bevel_settings

Gets use_side_bevel_settings.

Description:

Whether to offset side-beveled entities.

Returns:

The value of use_side_bevel_settings.

Return type:

use_side_bevel_settings (bool)

property vertical_channel_width

Gets vertical_channel_width.

Description:

Channel width adjustment for vertical entities.

Returns:

The value of vertical_channel_width.

Return type:

vertical_channel_width (float)

property zcc_number_of_copies

Gets zcc_number_of_copies.

Description:

Number of copies required for the Zund Cut Centre.

Returns:

The value of zcc_number_of_copies.

Return type:

zcc_number_of_copies (int)

property zccx_minimum_distance

Gets zccx_minimum_distance.

Description:

Minimum distance required in the x-direction between each repetition for the Zund Cut Centre.

Returns:

The value of zccx_minimum_distance.

Return type:

zccx_minimum_distance (float)

property zccx_repetitions

Gets zccx_repetitions.

Description:

Number of repetitions required in the x-direction for the Zund Cut Centre.

Returns:

The value of zccx_repetitions.

Return type:

zccx_repetitions (int)

property zccy_minimum_distance

Gets zccy_minimum_distance.

Description:

Minimum distance required in the y-direction between each repetition for the Zund Cut Centre.

Returns:

The value of zccy_minimum_distance.

Return type:

zccy_minimum_distance (float)

property zccy_repetitions

Gets zccy_repetitions.

Description:

Number of repetitions required in the y-direction for the Zund Cut Centre.

Returns:

The value of zccy_repetitions.

Return type:

zccy_repetitions (int)

Examples