LineartGpencilModifier(GpencilModifier)

base classes — bpy_struct, GpencilModifier

class bpy.types.LineartGpencilModifier(GpencilModifier)

Generate line art strokes from selected source

chaining_image_threshold

Segments with an image distance smaller than this will be chained together

Type: float in [0, 0.3], default 0.001

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

Type: float in [0, 3.14159], default 2.44346

invert_source_vertex_group

Invert source vertex group values

Type: boolean, default False

is_baked

This modifier has baked data

Type: boolean, default False

level_end

Maximum number of occlusions for the generated strokes

Type: int in [0, 128], default 0

level_start

Minimum number of occlusions for the generated strokes

Type: int in [0, 128], default 0

light_contour_object

Use this light object to generate light contour

Type: Object

opacity

The strength value for the generate strokes

Type: float in [0, 1], default 1.0

overscan

A margin to prevent strokes from ending abruptly at the edge of the image

Type: float in [0, 0.5], default 0.1

shadow_camera_far

Far clipping distance of shadow camera

Type: float in [0, 10000], default 200.0

shadow_camera_near

Near clipping distance of shadow camera

Type: float in [0, 10000], default 0.1

shadow_camera_size

This value represent the “Orthographic Scale” of an ortho camera.If the camera is put at the lamps position with this scale, it will represent the coverage of the shadow “camera”

Type: float in [0, 10000], default 200.0

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

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: enum in [‘NONE’, ‘ILLUMINATED’, ‘SHADED’, ‘ILLUMINATED_ENCLOSED’], default ‘NONE’

silhouette_filtering

Select contour or silhouette

Type: enum in [‘NONE’, ‘GROUP’, ‘INDIVIDUAL’], default ‘NONE’

smooth_tolerance

Strength of smoothing applied on jagged chains

Type: float in [0, 30], default 0.0

source_camera

Use specified camera object for generating line art

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

Type: enum in [‘COLLECTION’, ‘OBJECT’, ‘SCENE’], default ‘COLLECTION’

source_vertex_group

Match the beginning of vertex group names from mesh objects, match all when left empty

Type: string, default “”, (never None)

split_angle

Angle in screen space below which a stroke is split in two

Type: float in [0, 3.14159], default 0.0

stroke_depth_offset

Move strokes slightly towards the camera to avoid clipping while preserve depth for the viewport

Type: float in [-0.1, inf], default 0.05

target_layer

Grease Pencil layer assigned to the generated strokes

Type: string, default “”, (never None)

target_material

Grease Pencil material assigned to the generated strokes

Type: Material

thickness

The thickness for the generated strokes

Type: int in [1, 200], default 25

use_back_face_culling

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

Type: boolean, default False

use_cache

Use cached scene data from the first line art modifier in the stack. Certain settings will be unavailable

Type: boolean, default False

use_clip_plane_boundaries

Allow lines generated by the near/far clipping plane to be shown

Type: boolean, default True

use_contour

Generate strokes from contours lines

Type: boolean, default False

use_crease

Generate strokes from creased edges

Type: boolean, default False

use_crease_on_sharp

Allow crease to show on sharp edges

Type: boolean, default True

use_crease_on_smooth

Allow crease edges to show inside smooth surfaces

Type: boolean, default False

use_custom_camera

Use custom camera instead of the active camera

Type: boolean, default False

use_detail_preserve

Keep the zig-zag “noise” in initial chaining

Type: boolean, default False

use_edge_mark

Generate strokes from freestyle marked edges

Type: boolean, default False

use_edge_overlap

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

Type: boolean, default False

use_face_mark

Filter feature lines using freestyle face marks

Type: boolean, default False

use_face_mark_boundaries

Filter feature lines based on face mark boundaries

Type: boolean, default False

use_face_mark_invert

Invert face mark filtering

Type: boolean, default False

use_face_mark_keep_contour

Preserve contour lines while filtering

Type: boolean, default True

use_fuzzy_all

Treat all lines as the same line type so they can be chained together

Type: boolean, default False

use_fuzzy_intersections

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

Type: boolean, default False

use_geometry_space_chain

Use geometry distance for chaining instead of image space

Type: boolean, default False

use_image_boundary_trimming

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

Type: boolean, default False

use_intersection

Generate strokes from intersections

Type: boolean, default False

use_intersection_mask

Mask bits to match from Collection Line Art settings

Type: boolean array of 8 items, default (False, False, False, False, False, False, False, False)

use_intersection_match

Require matching all intersection masks instead of just one

Type: boolean, default False

use_invert_collection

Select everything except lines from specified collection

Type: boolean, default False

use_invert_silhouette

Select anti-silhouette lines

Type: boolean, default False

use_light_contour

Generate light/shadow separation lines from a reference light object

Type: boolean, default False

use_loose

Generate strokes from loose edges

Type: boolean, default False

use_loose_as_contour

Loose edges will have contour type

Type: boolean, default False

use_loose_edge_chain

Allow loose edges to be chained together

Type: boolean, default False

use_material

Generate strokes from borders between materials

Type: boolean, default False

use_material_mask

Use material masks to filter out occluded strokes

Type: boolean, default False

use_material_mask_bits

Mask bits to match from Material Line Art settings

Type: boolean array of 8 items, default (False, False, False, False, False, False, False, False)

use_material_mask_match

Require matching all material masks instead of just one

Type: boolean, default False

use_multiple_levels

Generate strokes from a range of occlusion levels

Type: boolean, default False

use_object_instances

Support particle objects and face/vertex instances to show in line art

Type: boolean, default True

use_offset_towards_custom_camera

Offset strokes towards selected camera instead of the active camera

Type: boolean, default False

use_output_vertex_group_match_by_name

Match output vertex group based on name

Type: boolean, default False

use_overlap_edge_type_support

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

Type: boolean, default False

use_shadow

Project contour lines using a light source object

Type: boolean, default False

vertex_group

Vertex group name for selected strokes

Type: string, default “”, (never None)

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