IPathFinder

class IPathFinder

Bases: ImpactCOMWrapperBase

Summary:

Allows you to perform a path-finding operation.

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 continue_past_deadends

Gets continue_past_deadends.

Summary:

Specifies if the tool will pause when a dead-end is detected along the path.

Remarks:

Introduced in Impact 8.0.0.74

Returns:

The value of continue_past_deadends.

Return type:

continue_past_deadends (bool)

property created_entities

Gets created_entities.

Summary:

Returns the entities created during the last Perform.

Remarks:

Introduced in Impact 8.0.0.74

Returns:

The value of created_entities.

Return type:

created_entities (IEntities)

property end_entity

Gets end_entity.

Summary:

Specifies the target entity for the end of the path.

Remarks:

The specified entity must be in the current block. Note that this property will be ignored if end_recursed_entity has been set. Introduced in Impact 8.0.0.74

Returns:

The value of end_entity.

Return type:

end_entity (IEntity)

property end_point

Gets end_point.

Summary:

Specifies the point on the end entity at which to finish the path.

Remarks:

Introduced in Impact 8.0.0.74

Returns:

The value of end_point.

Return type:

end_point (IVector)

property end_recursed_entity

Gets end_recursed_entity.

Summary:

Specifies the target entity for the end of the path, expressed as a recursed entity.

Remarks:

The start_recursed_entity and end_recursed_entity properies should be used (instead of start_entity and end_entity) when the entities are not within the current block. The IRecursedEntity object contains a reference to the entity and its transformation matrix. Introduced in Impact 9.0.0.77.

Returns:

The value of end_recursed_entity.

Return type:

end_recursed_entity (IRecursedEntity)

property hole_path_options

Gets hole_path_options.

Summary:

An IHolePathOptions object which specifies the settings to be used for the path-finding.

Remarks:

Introduced in Impact 8.0.0.74

Returns:

The value of hole_path_options.

Return type:

hole_path_options (IHolePathOptions)

property left_on_junction

Gets left_on_junction.

Summary:

Allows control of the direction of the path at intersections (junctions).

Remarks:

Introduced in Impact 8.0.0.74

Returns:

The value of left_on_junction.

Return type:

left_on_junction (bool)

property path

Gets Path.

Summary:

The original entities that form the path.

Remarks:

Introduced in Impact 8.0.0.74

Returns:

The value of Path.

Return type:

path (IEntities)

property position

Gets Position.

Summary:

Specifies the direction of travel from the start entity.

Remarks:

Introduced in Impact 8.0.0.74

Returns:

The value of Position.

Return type:

position (IVector)

property replicate

Gets Replicate.

Summary:

Specifies if the tool is to check for paths of the same configuration of entities and blocks as the path highlighted and automatically copy the geometry.

Remarks:

Introduced in Impact 8.0.0.74

Returns:

The value of Replicate.

Return type:

replicate (bool)

property start_entity

Gets start_entity.

Summary:

Specifies the entity at the begining of the path.

Remarks:

The specified entity must be in the current block. Note that this property will be ignored if start_recursed_entity has been set. Introduced in Impact 8.0.0.74

Returns:

The value of start_entity.

Return type:

start_entity (IEntity)

property start_point

Gets start_point.

Summary:

Specifies the point on the start entity at which to begin the path.

Remarks:

Introduced in Impact 8.0.0.74

Returns:

The value of start_point.

Return type:

start_point (IVector)

property start_recursed_entity

Gets start_recursed_entity.

Summary:

Specifies the entity at the begining of the path, expressed as a recursed entity.

Remarks:

The start_recursed_entity and end_recursed_entity properies should be used (instead of start_entity and end_entity) when the entities are not within the current block. The IRecursedEntity object contains a reference to the entity and its transformation matrix. Introduced in Impact 9.0.0.77.

Returns:

The value of start_recursed_entity.

Return type:

start_recursed_entity (IRecursedEntity)

create_hole_path_options()
Summary:

Creates an IHolePathOptions object to define the path-finder settings.

Remarks:

Introduced in Impact 8.0.0.74

isNone()

Checks if the COM object is None. This is useful for determining if the wrapper has been initialized with a valid COM object.

perform()
Summary:

Perform the path-finding operation.

Remarks:

When Perform is called, it checks if the start_recursed_entity and end_recursed_entity properties have both been set and if they have it will use them regardless of whether the start_entity or end_entity properties have also been set. If either start_recursed_entity or end_recursed_entity properties are unset, then it will try to use the start_entity and end_entity properties instead. However it will only use them if they’re both in the current block - if they aren’t then an error will occur. Introduced in Impact 8.0.0.74. Updated in 9.0.0.77 to use recursed entities.

Returns:

Returns True if any path could be created (even if it doesn’t reach the target entity).

reset()
Summary:

Resets the values of the IPathFinder object.

Remarks:

Useful if you want to use the same IPathFinder object for several operations. Introduced in Impact 8.0.0.74

Examples