ISceneContributorCollection
===========================

.. py:class:: ansys.stk.core.stkrfchannelmodeler.ISceneContributorCollection

   Represents a collection of scene contributors.

.. py:currentmodule:: ISceneContributorCollection

Overview
--------

.. tab-set::

    .. tab-item:: Methods

        .. list-table::
            :header-rows: 0
            :widths: auto

            * - :py:attr:`~ansys.stk.core.stkrfchannelmodeler.ISceneContributorCollection.item`
              - Given an index, returns the element in the collection.
            * - :py:attr:`~ansys.stk.core.stkrfchannelmodeler.ISceneContributorCollection.remove_at`
              - Remove the scene contributor with the supplied index.
            * - :py:attr:`~ansys.stk.core.stkrfchannelmodeler.ISceneContributorCollection.remove`
              - Remove the supplied scene contributor from the collection.
            * - :py:attr:`~ansys.stk.core.stkrfchannelmodeler.ISceneContributorCollection.add_new`
              - Add and returns a new scene contributor.
            * - :py:attr:`~ansys.stk.core.stkrfchannelmodeler.ISceneContributorCollection.remove_all`
              - Clear all scene contributors from the collection.
            * - :py:attr:`~ansys.stk.core.stkrfchannelmodeler.ISceneContributorCollection.contains`
              - Check to see if a given scene contributor exists in the collection.

    .. tab-item:: Properties

        .. list-table::
            :header-rows: 0
            :widths: auto

            * - :py:attr:`~ansys.stk.core.stkrfchannelmodeler.ISceneContributorCollection.count`
              - Return the number of elements in the collection.
            * - :py:attr:`~ansys.stk.core.stkrfchannelmodeler.ISceneContributorCollection._new_enum`
              - Return an enumerator for the collection.


Import detail
-------------

.. code-block:: python

    from ansys.stk.core.stkrfchannelmodeler import ISceneContributorCollection


Property detail
---------------

.. py:property:: count
    :canonical: ansys.stk.core.stkrfchannelmodeler.ISceneContributorCollection.count
    :type: int

    Return the number of elements in the collection.

.. py:property:: _new_enum
    :canonical: ansys.stk.core.stkrfchannelmodeler.ISceneContributorCollection._new_enum
    :type: EnumeratorProxy

    Return an enumerator for the collection.


Method detail
-------------


.. py:method:: item(self, index: int) -> SceneContributor
    :canonical: ansys.stk.core.stkrfchannelmodeler.ISceneContributorCollection.item

    Given an index, returns the element in the collection.

    :Parameters:

        **index** : :obj:`~int`


    :Returns:

        :obj:`~SceneContributor`


.. py:method:: remove_at(self, index: int) -> None
    :canonical: ansys.stk.core.stkrfchannelmodeler.ISceneContributorCollection.remove_at

    Remove the scene contributor with the supplied index.

    :Parameters:

        **index** : :obj:`~int`


    :Returns:

        :obj:`~None`

.. py:method:: remove(self, stk_object_path: str) -> None
    :canonical: ansys.stk.core.stkrfchannelmodeler.ISceneContributorCollection.remove

    Remove the supplied scene contributor from the collection.

    :Parameters:

        **stk_object_path** : :obj:`~str`


    :Returns:

        :obj:`~None`

.. py:method:: add_new(self, stk_object_path: str) -> SceneContributor
    :canonical: ansys.stk.core.stkrfchannelmodeler.ISceneContributorCollection.add_new

    Add and returns a new scene contributor.

    :Parameters:

        **stk_object_path** : :obj:`~str`


    :Returns:

        :obj:`~SceneContributor`

.. py:method:: remove_all(self) -> None
    :canonical: ansys.stk.core.stkrfchannelmodeler.ISceneContributorCollection.remove_all

    Clear all scene contributors from the collection.

    :Returns:

        :obj:`~None`

.. py:method:: contains(self, stk_object_path: str) -> bool
    :canonical: ansys.stk.core.stkrfchannelmodeler.ISceneContributorCollection.contains

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

    :Parameters:

        **stk_object_path** : :obj:`~str`


    :Returns:

        :obj:`~bool`