:right-sidebar: True

Compass
===================================================================

.. currentmodule:: gi.repository.Shumate





.. class:: Compass(**properties: ~typing.Any)
   :no-contents-entry:


Superclasses: :class:`~gi.repository.Gtk.Widget`, :class:`~gi.repository.GObject.InitiallyUnowned`, :class:`~gi.repository.GObject.Object`



Implemented Interfaces: :class:`~gi.repository.Gtk.Accessible`, :class:`~gi.repository.Gtk.Buildable`, :class:`~gi.repository.Gtk.ConstraintTarget`



:Constructors:

::

    Compass(**properties)
    new(viewport:Shumate.Viewport=None) -> Shumate.Compass



Constructors
------------

.. rst-class:: interim-class

.. class:: Compass
   :no-index:


   .. classmethod:: new(viewport: ~gi.repository.Shumate.Viewport | None = None) -> ~gi.repository.Shumate.Compass

      Creates an instance of :obj:`~gi.repository.Shumate.Compass`.







      :param viewport: a :obj:`~gi.repository.Shumate.Viewport`









Methods
-------

.. rst-class:: interim-class

.. class:: Compass
   :no-index:


   .. method:: get_viewport() -> ~gi.repository.Shumate.Viewport | None

      Gets the viewport used by the compass.










   .. method:: set_viewport(viewport: ~gi.repository.Shumate.Viewport | None = None) -> None

      Sets the compass viewport.







      :param viewport: a :obj:`~gi.repository.Shumate.Viewport`









Properties
----------

.. rst-class:: interim-class

.. class:: Compass
   :no-index:
   

   .. attribute:: props.viewport
      :type: ~gi.repository.Shumate.Viewport

      The viewport to use.