ILayoutOptions

class ILayoutOptions

Bases: ImpactCOMWrapperBase

Description:

Specifies the options required to generate a layout.

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

property area_x

Gets area_x.

Description:

The area to fill in the X (height) direction.

Remarks:

This option is only used when the fill_method property is lfmFillArea. area_x must always be greater than zero.

Returns:

The value of area_x.

Return type:

area_x (float)

property area_y

Gets area_y.

Description:

The area to fill in the Y (width) direction.

Remarks:

This option is only used when the fill_method property is lfmFillArea. area_y must always be greater than zero.

Returns:

The value of area_y.

Return type:

area_y (float)

property columns

Gets Columns.

Description:

The number of columns.

Remarks:

This option is only used when the fill_method property is lfmRowsAndColumns. Columns must always be greater than zero. When using this property, you should also set the Rows and number_up properties.

Returns:

The value of Columns.

Return type:

columns (int)

property corrugated_thickness_max

Gets corrugated_thickness_max.

Description:

The corrugated sheet maximum thickness.

Remarks:

This value will be overridden if the sheet_mts property is set. See sheet_mts for more information. Introduced in Impact 8.0.0.95

Returns:

The value of corrugated_thickness_max.

Return type:

corrugated_thickness_max (float)

property corrugated_thickness_min

Gets corrugated_thickness_min.

Description:

The corrugated sheet minimum thickness.

Remarks:

This value will be overridden if the sheet_mts property is set. See sheet_mts for more information. Introduced in Impact 8.0.0.95

Returns:

The value of corrugated_thickness_min.

Return type:

corrugated_thickness_min (float)

property create_layout

Gets create_layout.

Description:

Defines if a layout is actually created. By default, it is True.

Remarks:

By setting this proprty it to False, you can still generate all the stats for a particular layout (the number up, the sheet utilisation, the rows, the columns) without the final step of actually generating the layout in the drawing. Introduced in Impact 8.0.0.55

Returns:

The value of create_layout.

Return type:

create_layout (bool)

property create_layout_if_invalid

Gets create_layout_if_invalid.

Description:

Determines if a layout is still created even if the placement or nesting is invalid.

Returns:

The value of create_layout_if_invalid.

Return type:

create_layout_if_invalid (bool)

property custom_sheet_name

Gets custom_sheet_name.

Description:

The name of the custom sheet.

Remarks:

Introduced in Impact 8.0.0.74

Returns:

The value of custom_sheet_name.

Return type:

custom_sheet_name (str)

property fill_method

Gets fill_method.

Description:

The fill method to use.

Returns:

The value of fill_method.

Return type:

fill_method (ipLayoutFillMethod)

property folding_carton_thickness_max

Gets folding_carton_thickness_max.

Description:

The folding carton sheet minimum thickness.

Remarks:

This value will be overridden if the sheet_mts property is set. See sheet_mts for more information. Introduced in Impact 8.0.0.95

Returns:

The value of folding_carton_thickness_max.

Return type:

folding_carton_thickness_max (float)

property folding_carton_thickness_min

Gets folding_carton_thickness_min.

Description:

The folding carton sheet minimum thickness.

Remarks:

This value will be overridden if the sheet_mts property is set. See sheet_mts for more information. Introduced in Impact 8.0.0.95

Returns:

The value of folding_carton_thickness_min.

Return type:

folding_carton_thickness_min (float)

property horizontal_gutter

Gets horizontal_gutter.

Description:

The against flute/grain direction gutter distance to be used when the spacing_type is lstNormal or lstFullPerimeter.

Remarks:

The spacing_type is automatically set to lstNormal when this property is set. This value will be overridden if the pattern_mts property is set. Introduced in Impact 11.0.0.39

Returns:

The value of horizontal_gutter.

Return type:

horizontal_gutter (float)

property is_corrugated

Gets is_corrugated.

Description:

Determines if the machine is suitable for corrugated.

Remarks:

This value will be overridden if the sheet_mts property is set. See sheet_mts for more information. Introduced in Impact 8.0.0.95

Returns:

The value of is_corrugated.

Return type:

is_corrugated (bool)

property is_custom_pattern

Gets is_custom_pattern.

Description:

Determines if a custom pattern is used.

Remarks:

Introduced in Impact 11.0.0.39

Returns:

The value of is_custom_pattern.

Return type:

is_custom_pattern (bool)

property is_custom_sheet

Gets is_custom_sheet.

Description:

Determines if a custom sheet is used.

Remarks:

Introduced in Impact 8.0.0.74

Returns:

The value of is_custom_sheet.

Return type:

is_custom_sheet (bool)

property is_flatbed

Gets is_flatbed.

Description:

Determines if the machine is flatbed.

Remarks:

This value will be overridden if the sheet_mts property is set. See sheet_mts for more information. Introduced in Impact 8.0.0.31

Returns:

The value of is_flatbed.

Return type:

is_flatbed (bool)

property is_folding_carton

Gets is_folding_carton.

Description:

Determines if the machine is suitable for folding carton.

Remarks:

This value will be overridden if the sheet_mts property is set. See sheet_mts for more information. Introduced in Impact 8.0.0.95

Returns:

The value of is_folding_carton.

Return type:

is_folding_carton (bool)

property is_rotary

Gets is_rotary.

Description:

Determines if the machine is rotary.

Remarks:

This value will be overridden if the sheet_mts property is set. See sheet_mts for more information. Introduced in Impact 8.0.0.31

Returns:

The value of is_rotary.

Return type:

is_rotary (bool)

property labelling_mts

Gets labelling_mts.

Description:

The labelling settings to use.

Remarks:

introduced in Impact 11.1.0.5 and 12.0.0.66

Returns:

The value of labelling_mts.

Return type:

labelling_mts (IMasterSetting)

property number_up

Gets number_up.

Description:

The number of designs on the layout. The default is 1.

Remarks:

This option is only used when the fill_method property is lfmNumberUp or lfmRowsAndColumns. number_up must always be greater than or equal to zero. The default value is one.

Returns:

The value of number_up.

Return type:

number_up (int)

property one_up

Gets one_up.

Description:

The one-up layer from which to create a layout.

Remarks:

This must always refer to an existing one up layer in the active drawing. When using ILayoutOptions with the ILayer.layout method this property does not need to be specified.

Returns:

The value of one_up.

Return type:

one_up (ILayer)

property palette_mts

Gets palette_mts.

Description:

The palette settings to use.

Remarks:

This must always refer to an existing MTS.

Returns:

The value of palette_mts.

Return type:

palette_mts (IMasterSetting)

property palette_settings

Gets palette_settings.

Description:

The name of the palette settings to use.

Remarks:

Deprecated, use palette_mts instead. This must always refer to an existing MTS.

Returns:

The value of palette_settings.

Return type:

palette_settings (str)

property pattern_mts

Gets pattern_mts.

Description:

The pattern settings to use.

Remarks:

This must always refer to an existing MTS.

Returns:

The value of pattern_mts.

Return type:

pattern_mts (IMasterSetting)

property pattern_settings

Gets pattern_settings.

Description:

The name of the pattern settings to use.

Remarks:

Deprecated, use pattern_mts instead. This must always refer to an existing MTS.

Returns:

The value of pattern_settings.

Return type:

pattern_settings (str)

property perpendicular_gutter

Gets perpendicular_gutter.

Description:

The continous perpendicular gutter distance to be used when the spacing_type is lstPerpendicular.

Remarks:

The spacing_type is automatically set to lstPerpendicular when this property is set. This value will be overridden if the pattern_mts property is set. Introduced in Impact 11.0.0.39

Returns:

The value of perpendicular_gutter.

Return type:

perpendicular_gutter (float)

property rows

Gets Rows.

Description:

The number of rows.

Remarks:

This option is only used when the fill_method property is lfmRowsAndColumns. Rows must always be greater than zero. When using this property, you should also set the Columns and number_up properties.

Returns:

The value of Rows.

Return type:

rows (int)

property sheet_flute_direction

Gets sheet_flute_direction.

Description:

The flute/grain direction of the sheet.

Remarks:

This value will be overridden if the stock_sheet_mts or sheet_mts properties are set. See stock_sheet_mts or sheet_mts for more information. Introduced in Impact 8.0.0.74

Returns:

The value of sheet_flute_direction.

Return type:

sheet_flute_direction (ipFluteDirection)

property sheet_mts

Gets sheet_mts.

Description:

The sheet settings to use.

Remarks:

When the sheet_mts property is set, the sheet_x, sheet_y, sheet_flute_direction, Speed, is_flatbed, is_rotary, is_corrugated, corrugated_thickness_min, corrugated_thickness_max, is_folding_carton, folding_carton_thickness_min, and folding_carton_thickness_max properties are overridden by the master tool settings values; you may then read or modify these values.

Returns:

The value of sheet_mts.

Return type:

sheet_mts (IMasterSetting)

property sheet_settings

Gets sheet_settings.

Description:

The name of the sheet settings to use.

Remarks:

Deprecated, use sheet_mts instead. This must always refer to an existing MTS.

Returns:

The value of sheet_settings.

Return type:

sheet_settings (str)

property sheet_x

Gets sheet_x.

Description:

The sheet width.

Remarks:

This value will be overridden if the stock_sheet_mts or sheet_mts properties are set. See stock_sheet_mts or sheet_mts for more information. Introduced in Impact 8.0.0.74

Returns:

The value of sheet_x.

Return type:

sheet_x (float)

property sheet_x_minimum

Gets sheet_x_minimum.

Description:

The minimum sheet width.

Remarks:

introduced in Impact 11.1.0.13 and 12.0.0.81

Returns:

The value of sheet_x_minimum.

Return type:

sheet_x_minimum (int)

property sheet_y

Gets sheet_y.

Description:

The sheet height.

Remarks:

This value will be overridden if the stock_sheet_mts or sheet_mts properties are set. See stock_sheet_mts or sheet_mts for more information. Introduced in Impact 8.0.0.74

Returns:

The value of sheet_y.

Return type:

sheet_y (float)

property sheet_y_minimum

Gets sheet_y_minimum.

Description:

The minimum sheet height.

Remarks:

introduced in Impact 11.1.0.13 and 12.0.0.81

Returns:

The value of sheet_y_minimum.

Return type:

sheet_y_minimum (int)

property spacing_type

Gets spacing_type.

Description:

Specifies the pattern’s design component gutter spacing type to be used when creating layouts.

Remarks:

This value will be overridden if the pattern_mts property is set. Introduced in Impact 11.0.0.39

Returns:

The value of spacing_type.

Return type:

spacing_type (ipLayoutSpacingType)

property speed

Gets Speed.

Description:

The machine speed, in sheets per hour.

Remarks:

This value will be overridden if the sheet_mts property is set. See sheet_mts for more information. Introduced in Impact 8.0.0.31

Returns:

The value of Speed.

Return type:

speed (float)

property stock_sheet_mts

Gets stock_sheet_mts.

Description:

The stock sheet settings to use.

Remarks:

When the stock_sheet_mts property is set, the sheet_x, sheet_y and sheet_flute_direction properties are overridden by the master tool settings values; you may then read or modify these values. Introduced in Impact 8.0.0.74

Returns:

The value of stock_sheet_mts.

Return type:

stock_sheet_mts (IMasterSetting)

property thousands

Gets Thousands.

Description:

The quantity to use, in thousands.

Remarks:

This value must be greater than zero.

Returns:

The value of Thousands.

Return type:

thousands (int)

property vertical_gutter

Gets vertical_gutter.

Description:

The with flute/grain direction gutter distance to be used when the spacing_type is lstNormal or lstFullPerimeter.

Remarks:

The spacing_type is automatically set to lstNormal when this property is set. This value will be overridden if the pattern_mts property is set. Introduced in Impact 11.0.0.39

Returns:

The value of vertical_gutter.

Return type:

vertical_gutter (float)