I3DInstances

class I3DInstances

Bases: ImpactCOMWrapperBase, Iterable

Description:

A collection of i3_d_instance objects.

Remarks:

Introduced in Impact 11.0.0.39

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

property count

Gets Count.

Description:

The number of items in the collection.

Remarks:

Introduced in Impact 11.0.0.39

Returns:

The value of Count.

Return type:

count (int)

add(type, options)
Description:

Creates a new 3D instance by adding an object (for example, a model) to a 3D scene.

Remarks:

Introduced in Impact 11.0.0.39

Returns:

The new 3D instance.

Parameters:
  • type (ip3DObjectType) – The type of object to be added (for example, a model)

  • options (any) – The options type is dependent on the type of object being added (for example i3_d_create_model_options for an object).

item(variant)
Description:

Gets an i3_d_instance object with the specified index.

Remarks:

Introduced in Impact 11.0.0.39

Parameters:

variant (any) – Specifies the index of the object to retrieve.

remove(value)
Description:

Removes (and deletes) the specified instance from the collection

Remarks:

Introduced in Impact 12.0.0.155

Returns:

Unlike i3_d_instance.delete, this method will not delete any locked instance. Returns True if the instance was deleted.

Parameters:

value (any) – The integer index of the instance to be removed.