IPalette¶
- class IPalette¶
Bases:
ImpactCOMWrapperBase- Description:
Represents a palette.
- Remarks:
If a palette is from the master template, the properties cannot be edited. If an attempt is made to edit any properties of such a palette, an error will occur.
Wraps a COM object or another wrapper instance. Accepts: - A valid impact_object - An existing impact_com_wrapper_base-derived instance
- property alternative_name¶
Gets alternative_name.
- Description:
The alternative name (also known as “Macro Palette” name).
- Returns:
The value of alternative_name.
- Return type:
alternative_name (str)
- property as400¶
Gets AS400.
- Description:
An optional additional description or reference value.
- Returns:
The value of AS400.
- Return type:
as400 (str)
- property bevel_distance¶
Gets bevel_distance.
- Description:
The distance of any bevelling, if bevel side is not centre.
- Remarks:
Introduced in Impact 7.0.0.57.
- Returns:
The value of bevel_distance.
- Return type:
bevel_distance (float)
- property bevel_side¶
Gets bevel_side.
- Description:
The side of any bevelling, if any.
- Remarks:
Introduced in Impact 7.0.0.57.
- Returns:
The value of bevel_side.
- Return type:
- property bridge_info¶
Gets bridge_info.
- Description:
Gets the bridging information object.
- Returns:
The value of bridge_info.
- Return type:
- Examples:
- property cascade_angle¶
Gets cascade_angle.
- Description:
The angle of each cascade segment, relative to the entity.
- Remarks:
This value is used only if cascade_use_width_instead_of_angle is false.
- Returns:
The value of cascade_angle.
- Return type:
cascade_angle (float)
- property cascade_length¶
Gets cascade_length.
- Description:
The size of each cascade segment, along the segment.
- Returns:
The value of cascade_length.
- Return type:
cascade_length (float)
- property cascade_side¶
Gets cascade_side.
- Description:
The side (left or right) of each cascade segment, relative to the entity.
- Returns:
The value of cascade_side.
- Return type:
- property cascade_side_offset¶
Gets cascade_side_offset.
- Description:
The distance each cascade segment is offset away from the entity.
- Returns:
The value of cascade_side_offset.
- Return type:
cascade_side_offset (float)
- property cascade_step_offset¶
Gets cascade_step_offset.
- Description:
The distance of each cascade segment, along the entity.
- Returns:
The value of cascade_step_offset.
- Return type:
cascade_step_offset (float)
- property cascade_use_width_instead_of_angle¶
Gets cascade_use_width_instead_of_angle.
- Description:
Determines whether the cascade_angle or cascade_width value is to be used.
- Returns:
The value of cascade_use_width_instead_of_angle.
- Return type:
- property cascade_width¶
Gets cascade_width.
- Description:
The size of each cascade segment, along the entity.
- Remarks:
This value is used only if cascade_use_width_instead_of_angle is true.
- Returns:
The value of cascade_width.
- Return type:
cascade_width (float)
- property catalog¶
Gets Catalog.
- Description:
The “Catalog” information.
- Returns:
The value of Catalog.
- Return type:
catalog (str)
- property colour¶
Gets Colour.
- Description:
The main colour of the palette. Use the display_info property to change the palette colour.
- Returns:
The value of Colour.
- Return type:
colour (int)
- property combination_end_mode¶
Gets combination_end_mode.
- Description:
Indicates how the combination is to be positioned on the entity.
- Remarks:
Introduced in Impact 7.0.0.57.
- Returns:
The value of combination_end_mode.
- Return type:
- property combination_explode1¶
Gets combination_explode1.
- Description:
Indicates whether to explode the first palette on output.
- Remarks:
Introduced in Impact 7.0.0.57.
- Returns:
The value of combination_explode1.
- Return type:
combination_explode1 (bool)
- property combination_explode2¶
Gets combination_explode2.
- Description:
Indicates whether to explode the second palette on output.
- Remarks:
Introduced in Impact 7.0.0.57.
- Returns:
The value of combination_explode2.
- Return type:
combination_explode2 (bool)
- property combination_length1¶
Gets combination_length1.
- Description:
Length of the first palette.
- Remarks:
Introduced in Impact 7.0.0.57.
- Returns:
The value of combination_length1.
- Return type:
combination_length1 (float)
- property combination_length2¶
Gets combination_length2.
- Description:
Length of the second palette.
- Remarks:
Introduced in Impact 7.0.0.57.
- Returns:
The value of combination_length2.
- Return type:
combination_length2 (float)
- property combination_minimum_end¶
Gets combination_minimum_end.
- Description:
The minimum end length, as a percentage.
- Remarks:
Introduced in Impact 7.0.0.57.
- Returns:
The value of combination_minimum_end.
- Return type:
combination_minimum_end (float)
- property combination_palette1¶
Gets combination_palette1.
- Description:
The first palette of the combination.
- Remarks:
Introduced in Impact 7.0.0.57.
- Returns:
The value of combination_palette1.
- Return type:
- property combination_palette1_is_main¶
Gets combination_palette1_is_main.
- Description:
Indicates which of the two combined palettes is the main one.
- Remarks:
Introduced in Impact 7.0.0.57.
- Returns:
The value of combination_palette1_is_main.
- Return type:
combination_palette1_is_main (bool)
- property combination_palette2¶
Gets combination_palette2.
- Description:
The second palette of the combination.
- Remarks:
Introduced in Impact 7.0.0.57.
- Returns:
The value of combination_palette2.
- Return type:
- property description¶
Gets Description.
- Description:
The palette description.
- Returns:
The value of Description.
- Return type:
description (str)
- property display_info¶
Gets display_info.
- Description:
Gets the display information object.
- Returns:
The value of display_info.
- Return type:
- Examples:
- property enquire_length¶
Gets enquire_length.
- Description:
Returns the length of entities using this palette.
- Remarks:
This property should be accessed after using an IEnquireLengths object to calculate the lengths of entities within a block. After the IEnquireLengths.perform method has been executed each palette can be examined to determine the length of entities for the palette. The total of these IPalette.enquire_length values is specified as the total IEnquireLengths.length property.
- Returns:
The value of enquire_length.
- Return type:
enquire_length (float)
- Examples:
- property entered_name¶
Gets entered_name.
- Description:
The name which was specified when the palette was created (or renamed). See also full_name.
- Remarks:
This name might contain substitution codes (such as “%h” for the palette height). Use the Rename method to change the palette name.
- Returns:
The value of entered_name.
- Return type:
entered_name (str)
- property from_master_template¶
Gets from_master_template.
- Description:
Indicates if this palette is defined in the master template.
- Returns:
The value of from_master_template.
- Return type:
from_master_template (bool)
- property full_name¶
Gets full_name.
- Description:
The palette name. Use the Rename method to change the name.
- Remarks:
Any substitution codes, such as “%h” for the palette height, specified when creating the palette, will automatically be calculated when reading this property. To see the substitution codes, use entered_name instead. Use the Rename method to change the palette name.
- Returns:
The value of full_name.
- Return type:
full_name (str)
- property make_ready_channel_against_grain¶
Gets make_ready_channel_against_grain.
- Description:
The width of the make-ready channel to cut for an entity which lies against the grain of the output material.
- Returns:
The value of make_ready_channel_against_grain.
- Return type:
make_ready_channel_against_grain (float)
- property make_ready_channel_depth¶
Gets make_ready_channel_depth.
- Description:
The depth of the make-ready channel.
- Remarks:
Introduced in Impact 7.0.0.57.
- Returns:
The value of make_ready_channel_depth.
- Return type:
make_ready_channel_depth (float)
- property make_ready_channel_with_grain¶
Gets make_ready_channel_with_grain.
- Description:
The width of the make-ready channel to cut for an entity which lies along the grain of the output material.
- Returns:
The value of make_ready_channel_with_grain.
- Return type:
make_ready_channel_with_grain (float)
- property palette_type¶
Gets palette_type.
- Description:
Indicates the type of palette.
- Remarks:
This is a read-only property. If you wish to modify the palette type, please use the palette_type2 property instead.
- Returns:
The value of palette_type.
- Return type:
- property palette_type2¶
Gets palette_type2.
- Description:
The type of palette.
- Returns:
The value of palette_type2.
- Return type:
- property rule_height¶
Gets rule_height.
- Description:
Height of the rule.
- Returns:
The value of rule_height.
- Return type:
rule_height (float)
- property rule_type¶
Gets rule_type.
- Description:
The type of rule (normal, combination, zippered, and so on).
- Returns:
The value of rule_type.
- Return type:
- property rule_width¶
Gets rule_width.
- Description:
Width of the rule.
- Returns:
The value of rule_width.
- Return type:
rule_width (float)
- property visible¶
Gets Visible.
- Description:
Indicates the visible state of the palette.
- Remarks:
Note that this property applies to the current window (equivalent to active_drawing.active_window).
- Returns:
The value of Visible.
- Return type:
visible (bool)
- property wave_and_zig_zag_amplitude¶
Gets wave_and_zig_zag_amplitude.
- Description:
The size of the “peaks” for wave and zig-zag rule.
- Remarks:
Introduced in Impact 7.0.0.57.
- Returns:
The value of wave_and_zig_zag_amplitude.
- Return type:
wave_and_zig_zag_amplitude (float)
- property wave_and_zig_zag_pitch¶
Gets wave_and_zig_zag_pitch.
- Description:
The distance between the “peaks” for wave and zig-zag rule.
- Remarks:
Introduced in Impact 7.0.0.57.
- Returns:
The value of wave_and_zig_zag_pitch.
- Return type:
wave_and_zig_zag_pitch (float)
- property wave_and_zig_zag_side¶
Gets wave_and_zig_zag_side.
- Description:
The orientation for wave and zig-zag rule.
- Remarks:
Introduced in Impact 7.0.0.57.
- Returns:
The value of wave_and_zig_zag_side.
- Return type:
- property wave_and_zig_zag_start_offset¶
Gets wave_and_zig_zag_start_offset.
- Description:
The offset distance for wave and zig-zag rule.
- Remarks:
Introduced in Impact 7.0.0.57.
- Returns:
The value of wave_and_zig_zag_start_offset.
- Return type:
wave_and_zig_zag_start_offset (float)
- property wave_gap¶
Gets wave_gap.
- Description:
The gap size (which may be zero) for wave rule.
- Remarks:
Introduced in Impact 7.0.0.57.
- Returns:
The value of wave_gap.
- Return type:
wave_gap (float)
- property zig_zag_radius¶
Gets zig_zag_radius.
- Description:
The radius (which may be zero) applied to zig-zag rule.
- Remarks:
Introduced in Impact 7.0.0.57.
- Returns:
The value of zig_zag_radius.
- Return type:
zig_zag_radius (float)
- property zipper_angle¶
Gets zipper_angle.
- Description:
The angle for zipper rule.
- Remarks:
Introduced in Impact 7.0.0.57.
- Returns:
The value of zipper_angle.
- Return type:
zipper_angle (float)
- property zipper_both_ends¶
Gets zipper_both_ends.
- Description:
Determines whether both ends are angled, for zipper rule.
- Remarks:
Introduced in Impact 7.0.0.57.
- Returns:
The value of zipper_both_ends.
- Return type:
zipper_both_ends (bool)
- property zipper_depth¶
Gets zipper_depth.
- Description:
The size of the zippered parts of the rule, for zipper rule.
- Remarks:
Introduced in Impact 7.0.0.57.
- Returns:
The value of zipper_depth.
- Return type:
zipper_depth (float)
- property zipper_depth_override¶
Gets zipper_depth_override.
- Description:
Indicates whether to override the automatically-calculated depth.
- Remarks:
If true, the zipper_depth value is ignored and the zipper_gap value is used instead. Introduced in Impact 7.0.0.57.
- Returns:
The value of zipper_depth_override.
- Return type:
zipper_depth_override (bool)
- property zipper_gap¶
Gets zipper_gap.
- Description:
The gap size (which may be zero) for zipper rule.
- Remarks:
Introduced in Impact 7.0.0.57.
- Returns:
The value of zipper_gap.
- Return type:
zipper_gap (float)
- property zipper_side¶
Gets zipper_side.
- Description:
Determines which side is zippered, for zipper rule.
- Remarks:
Introduced in Impact 7.0.0.57.
- Returns:
The value of zipper_side.
- Return type:
- property zipper_width¶
Gets zipper_width.
- Description:
The width for zipper rule.
- Remarks:
Introduced in Impact 7.0.0.57.
- Returns:
The value of zipper_width.
- Return type:
zipper_width (float)
- Is(other_palette)¶
- Description:
Determines whether two IPalette objects refer to the same underlying palette.
- Remarks:
Introduced in Impact 10.0.0.77
- Parameters:
other_palette (IPalette) – The palette to be compared with this one.
- rename(name)¶
- Description:
Renames the palette.
- Remarks:
The Name parameter may include substitution codes (such as “%h” for the palette height).
- Parameters:
name (str) – Specifies the new name for the palette.