GPencilStroke(bpy_struct)#

base class — bpy_struct

class bpy.types.GPencilStroke(bpy_struct)#

Freehand curve defining part of a sketch

aspect#
Type:

mathutils.Vector of 2 items in [0.01, 1], default (1.0, 1.0)

bound_box_max#
Type:

mathutils.Vector of 3 items in [-inf, inf], default (0.0, 0.0, 0.0), (readonly)

bound_box_min#
Type:

mathutils.Vector of 3 items in [-inf, inf], default (0.0, 0.0, 0.0), (readonly)

display_mode#

Coordinate space that stroke is in

  • SCREEN Screen – Stroke is in screen-space.

  • 3DSPACE 3D Space – Stroke is in 3D-space.

  • 2DSPACE 2D Space – Stroke is in 2D-space.

  • 2DIMAGE 2D Image – Stroke is in 2D-space (but with special ‘image’ scaling).

Type:

enum in [‘SCREEN’, ‘3DSPACE’, ‘2DSPACE’, ‘2DIMAGE’], default ‘SCREEN’

edit_curve#

Temporary data for Edit Curve

Type:

GPencilEditCurve, (readonly)

end_cap_mode#

Stroke end extreme cap style

Type:

enum in [‘ROUND’, ‘FLAT’], default ‘ROUND’

hardness#

Amount of gradient along section of stroke

Type:

float in [0.001, 1], default 1.0

has_edit_curve#

Stroke has Curve data to edit shape

Type:

boolean, default False, (readonly)

is_nofill_stroke#

Special stroke to use as boundary for filling areas

Type:

boolean, default False

line_width#

Thickness of stroke (in pixels)

Type:

int in [1, 1000], default 0

material_index#

Material slot index of this stroke

Type:

int in [-inf, inf], default 0

points#

Stroke data points

Type:

GPencilStrokePoints bpy_prop_collection of GPencilStrokePoint, (readonly)

select#

Stroke is selected for viewport editing

Type:

boolean, default False

select_index#

Index of selection used for interpolation

Type:

int in [-inf, inf], default 0

start_cap_mode#

Stroke start extreme cap style

Type:

enum in [‘ROUND’, ‘FLAT’], default ‘ROUND’

time_start#

Initial time of the stroke

Type:

float in [-inf, inf], default 0.0, (readonly)

triangles#

Triangulation data for HQ fill

Type:

bpy_prop_collection of GPencilTriangle, (readonly)

use_cyclic#

Enable cyclic drawing, closing the stroke

Type:

boolean, default False

uv_rotation#

Rotation of the UV

Type:

float in [-inf, inf], default 0.0

uv_scale#

Scale of the UV

Type:

float in [0.01, 100], default 1.0

uv_translation#

Translation of default UV position

Type:

mathutils.Vector of 2 items in [-inf, inf], default (0.0, 0.0)

vertex_color_fill#

Color used to mix with fill color to get final color

Type:

float array of 4 items in [0, 1], default (0.0, 0.0, 0.0, 0.0)

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

id (string) – The RNA type identifier.

Returns:

The RNA type or default when not found.

Return type:

bpy.types.Struct subclass

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

id (string) – The RNA type identifier.

Returns:

The class or default when not found.

Return type:

type

Inherited Properties#

Inherited Functions#

References#