IHatchOptions

class IHatchOptions

Bases: ImpactCOMWrapperBase

Summary:

Defines the settings to be used when hatching with the IHatcher object.

Remarks:

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 angle1

Gets Angle1.

Summary:

The line angle, if single-line or double-line hatching is to be used.

Remarks:

Introduced in Impact 8.0.0.74

Returns:

The value of Angle1.

Return type:

angle1 (float)

property angle2

Gets Angle2.

Summary:

The line angle, if double-line hatching is to be used.

Remarks:

Introduced in Impact 8.0.0.74

Returns:

The value of Angle2.

Return type:

angle2 (float)

property hatch_mode

Gets hatch_mode.

Summary:

The type of hatching to be performed (simple lines or pattern).

Remarks:

Introduced in Impact 8.0.0.74

Returns:

The value of hatch_mode.

Return type:

hatch_mode (ipHatchMode)

property hatch_name

Gets hatch_name.

Summary:

The pattern name, if patterned hatching is to be used.

Remarks:

These names are fixed in Impact - such as “cross”, “dot”, zigzag”. See the master tool settings in Impact for a full list. Introduced in Impact 8.0.0.74

Returns:

The value of hatch_name.

Return type:

hatch_name (str)

property hatch_scale

Gets hatch_scale.

Summary:

The pattern scale, if patterned hatching is to be used.

Remarks:

Introduced in Impact 8.0.0.74

Returns:

The value of hatch_scale.

Return type:

hatch_scale (float)

property offset1

Gets Offset1.

Summary:

The distance between lines, if single-line or double-line hatching is to be used.

Remarks:

Introduced in Impact 8.0.0.74

Returns:

The value of Offset1.

Return type:

offset1 (float)

property offset2

Gets Offset2.

Summary:

The distance between lines, if double-line hatching is to be used.

Remarks:

Introduced in Impact 8.0.0.74

Returns:

The value of Offset2.

Return type:

offset2 (float)

property origin

Gets Origin.

Summary:

A vector property may be used to displace the hatch pattern from its normal position.

Remarks:

It is not usually necessary to set this value. Introduced in Impact 8.0.0.74

Returns:

The value of Origin.

Return type:

origin (IVector)

property palette_name

Gets palette_name.

Summary:

The name of the palette to be used for the hatch geometry.

Remarks:

When using palette_name, you should also set the use_palette property. If no palette of this name exists in the drawing, the current palette is used instead. Introduced in Impact 8.0.0.74

Returns:

The value of palette_name.

Return type:

palette_name (str)

property use_palette

Gets use_palette.

Summary:

Specifies if the named palette is to be used.

Remarks:

If True, then palette_name is used for the new geometry. If False, the current palette is used. Introduced in Impact 8.0.0.74

Returns:

The value of use_palette.

Return type:

use_palette (bool)

apply_master_setting(value)
Summary:

Sets the IHatchOptions properties from the values in a Hatch Settings 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