IRebridgeOptions

class IRebridgeOptions

Bases: ImpactCOMWrapperBase

Summary:

Specifies the options required to rebridge entities.

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

property distribution_mode

Gets distribution_mode.

Summary:

Specifies how bridges are distributed when rebridging with the rmAboutCentre mode.

Returns:

The value of distribution_mode.

Return type:

distribution_mode (ipRebridgeDistributionMode)

property fixed_number

Gets fixed_number.

Summary:

Overrides the normal calculation for the number of bridges based on the length of an entity.

Returns:

The value of fixed_number.

Return type:

fixed_number (bool)

property intersection_mode

Gets intersection_mode.

Summary:

Specfies how bridges are treated at entity intersections.

Returns:

The value of intersection_mode.

Return type:

intersection_mode (ipRebridgeIntersectionMode)

property land_length

Gets land_length.

Summary:

Specifies the length of initial and final sections of an entity.

Returns:

The value of land_length.

Return type:

land_length (float)

property match_entity

Gets match_entity.

Summary:

Specifies the entity to match to when rebridging using the rmEntity mode.

Remarks:

If an entity is not specified, or the entity specified is not a line, arc or bezier, when rebridging with the mode rmEntity an error will occur.

Returns:

The value of match_entity.

Return type:

match_entity (IEntity)

property max_length_with_no_bridges

Gets max_length_with_no_bridges.

Summary:

Any entity shorter than this length is not bridged.

Returns:

The value of max_length_with_no_bridges.

Return type:

max_length_with_no_bridges (float)

property min_end_land_length

Gets min_end_land_length.

Summary:

Specifies the minimum length of the initial and final section of an entity.

Returns:

The value of min_end_land_length.

Return type:

min_end_land_length (float)

property move_bridge_intersection_distance

Gets move_bridge_intersection_distance.

Summary:

Specifies the distance to move bridges when the intersection_mode is rimMove.

Returns:

The value of move_bridge_intersection_distance.

Return type:

move_bridge_intersection_distance (float)

property number_of_fixed_bridges

Gets number_of_fixed_bridges.

Summary:

Specifies the number of fixed bridges.

Returns:

The value of number_of_fixed_bridges.

Return type:

number_of_fixed_bridges (int)

property rebridge_mode

Gets rebridge_mode.

Summary:

Specifies the mode of operation of the Rebridge method.

Returns:

The value of rebridge_mode.

Return type:

rebridge_mode (ipRebridgeMode)

property spanish_bridges

Gets spanish_bridges.

Summary:

Specifies if half-bridges should be created at each end of an entity.

Returns:

The value of spanish_bridges.

Return type:

spanish_bridges (bool)

property standard_bridge_max_length

Gets standard_bridge_max_length.

Summary:

Specifies the maximum line length that will have only one bridge.

Returns:

The value of standard_bridge_max_length.

Return type:

standard_bridge_max_length (float)

property standard_bridge_seperation

Gets standard_bridge_seperation.

Summary:

Specifies the standard bridge seperation.

Returns:

The value of standard_bridge_seperation.

Return type:

standard_bridge_seperation (float)

property standard_bridge_width

Gets standard_bridge_width.

Summary:

Specifies the size of a standard bridge.

Returns:

The value of standard_bridge_width.

Return type:

standard_bridge_width (float)

property start_gap_length

Gets start_gap_length.

Summary:

Specifies the start gap length.

Returns:

The value of start_gap_length.

Return type:

start_gap_length (float)

property start_land_length

Gets start_land_length.

Summary:

Specifies the length of the initial section of an entity.

Returns:

The value of start_land_length.

Return type:

start_land_length (float)

property tie_bridge_max_length

Gets tie_bridge_max_length.

Summary:

Specifes the maximum length of tie bridges.

Returns:

The value of tie_bridge_max_length.

Return type:

tie_bridge_max_length (float)

property tie_bridge_width

Gets tie_bridge_width.

Summary:

Specifies the size of a tie bridge.

Returns:

The value of tie_bridge_width.

Return type:

tie_bridge_width (float)

property tie_bridges

Gets tie_bridges.

Summary:

Specifies if tie bridges should be created or not.

Returns:

The value of tie_bridges.

Return type:

tie_bridges (bool)

property user_defined_style

Gets user_defined_style.

Summary:

Specifies the name of the bridge style to apply when rebridging using the rmUserDefined mode.

Remarks:

If the user defined style specified does not exist an error will occur.

Returns:

The value of user_defined_style.

Return type:

user_defined_style (str)

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