EOIRShapeCollection

class ansys.stk.core.stkobjects.EOIRShapeCollection

Collection of shapes.

Overview

Methods

item	Given an index, returns an element in the collection. If the index is an integer, then the method returns the element in the collection at the given position. If the index is a string, then the method returns the element with the specified name.
add	Add an element at the end of the collection.
remove_at	Remove an element at the given index in the collection.

Properties

count	Return the number of elements in a collection.
_new_enum	Return an enumerator that can iterate through the collection.

Import detail

from ansys.stk.core.stkobjects import EOIRShapeCollection

Property detail

property EOIRShapeCollection.count: int

Return the number of elements in a collection.

property EOIRShapeCollection._new_enum: EnumeratorProxy

Return an enumerator that can iterate through the collection.

Method detail

EOIRShapeCollection.item(self, index: int) → EOIRShape

Given an index, returns an element in the collection. If the index is an integer, then the method returns the element in the collection at the given position. If the index is a string, then the method returns the element with the specified name.

Parameters:

index : int

Returns:

EOIRShape

EOIRShapeCollection.add(self) → EOIRShape

Add an element at the end of the collection.

Returns:

EOIRShape

EOIRShapeCollection.remove_at(self, index: int) → None

Remove an element at the given index in the collection.

Parameters:

index : int

Returns:

None