RegularPolygon
==============

.. currentmodule:: kgpy.optics.apertures

.. autoclass:: kgpy.optics.apertures.RegularPolygon
    :members:
    :show-inheritance:
    :inherited-members:
    :undoc-members:
    :member-order: groupwise

    .. automethod:: __init__

    
    
    .. rubric:: Attributes

    .. autosummary::
    
      ~RegularPolygon.broadcasted
      ~RegularPolygon.edge_subtent
      ~RegularPolygon.half_edge_subtent
      ~RegularPolygon.is_active
      ~RegularPolygon.is_obscuration
      ~RegularPolygon.max
      ~RegularPolygon.min
      ~RegularPolygon.min_radius
      ~RegularPolygon.num_samples
      ~RegularPolygon.num_sides
      ~RegularPolygon.offset_angle
      ~RegularPolygon.radius
      ~RegularPolygon.shape
      ~RegularPolygon.shapely_poly
      ~RegularPolygon.vertices
      ~RegularPolygon.wire
      ~RegularPolygon.transform
      ~RegularPolygon.plot_kwargs
    
    

    
    
    .. rubric:: Methods

    .. autosummary::
    
      ~RegularPolygon.__init__
      ~RegularPolygon.copy
      ~RegularPolygon.copy_shallow
      ~RegularPolygon.is_unvignetted
      ~RegularPolygon.plot
      ~RegularPolygon.write_to_dxf
    
    

    
    .. rubric:: Inheritance Diagram

    .. inheritance-diagram:: kgpy.optics.apertures.RegularPolygon