GPencilSculptGuide(bpy_struct)

base class — bpy_struct

class bpy.types.GPencilSculptGuide(bpy_struct)

Guides for drawing

angle

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

Type:

float

angle_snap

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

Type:

float

location

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

Type:

bpy_prop_array[float]

reference_object

Object used for reference point

Type:

Object

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’]

spacing

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

Type:

float

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’]

use_guide

Enable speed guides (default False)

Type:

bool

use_snapping

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

Type:

bool

classmethod bl_rna_get_subclass(id, default=None, /)
Parameters:

  • id (str) – The RNA type identifier.

  • default (bpy.types.Struct | None) – The value to return when not found.

Returns:

The RNA type or default when not found.

Return type:

bpy.types.Struct

classmethod bl_rna_get_subclass_py(id, default=None, /)
Parameters:

  • id (str) – The RNA type identifier.

  • default (type | None) – The value to return when not found.

Returns:

The class or default when not found.

Return type:

type

Inherited Properties

Inherited Functions

References