:class:`Circle`
===============


.. py:class:: pyedb.grpc.database.primitive.circle.Circle(pedb, edb_object=None)

   Bases: :py:obj:`ansys.edb.core.primitive.circle.Circle`, :py:obj:`pyedb.grpc.database.primitive.primitive.Primitive`


   
   Represents a circle object.
















   ..
       !! processed by numpydoc !!


.. py:currentmodule:: Circle

Overview
--------

.. tab-set::



   .. tab-item:: Methods

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

          * - :py:attr:`~create`
            - Create a circle.
          * - :py:attr:`~delete`
            - Delete the circle from the layout.
          * - :py:attr:`~get_parameters`
            - Returns parameters.
          * - :py:attr:`~set_parameters`
            - Set parameters.








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

.. code-block:: python

    from pyedb.grpc.database.primitive.circle import Circle



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

.. py:method:: create(layout=None, layer: Union[str, pyedb.grpc.database.layers.layer.Layer] = None, net: Union[str, pyedb.grpc.database.net.net.Net, None] = None, center_x: float = None, center_y: float = None, radius: float = 0.0)

   
   Create a circle.


   :Parameters:

       **layout** : :obj:`.Layout`
           Layout to create this circle in.

       **layer** : :term:`LayerLike`
           Layer to place the circle on.

       **net** : :term:`NetLike` or :data:`python:None`
           Net of the circle.

       **center_x** : :term:`ValueLike`
           X value of the center point.

       **center_y** : :term:`ValueLike`
           Y value of the center point.

       **radius** : :term:`ValueLike`
           Radius value of the circle.

   :Returns:

       :obj:`Circle`
           Circle created.













   ..
       !! processed by numpydoc !!

.. py:method:: delete()

   
   Delete the circle from the layout.
















   ..
       !! processed by numpydoc !!

.. py:method:: get_parameters() -> tuple[float, float, float]

   
   Returns parameters.



   :Returns:

       :class:`python:tuple`\[
           :class:`.Value`,
           :class:`.Value`,
           :class:`.Value`

       ]
           Returns a tuple in this format:
           
           **(center_x, center_y, radius)**
           
           **center_x** : X value of center point.
           
           **center_y** : Y value of center point.
           
           **radius** : Radius value of the circle.













   ..
       !! processed by numpydoc !!

.. py:method:: set_parameters(center_x, center_y, radius)

   
   Set parameters.


   :Parameters:

       **center_x** : :class:`python:float`
           Center x value.

       **center_y** : :class:`python:float`
           Center y value

       **radius** : :class:`python:float`
           Circle radius.














   ..
       !! processed by numpydoc !!