GPencilSculptGuide(bpy_struct)
==============================

.. currentmodule:: bpy.types

base class --- :class:`bpy_struct`

.. class:: GPencilSculptGuide(bpy_struct)

   Guides for drawing

   .. attribute:: angle

      Direction of lines (in [-6.28319, 6.28319], default 0.0)

      :type: float

   .. attribute:: angle_snap

      Angle snapping (in [-6.28319, 6.28319], default 0.0)

      :type: float

   .. attribute:: location

      Custom reference point for guides (array of 3 items, in [-inf, inf], default (0.0, 0.0, 0.0))

      :type: :class:`bpy_prop_array`\ [float]

   .. attribute:: reference_object

      Object used for reference point

      :type: :class:`Object` | None

   .. attribute:: reference_point

      Type of speed guide (default ``'CURSOR'``)

      - ``CURSOR``
        Cursor -- Use cursor as reference point.
      - ``CUSTOM``
        Custom -- Use custom reference point.
      - ``OBJECT``
        Object -- Use object as reference point.

      :type: Literal['CURSOR', 'CUSTOM', 'OBJECT']

   .. attribute:: spacing

      Guide spacing (in [0, inf], default 20.0)

      :type: float

   .. attribute:: type

      Type of speed guide (default ``'CIRCULAR'``)

      - ``CIRCULAR``
        Circular -- Use single point to create rings.
      - ``RADIAL``
        Radial -- Use single point as direction.
      - ``PARALLEL``
        Parallel -- Parallel lines.
      - ``GRID``
        Grid -- Grid allows horizontal and vertical lines.
      - ``ISO``
        Isometric -- Grid allows isometric and vertical lines.

      :type: Literal['CIRCULAR', 'RADIAL', 'PARALLEL', 'GRID', 'ISO']

   .. attribute:: use_guide

      Enable speed guides (default False)

      :type: bool

   .. attribute:: use_snapping

      Enable snapping to guides angle or spacing options (default False)

      :type: bool

   .. classmethod:: bl_rna_get_subclass(id, default=None, /)
   
      :param id: The RNA type identifier.
      :type id: str
      :param default: The value to return when not found.
      :type default: :class:`bpy.types.Struct` | None
      :return: The RNA type or default when not found.
      :rtype: :class:`bpy.types.Struct`


   .. classmethod:: bl_rna_get_subclass_py(id, default=None, /)
   
      :param id: The RNA type identifier.
      :type id: str
      :param default: The value to return when not found.
      :type default: type | None
      :return: The class or default when not found.
      :rtype: type


Inherited Properties
--------------------

.. hlist::
   :columns: 2

   - :class:`bpy_struct.id_data`

Inherited Functions
-------------------

.. hlist::
   :columns: 2

   - :class:`bpy_struct.as_pointer`
   - :class:`bpy_struct.driver_add`
   - :class:`bpy_struct.driver_remove`
   - :class:`bpy_struct.get`
   - :class:`bpy_struct.id_properties_clear`
   - :class:`bpy_struct.id_properties_ensure`
   - :class:`bpy_struct.id_properties_ui`
   - :class:`bpy_struct.is_property_hidden`
   - :class:`bpy_struct.is_property_overridable_library`
   - :class:`bpy_struct.is_property_readonly`
   - :class:`bpy_struct.is_property_set`
   - :class:`bpy_struct.items`
   - :class:`bpy_struct.keyframe_delete`
   - :class:`bpy_struct.keyframe_insert`
   - :class:`bpy_struct.keys`
   - :class:`bpy_struct.path_from_id`
   - :class:`bpy_struct.path_from_module`
   - :class:`bpy_struct.path_resolve`
   - :class:`bpy_struct.pop`
   - :class:`bpy_struct.property_overridable_library_set`
   - :class:`bpy_struct.property_unset`
   - :class:`bpy_struct.rna_ancestors`
   - :class:`bpy_struct.type_recast`
   - :class:`bpy_struct.values`

References
----------

.. hlist::
   :columns: 2

   - :class:`GPencilSculptSettings.guide`

