Curve(ID)#

base classes — bpy_struct, ID

subclasses — SurfaceCurve, TextCurve

class bpy.types.Curve(ID)#

Curve data-block storing curves, splines and NURBS

animation_data#

Animation data for this data-block

Type:

AnimData, (readonly)

bevel_depth#

Radius of the bevel geometry, not including extrusion

Type:

float in [-inf, inf], default 0.0

bevel_factor_end#

Define where along the spline the curve geometry ends (0 for the beginning, 1 for the end)

Type:

float in [0, 1], default 1.0

bevel_factor_mapping_end#

Determine how the geometry end factor is mapped to a spline

  • RESOLUTION Resolution – Map the geometry factor to the number of subdivisions of a spline (U resolution).

  • SEGMENTS Segments – Map the geometry factor to the length of a segment and to the number of subdivisions of a segment.

  • SPLINE Spline – Map the geometry factor to the length of a spline.

Type:

enum in [‘RESOLUTION’, ‘SEGMENTS’, ‘SPLINE’], default ‘RESOLUTION’

bevel_factor_mapping_start#

Determine how the geometry start factor is mapped to a spline

  • RESOLUTION Resolution – Map the geometry factor to the number of subdivisions of a spline (U resolution).

  • SEGMENTS Segments – Map the geometry factor to the length of a segment and to the number of subdivisions of a segment.

  • SPLINE Spline – Map the geometry factor to the length of a spline.

Type:

enum in [‘RESOLUTION’, ‘SEGMENTS’, ‘SPLINE’], default ‘RESOLUTION’

bevel_factor_start#

Define where along the spline the curve geometry starts (0 for the beginning, 1 for the end)

Type:

float in [0, 1], default 0.0

bevel_mode#

Determine how to build the curve’s bevel geometry

  • ROUND Round – Use circle for the section of the curve’s bevel geometry.

  • OBJECT Object – Use an object for the section of the curve’s bevel geometry segment.

  • PROFILE Profile – Use a custom profile for each quarter of curve’s bevel geometry.

Type:

enum in [‘ROUND’, ‘OBJECT’, ‘PROFILE’], default ‘ROUND’

bevel_object#

The name of the Curve object that defines the bevel shape

Type:

Object

bevel_profile#

The path for the curve’s custom profile

Type:

CurveProfile, (readonly)

bevel_resolution#

The number of segments in each quarter-circle of the bevel

Type:

int in [0, 32], default 4

cycles#

Cycles mesh settings

Type:

CyclesMeshSettings, (readonly)

dimensions#

Select 2D or 3D curve type

  • 2D 2D – Clamp the Z axis of the curve.

  • 3D 3D – Allow editing on the Z axis of this curve, also allows tilt and curve radius to be used.

Type:

enum in [‘2D’, ‘3D’], default ‘2D’

eval_time#

Parametric position along the length of the curve that Objects ‘following’ it should be at (position is evaluated by dividing by the ‘Path Length’ value)

Type:

float in [-inf, inf], default 0.0

extrude#

Length of the depth added in the local Z direction along the curve, perpendicular to its normals

Type:

float in [0, inf], default 0.0

fill_mode#

Mode of filling curve

Type:

enum in [‘FULL’, ‘BACK’, ‘FRONT’, ‘HALF’], default ‘FULL’

is_editmode#

True when used in editmode

Type:

boolean, default False, (readonly)

materials#
Type:

IDMaterials bpy_prop_collection of Material, (readonly)

offset#

Distance to move the curve parallel to its normals

Type:

float in [-inf, inf], default 0.0

path_duration#

The number of frames that are needed to traverse the path, defining the maximum value for the ‘Evaluation Time’ setting

Type:

int in [1, 1048574], default 100

render_resolution_u#

Surface resolution in U direction used while rendering (zero uses preview resolution)

Type:

int in [0, 1024], default 0

render_resolution_v#

Surface resolution in V direction used while rendering (zero uses preview resolution)

Type:

int in [0, 1024], default 0

resolution_u#

Number of computed points in the U direction between every pair of control points

Type:

int in [1, 1024], default 12

resolution_v#

The number of computed points in the V direction between every pair of control points

Type:

int in [1, 1024], default 12

shape_keys#
Type:

Key, (readonly)

splines#

Collection of splines in this curve data object

Type:

CurveSplines bpy_prop_collection of Spline, (readonly)

taper_object#

Curve object name that defines the taper (width)

Type:

Object

taper_radius_mode#

Determine how the effective radius of the spline point is computed when a taper object is specified

  • OVERRIDE Override – Override the radius of the spline point with the taper radius.

  • MULTIPLY Multiply – Multiply the radius of the spline point by the taper radius.

  • ADD Add – Add the radius of the bevel point to the taper radius.

Type:

enum in [‘OVERRIDE’, ‘MULTIPLY’, ‘ADD’], default ‘OVERRIDE’

texspace_location#
Type:

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

texspace_size#
Type:

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

twist_mode#

The type of tilt calculation for 3D Curves

  • Z_UP Z-Up – Use Z-Up axis to calculate the curve twist at each point.

  • MINIMUM Minimum – Use the least twist over the entire curve.

  • TANGENT Tangent – Use the tangent to calculate twist.

Type:

enum in [‘Z_UP’, ‘MINIMUM’, ‘TANGENT’], default ‘MINIMUM’

twist_smooth#

Smoothing iteration for tangents

Type:

float in [-inf, inf], default 0.0

use_auto_texspace#

Adjust active object’s texture space automatically when transforming object

Type:

boolean, default True

use_deform_bounds#

Option for curve-deform: Use the mesh bounds to clamp the deformation

Type:

boolean, default True

use_fill_caps#

Fill caps for beveled curves

Type:

boolean, default False

use_map_taper#

Map effect of the taper object to the beveled part of the curve

Type:

boolean, default False

use_path#

Enable the curve to become a translation path

Type:

boolean, default False

use_path_clamp#

Clamp the curve path children so they can’t travel past the start/end point of the curve

Type:

boolean, default False

use_path_follow#

Make curve path children rotate along the path

Type:

boolean, default False

use_radius#

Option for paths and curve-deform: apply the curve radius to objects following it and to deformed objects

Type:

boolean, default True

use_stretch#

Option for curve-deform: make deformed child stretch along entire path

Type:

boolean, default False

transform(matrix, shape_keys=False)#

Transform curve by a matrix

Parameters:

  • matrix (mathutils.Matrix of 4 * 4 items in [-inf, inf]) – Matrix

  • shape_keys (boolean, (optional)) – Transform Shape Keys

validate_material_indices()#

Validate material indices of splines or letters, return True when the curve has had invalid indices corrected (to default 0)

Returns:

Result

Return type:

boolean

update_gpu_tag()#

update_gpu_tag

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#