ISceneContributorCollection#

class ansys.stk.core.stkrfchannelmodeler.ISceneContributorCollection#: Represents a collection of scene contributors.

Overview#

Methods

`item`	Given an index, returns the element in the collection.
`remove_at`	Remove the scene contributor with the supplied index.
`remove`	Remove the supplied scene contributor from the collection.
`add_new`	Add and returns a new scene contributor.
`remove_all`	Clear all scene contributors from the collection.
`contains`	Check to see if a given scene contributor exists in the collection.

Properties

`count`	Return the number of elements in the collection.
`_new_enum`	Return an enumerator for the collection.

from ansys.stk.core.stkrfchannelmodeler import ISceneContributorCollection

property ISceneContributorCollection.count: int#: Return the number of elements in the collection.

property ISceneContributorCollection._new_enum: EnumeratorProxy#: Return an enumerator for the collection.

ISceneContributorCollection.item(self, index: int) → SceneContributor#

Given an index, returns the element in the collection.

ISceneContributorCollection.remove_at(self, index: int) → None#

Remove the scene contributor with the supplied index.

ISceneContributorCollection.remove(self, stk_object_path: str) → None#

Remove the supplied scene contributor from the collection.

ISceneContributorCollection.add_new(self, stk_object_path: str) → SceneContributor#

Add and returns a new scene contributor.

ISceneContributorCollection.remove_all(self) → None#

Clear all scene contributors from the collection.

ISceneContributorCollection.contains(self, stk_object_path: str) → bool#

Check to see if a given scene contributor exists in the collection.