GreasePencilLineartModifier(Modifier)

base classes — bpy_struct, Modifier

class bpy.types.GreasePencilLineartModifier(Modifier)

Generate Line Art strokes from selected source

chaining_image_threshold

Segments with an image distance smaller than this will be chained together (in [0, 0.3], default 0.001)

Type:

float

crease_threshold

Angles smaller than this will be treated as creases. Crease angle priority: object Line Art crease override > mesh auto smooth angle > Line Art default crease. (in [0, 3.14159], default 2.44346)

Type:

float

invert_source_vertex_group

Invert source vertex group values (default False)

Type:

bool

is_baked

This modifier has baked data (default False)

Type:

bool

level_end

Maximum number of occlusions for the generated strokes (in [0, 128], default 0)

Type:

int

level_start

Minimum number of occlusions for the generated strokes (in [0, 128], default 0)

Type:

int

light_contour_object

Use this light object to generate light contour

Type:

Object

opacity

The strength value for the generate strokes (in [0, 1], default 1.0)

Type:

float

overscan

A margin to prevent strokes from ending abruptly at the edge of the image (in [0, 0.5], default 0.1)

Type:

float

radius

The radius for the generated strokes (in [0, 1], default 0.0025)

Type:

float

shadow_camera_far

Far clipping distance of shadow camera (in [0, 10000], default 200.0)

Type:

float

shadow_camera_near

Near clipping distance of shadow camera (in [0, 10000], default 0.1)

Type:

float

shadow_camera_size

Represents the “Orthographic Scale” of an orthographic camera. If the camera is positioned at the light’s location with this scale, it will represent the coverage of the shadow “camera”. (in [0, 10000], default 200.0)

Type:

float

shadow_region_filtering

Select feature lines that comes from lit or shaded regions. Will not affect cast shadow and light contour since they are at the border. (default 'NONE')

• NONE None – Not filtering any lines based on illumination region.

• ILLUMINATED Illuminated – Only selecting lines from illuminated regions.

• SHADED Shaded – Only selecting lines from shaded regions.

• ILLUMINATED_ENCLOSED Illuminated (Enclosed Shapes) – Selecting lines from lit regions, and make the combination of contour, light contour and shadow lines into enclosed shapes.

Type:

Literal[‘NONE’, ‘ILLUMINATED’, ‘SHADED’, ‘ILLUMINATED_ENCLOSED’]

silhouette_filtering

Select contour or silhouette (default 'NONE')

Type:

Literal[‘NONE’, ‘GROUP’, ‘INDIVIDUAL’]

smooth_tolerance

Strength of smoothing applied on jagged chains (in [0, 30], default 0.0)

Type:

float

source_camera

Use specified camera object for generating Line Art strokes

Type:

Object

source_collection

Generate strokes from the objects in this collection

Type:

Collection

source_object

Generate strokes from this object

Type:

Object

source_type

Line Art stroke source type (default 'COLLECTION')

Type:

Literal[‘COLLECTION’, ‘OBJECT’, ‘SCENE’]

source_vertex_group

Match the beginning of vertex group names from mesh objects, match all when left empty (default “”, never None)

Type:

str

split_angle

Angle in screen space below which a stroke is split in two (in [0, 3.14159], default 0.0)

Type:

float

stroke_depth_offset

Move strokes slightly towards the camera to avoid clipping while preserve depth for the viewport (in [-0.1, inf], default 0.05)

Type:

float

target_layer

Grease Pencil layer to which assign the generated strokes (default “”, never None)

Type:

str

target_material

Grease Pencil material assigned to the generated strokes

Type:

Material

use_back_face_culling

Remove all back faces to speed up calculation, this will create edges in different occlusion levels than when disabled (default False)

Type:

bool

use_cache

Use cached scene data from the first Line Art modifier in the stack. Certain settings will be unavailable. (default False)

Type:

bool

use_clip_plane_boundaries

Allow lines generated by the near/far clipping plane to be shown (default True)

Type:

bool

use_contour

Generate strokes from contours lines (default False)

Type:

bool

use_crease

Generate strokes from creased edges (default False)

Type:

bool

use_crease_on_sharp

Allow crease to show on sharp edges (default True)

Type:

bool

use_crease_on_smooth

Allow crease edges to show inside smooth surfaces (default False)

Type:

bool

use_custom_camera

Use custom camera instead of the active camera (default False)

Type:

bool

use_detail_preserve

Keep the zig-zag “noise” in initial chaining (default False)

Type:

bool

use_edge_mark

Generate strokes from Freestyle marked edges (default False)

Type:

bool

use_edge_overlap

Allow edges in the same location (i.e. from edge split) to show properly. May run slower. (default False)

Type:

bool

use_face_mark

Filter feature lines using Freestyle face marks (default False)

Type:

bool

use_face_mark_boundaries

Filter feature lines based on face mark boundaries (default False)

Type:

bool

use_face_mark_invert

Invert face mark filtering (default False)

Type:

bool

use_face_mark_keep_contour

Preserve contour lines while filtering (default True)

Type:

bool

use_fuzzy_all

Treat all lines as the same line type so they can be chained together (default False)

Type:

bool

use_fuzzy_intersections

Treat intersection and contour lines as if they were the same type so they can be chained together (default False)

Type:

bool

use_geometry_space_chain

Use geometry distance for chaining instead of image space (default False)

Type:

bool

use_image_boundary_trimming

Trim all edges right at the boundary of image (including overscan region) (default False)

Type:

bool

use_intersection

Generate strokes from intersections (default False)

Type:

bool

use_intersection_mask

Mask bits to match from Collection Line Art settings (array of 8 items, default (False, False, False, False, False, False, False, False))

Type:

bpy_prop_array[bool]

use_intersection_match

Require matching all intersection masks instead of just one (default False)

Type:

bool

use_invert_collection

Select everything except lines from specified collection (default False)

Type:

bool

use_invert_silhouette

Select anti-silhouette lines (default False)

Type:

bool

use_light_contour

Generate light/shadow separation lines from a reference light object (default False)

Type:

bool

use_loose

Generate strokes from loose edges (default False)

Type:

bool

use_loose_as_contour

Loose edges will have contour type (default False)

Type:

bool

use_loose_edge_chain

Allow loose edges to be chained together (default False)

Type:

bool

use_material

Generate strokes from borders between materials (default False)

Type:

bool

use_material_mask

Use material masks to filter out occluded strokes (default False)

Type:

bool

use_material_mask_bits

Mask bits to match from Material Line Art settings (array of 8 items, default (False, False, False, False, False, False, False, False))

Type:

bpy_prop_array[bool]

use_material_mask_match

Require matching all material masks instead of just one (default False)

Type:

bool

use_multiple_levels

Generate strokes from a range of occlusion levels (default False)

Type:

bool

use_object_instances

Allow particle objects and face/vertex instances to show in Line Art (default True)

Type:

bool

use_offset_towards_custom_camera

Offset strokes towards selected camera instead of the active camera (default False)

Type:

bool

use_output_vertex_group_match_by_name

Match output vertex group based on name (default True)

Type:

bool

use_overlap_edge_type_support

Allow an edge to have multiple overlapping types. This will create a separate stroke for each overlapping type. (default False)

Type:

bool

use_shadow

Project contour lines using a light source object (default False)

Type:

bool

vertex_group

Vertex group name for selected strokes (default “”, never None)

Type:

str

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

bpy_struct.id_data Modifier.name Modifier.type Modifier.show_viewport Modifier.show_render Modifier.show_in_editmode Modifier.show_on_cage

Modifier.show_expanded Modifier.is_active Modifier.use_pin_to_last Modifier.is_override_data Modifier.use_apply_on_spline Modifier.execution_time Modifier.persistent_uid

Inherited Functions

bpy_struct.as_pointer bpy_struct.driver_add bpy_struct.driver_remove bpy_struct.get bpy_struct.id_properties_clear bpy_struct.id_properties_ensure bpy_struct.id_properties_ui bpy_struct.is_property_hidden bpy_struct.is_property_overridable_library bpy_struct.is_property_readonly bpy_struct.is_property_set bpy_struct.items bpy_struct.keyframe_delete

bpy_struct.keyframe_insert bpy_struct.keys bpy_struct.path_from_id bpy_struct.path_from_module bpy_struct.path_resolve bpy_struct.pop bpy_struct.property_overridable_library_set bpy_struct.property_unset bpy_struct.rna_ancestors bpy_struct.type_recast bpy_struct.values Modifier.bl_rna_get_subclass Modifier.bl_rna_get_subclass_py