IDimensionOptions

class IDimensionOptions

Bases: ImpactCOMWrapperBase

Summary:

Defines the settings to be used when creating dimension entities.

Remarks:

Introduced in Impact 10.0.0.70.

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

property add_lines

Gets add_lines.

Summary:

Specifies whether dimension lines and terminators are to be draw for the dimension entity.

Returns:

The value of add_lines.

Return type:

add_lines (bool)

property auto_size

Gets auto_size.

Summary:

Specifies whether any items should be auto-sized for the dimension entity.

Remarks:

See also auto_size_maintain_dimension_gap, auto_size_maintain_leader, auto_size_maintain_parallel_offset, auto_size_maintain_projection_ascent, auto_size_maintain_terminator. The scale factor is determined by the auto_size_scaling property. These values are ignored if auto_size is False.

Returns:

The value of auto_size.

Return type:

auto_size (bool)

property auto_size_maintain_dimension_gap

Gets auto_size_maintain_dimension_gap.

Summary:

Specifies whether the dimension gap value is to be auto-sized.

Remarks:

The scale factor is determined by the auto_size_scaling property. Note that this value is ignored if auto_size is False.

Returns:

The value of auto_size_maintain_dimension_gap.

Return type:

auto_size_maintain_dimension_gap (bool)

property auto_size_maintain_leader

Gets auto_size_maintain_leader.

Summary:

Specifies whether the leader value is to be auto-sized.

Remarks:

The scale factor is determined by the auto_size_scaling property. Note that this value is ignored if auto_size is False.

Returns:

The value of auto_size_maintain_leader.

Return type:

auto_size_maintain_leader (bool)

property auto_size_maintain_parallel_offset

Gets auto_size_maintain_parallel_offset.

Summary:

Specifies whether the parallel offset value is to be auto-sized.

Remarks:

The scale factor is determined by the auto_size_scaling property. Note that this value is ignored if auto_size is False.

Returns:

The value of auto_size_maintain_parallel_offset.

Return type:

auto_size_maintain_parallel_offset (bool)

property auto_size_maintain_projection_ascent

Gets auto_size_maintain_projection_ascent.

Summary:

Specifies whether the projection ascent value is to be auto-sized.

Remarks:

The scale factor is determined by the auto_size_scaling property. Note that this value is ignored if auto_size is False.

Returns:

The value of auto_size_maintain_projection_ascent.

Return type:

auto_size_maintain_projection_ascent (bool)

property auto_size_maintain_terminator

Gets auto_size_maintain_terminator.

Summary:

Specifies whether the terminator size value is to be auto-sized.

Remarks:

The scale factor is determined by the auto_size_scaling property. Note that this value is ignored if auto_size is False.

Returns:

The value of auto_size_maintain_terminator.

Return type:

auto_size_maintain_terminator (bool)

property auto_size_scaling

Gets auto_size_scaling.

Summary:

Specifies the scale factor to be applied to all auto-sized items.

Remarks:

Note that this value is ignored if auto_size is False.

Returns:

The value of auto_size_scaling.

Return type:

auto_size_scaling (float)

property diameter_prefix

Gets diameter_prefix.

Summary:

Specifies the prefix (if any) to be used with diameter dimensions.

Returns:

The value of diameter_prefix.

Return type:

diameter_prefix (str)

property dim_text_parallel

Gets dim_text_parallel.

Summary:

Specifies whether the orientation of the dimension label is parallel or horizontal.

Returns:

The value of dim_text_parallel.

Return type:

dim_text_parallel (bool)

property dimension_gap

Gets dimension_gap.

Summary:

Specifies the dimension gap value for dimension projection lines.

Returns:

The value of dimension_gap.

Return type:

dimension_gap (float)

property display_tolerances

Gets display_tolerances.

Summary:

Specifies whether tolerances are to be shown for dimension values.

Returns:

The value of display_tolerances.

Return type:

display_tolerances (bool)

property display_tolerances_plus_minus

Gets display_tolerances_plus_minus.

Summary:

Specifies which kind of tolerances are to be shown for dimension values.

Remarks:

Note that this value is ignored if display_tolerances is False. See also tolerance_lower_limit and tolerance_upper_limit.

Returns:

The value of display_tolerances_plus_minus.

Return type:

display_tolerances_plus_minus (bool)

property force_palette_colour

Gets force_palette_colour.

Summary:

Specifies whether the colour of the text label is determined by the palette colour.

Returns:

The value of force_palette_colour.

Return type:

force_palette_colour (bool)

property format_specifier

Gets format_specifier.

Summary:

Specifies the text which is to be displayed on the dimension label.

Remarks:

The “%” character represents the dimension value, while “%1” and “%2” can be used to access the value using the primary and secondary formats.

Returns:

The value of format_specifier.

Return type:

format_specifier (str)

property leader_length

Gets leader_length.

Summary:

Specifies the leader length of the dimension line.

Returns:

The value of leader_length.

Return type:

leader_length (float)

property parallel_offset

Gets parallel_offset.

Summary:

Specifies the parallel offset value for dimension projection lines.

Returns:

The value of parallel_offset.

Return type:

parallel_offset (float)

property primary_angle_format

Gets primary_angle_format.

Summary:

An object which holds the properties for the primary formatting of an angle value.

Remarks:

If used, the object should be created by create_dimension_angle_format.

Returns:

The value of primary_angle_format.

Return type:

primary_angle_format (IDimensionAngleFormat)

property primary_distance_format

Gets primary_distance_format.

Summary:

An object which holds the properties for the primary formatting of a distance value.

Remarks:

If used, the object should be created by create_dimension_distance_format.

Returns:

The value of primary_distance_format.

Return type:

primary_distance_format (IDimensionDistanceFormat)

property projection_ascent

Gets projection_ascent.

Summary:

Specifies the projection ascent value for dimension projection lines.

Returns:

The value of projection_ascent.

Return type:

projection_ascent (float)

property radius_prefix

Gets radius_prefix.

Summary:

Specifies the prefix (if any) to be used with radius dimensions.

Returns:

The value of radius_prefix.

Return type:

radius_prefix (str)

property secondary_angle_format

Gets secondary_angle_format.

Summary:

An object which holds the properties for the secondary formatting of an angle value.

Remarks:

If used, the object should be created by create_dimension_angle_format.

Returns:

The value of secondary_angle_format.

Return type:

secondary_angle_format (IDimensionAngleFormat)

property secondary_distance_format

Gets secondary_distance_format.

Summary:

An object which holds the properties for the secondary formatting of a distance value.

Remarks:

If used, the object should be created by create_dimension_distance_format.

Returns:

The value of secondary_distance_format.

Return type:

secondary_distance_format (IDimensionDistanceFormat)

property show_radial_lines

Gets show_radial_lines.

Summary:

Specifies whether radial lines should be shown for the dimension line.

Returns:

The value of show_radial_lines.

Return type:

show_radial_lines (bool)

property terminator_size

Gets terminator_size.

Summary:

Specifies the size of the terminator (arrow heads) of a dimension entity.

Returns:

The value of terminator_size.

Return type:

terminator_size (float)

property terminator_style

Gets terminator_style.

Summary:

Specified the style of the terminator (arrow heads) of a dimension entity.

Returns:

The value of terminator_style.

Return type:

terminator_style (ipTerminatorStyle)

property text_position

Gets text_position.

Summary:

Specifies the position of the label with respect to the dimension line.

Returns:

The value of text_position.

Return type:

text_position (ipDimensionTextPosition)

property text_style

Gets text_style.

Summary:

Specifies the text style to be applied to the label.

Remarks:

See IDrawing.text_style_sheets for information on retrieving and adding text styles.

Returns:

The value of text_style.

Return type:

text_style (ITextStyle)

property tolerance_lower_limit

Gets tolerance_lower_limit.

Summary:

Tolerance for the dimension lower value.

Remarks:

Note that this value is ignored if display_tolerances is False.

Returns:

The value of tolerance_lower_limit.

Return type:

tolerance_lower_limit (float)

property tolerance_upper_limit

Gets tolerance_upper_limit.

Summary:

Tolerance for the dimension upper value.

Remarks:

Note that this value is ignored if display_tolerances is False.

Returns:

The value of tolerance_upper_limit.

Return type:

tolerance_upper_limit (float)

apply_master_setting(value)
Summary:

Sets the IDimensionOptions properties from the values in a Dimension Settings master tool setting. $$Syntax$$%%Syntax%%” –>

Remarks:

Using this method may potentially change all of the IDimensionOptions property values. Introduced in Impact 10.0.0.70.

Parameters:

value (IMasterSetting) – The master tool settings object.

create_dimension_angle_format()
Summary:

Creates an IDimensionAngleFormat object which can be applied to the primary or secondary angle formats.

Remarks:

Used in conjunction with primary_angle_format and secondary_angle_format properties.

create_dimension_distance_format()
Summary:

Creates an IDimensionDistanceFormat object which can be applied to the primary or secondary distance formats.

Remarks:

Used in conjunction with primary_distance_format and secondary_distance_format properties.

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