See also: Main Index; Alphabetic; Misc; By Author; By Module; By Menu External Links: The Gimp; Gimp User Manual

The Gimp path functions

gimp_get_path_by_tattoo	Return the name of the path with the given tattoo.
gimp_path_delete	Delete the named paths associated with the passed image.
gimp_path_get_current	The name of the current path. Error if no paths.
gimp_path_get_locked	Returns the locked status associated with the name path.
gimp_path_get_point_at_dist	Get point on a path at a specified distance along the path.
gimp_path_get_points	List the points associated with the named path.
gimp_path_get_tattoo	Returns the tattoo associated with the name path.
gimp_path_list	List the paths associated with the passed image.
gimp_path_set_current	List the paths associated with the passed image.
gimp_path_set_locked	Set the locked status associated with the name path.
gimp_path_set_points	Set the points associated with the named path.
gimp_path_set_tattoo	Sets the tattoo associated with the name path.
gimp_path_stroke_current	Stroke the current path in the passed image.
plug_in_gap_move_path	This plugin copies layer(s) from one sourceimage or source animation to multiple frames on disk, varying position, size and opacity.
plug_in_gap_move_path2	This plugin copies layer(s) from one sourceimage or source animation to multiple frames on disk, varying position, size and opacity.
plug_in_sel2path	Converts a selection to a path
plug_in_sel2path_advanced	Converts a selection to a path (with advanced user menu)

gimp_get_path_by_tattoo

Input:

IMAGE	image	The image
INT32	tattoo	The tattoo of the required path

Returns:

STRING

path_name

The name of the path with the specified tattoo

The procedure returns the name of the path in the specified image which has the passed tattoo. The tattoos are unique within the image and will be preserved across sessions and through renaming of the path. An error is returned if no path woth the specified tattoo can be found.
Andy Thomas; 1999

gimp_path_delete

Input:

IMAGE	image	The ID of the image to list delete the paths from
STRING	path_name_to_del	The name of the path to delete

Returns: nothing
Delete the named path.
Andy Thomas; 1999

gimp_path_get_current

Input:

IMAGE

image

The ID of the image to get the current paths from

Returns:

STRING

current_path_name

The name of the current path

The name of the current path. Error if no paths.
Andy Thomas; 1999

gimp_path_get_locked

Input:

IMAGE	image	The image
STRING	pathname	the name of the path whose locked status should be obtained

Returns:

INT32

lockstatus

The lock status associated with the name path. 0 returned if the path is not locked. 1 is returned if the path is locked

This procedure returns the lock status associated with the specified path. A path can be "locked" which means that the transformation tool operations will also apply to the path.
Andy Thomas; 1999

gimp_path_get_point_at_dist

Input:

IMAGE	image	The ID of the image the paths belongs to
FLOAT	distance	The distance along the path

Returns:

INT32	x_point	The x position of the point
INT32	y_point	The y position of the point
FLOAT	gradient	The gradient at the specified point

This will return the x,y position of a point at a given distance along the bezier curve. The distance will the obtained by first digitizing the curve internally an then walking along the curve. For a closed curve the start of the path is the first point on the path that was created. This might not be obvious. Note the current path is used.
Andy Thomas; 1999

gimp_path_get_points

Input:

IMAGE	image	The ID of the image to list the paths from
STRING	pathname	the name of the path whose points should be listed

Returns:

INT32	path_type	The type of the path. Currently only one type (1 = Bezier) is supported
INT32	path_closed	Return if the path is closed. {0=path open, 1= path closed}
INT32	num_path_point_details	The number of points returned. Each point is made up of (x,y,pnt_type) of floats
FLOATARRAY	points_pairs	The points in the path represented as 3 floats. The first is the x pos, next is the y pos, last is the type of the pnt. The type field is dependant on the path type. For beziers (type 1 paths) the type can either be {1.0= BEZIER_ANCHOR, 2.0= BEZIER_CONTROL}. Note all points are returned in pixel resolution

List the points associated with the named path.
Andy Thomas; 1999

gimp_path_get_tattoo

Input:

IMAGE	image	The image
STRING	pathname	the name of the path whose tattoo should be obtained

Returns:

INT32

tattoo

The tattoo associated with the name path

This procedure returns the tattoo associated with the specified path. A tattoo is a unique and permanent identifier attached to a path that can be used to uniquely identify a path within an image even between sessions.
Andy Thomas; 1999

gimp_path_list

Input:

IMAGE

image

The ID of the image to list the paths from

Returns:

INT32	num_paths	The number of paths returned
STRINGARRAY	path_list	List of the paths belonging to this image

List the paths associated with the passed image.
Andy Thomas; 1999

gimp_path_set_current

Input:

IMAGE	image	The ID of the image to list set the paths in
STRING	set_current_path_name	The name of the path to set the current path to

Returns: nothing
List the paths associated with the passed image.
Andy Thomas; 1999

gimp_path_set_locked

Input:

IMAGE	image	The image
STRING	pathname	the name of the path whose locked status should be set
INT32	lockstatus	The lock status associated with the name path. 0 if the path is not locked. 1 if the path is to be locked

Returns: nothing
This procedure sets the lock status associated with the specified path. A path can be "locked" which means that the transformation tool operations will also apply to the path.
Andy Thomas; 1999

gimp_path_set_points

Input:

IMAGE	image	The ID of the image to set the paths in
STRING	pathname	The name of the path to create (if it exists then a unique name will be created - query the list of paths if you want to make sure that the name of the path you create is unique. This will be set as the current path.
INT32	ptype	The type of the path. Currently only one type (1 = Bezier) is supported
INT32	num_path_points	The number of points in the path. Each point is made up of (x,y,type) of floats. Currently only the creation of bezier curves is allowed. The type parameter must be set to (1) to indicate a BEZIER type curve. For BEZIERS. Note the that points must be given in the following order... ACCACCAC ... If the path is not closed the last control point is missed off. Points consist of three control points (control/anchor/control) so for a curve that is not closed there must be at least two points passed (2 x,y pairs). If num_path_pnts % 3 = 0 then the path is assumed to be closed and the points are ACCACCACCACC.
FLOATARRAY	points_pairs	The points in the path represented as 3 floats. The first is the x pos, next is the y pos, last is the type of the pnt. The type field is dependant on the path type. For beziers (type 1 paths) the type can either be {1.0= BEZIER_ANCHOR, 2.0= BEZIER_CONTROL}. Note all points are returned in pixel resolution

Returns: nothing
Set the points associated with the named path.
Andy Thomas; 1999

gimp_path_set_tattoo

Input:

IMAGE	image	The image
STRING	pathname	the name of the path whose tattoo should be set
INT32	tattovalue	The tattoo associated with the name path. Only values returned from 'path_get_tattoo' should be used here

Returns: nothing
This procedure sets the tattoo associated with the specified path. A tattoo is a unique and permenant identifier attached to a path that can be used to uniquely identify a path within an image even between sessions. Note that the value passed to this function must have been obtained from a previous call to path_get_tattoo.
Andy Thomas; 1999

gimp_path_stroke_current

Input:

IMAGE

image

The ID of the image which contains the path to stroke

Returns: nothing
Stroke the current path in the passed image.
Andy Thomas; 1999

plug_in_gap_move_path

Input:

INT32	run_mode	Interactive, non-interactive
IMAGE	dst_image	Destination image (one of the Anim Frames), where to insert the animated source layers
DRAWABLE	drawable	drawable (unused)
INT32	range_from	destination frame nr to start
INT32	range_to	destination frame nr to stop (can be lower than range_from)
INT32	nr	layerstack position where to insert source layer (0 == on top)
LAYER	src_layer_id	starting LayerID of SourceObject. (use any Multilayeranimated Image, or an AnimFrame of anoter Animation)
INT32	src_stepmode	0-5 derive inserted object as copy of one layer from a multilayer src_image 100-105 derive inserted object as copy of merged visible layers of a source animframe 0: Layer Loop 1: Layer Loop reverse 2: Layer Once 3: Layer Once reverse 4: Layer PingPong 5: None (use onle the selected src_layer) 100: Frame Loop 101: Frame Loop reverse 102: Frame Once 103: Frame Once reverse 104: Frame PingPong 105: Frame None (use onle the flat copy of the selected frame)
INT32	src_handle	0: handle left top 1: handle left bottom 2: handle right top 3: handle right bottom 4: handle center
INT32	src_paintmode	0: GIMP_NORMAL_MODE (see GimpLayerModeEffects -- libgimp/gimpenums.h -- for more information)
INT32	src_force_visible	1: Set inserted layres visible, 0: insert layers as is
INT32	clip_to_img	1: Clip inserted layers to Image size of the destination AnimFrame, 0: dont clip
INT32	rotation_follow	0: NO automatic calculation (use the rotation array parameters as it is) 1: Automatic calculation of rotation, following the path vectors, (Ignore rotation array parameters)
INT32	startangle	start angle for the first contolpoint (only used if rotation-follow is on)
INT32ARRAY	p_x	Controlpoint x-koordinate
INT32	argc_p_x	number of controlpoints
INT32ARRAY	p_y	Controlpoint y-koordinate
INT32	argc_p_y	number of controlpoints
INT32ARRAY	opacity	Controlpoint opacity value 0 <= value <= 100
INT32	argc_opacity	number of controlpoints
INT32ARRAY	w_resize	width scaling in percent
INT32	argc_w_resize	number of controlpoints
INT32ARRAY	h_resize	height scaling in percent
INT32	argc_h_resize	number of controlpoints
INT32ARRAY	rotation	rotation in degrees
INT32	argc_rotation	number of controlpoints
INT32ARRAY	keyframe_abs	n: fix controlpoint to this frame number, 0: for controlpoints that are not fixed to a frame.
INT32	argc_keyframe_abs	number of controlpoints

Returns: nothing
This plugin inserts one layer in each frame of the selected frame range of an Animation (specified by the dst_image parameter). An Animation is a series of numbered AnimFrame Images on disk where only the current Frame is opened in the gimp The inserted layer is derived from another (multilayer)image or from another Animation (as merged copy of the visible layers in a source frame) the affected destination frame range is selected by the range_from and range_to parameters the src_stepmode parameter controls how to derive the layer that is to be inserted. With the Controlpoint Parameters you can control position (koordinates), size, rotation and opacity values of the inserted layer If you want to move an Object from position AX/AY to BX/BY in a straight line within the range of 24 frames you need 2 Contolpoints, if you want the object to move folowing a path you need some more Controlpoints to do that. With the rotation_follow Parameter you can force automatic calculation of the rotation for the inserted layer according to the path vectors it is moving along. A controlpoint can be fixed to a special framenumber using the keyframe_abs controlpoint-parameter. Restictions: - keyframe_abs numbers must be 0 (== not fixed) or a frame_number within the affected frame range - keyframes_abs must be in sequence (ascending or descending) - the first and last controlpoint are always implicite keyframes, and should be passed with keyframe_abs = 0 - the number of controlpoints is limitied to a maximum of 1024. the number of controlpoints must be passed in all argc_* parameters See also (plug_in_gap_move_path, plug_in_gap_move)
Wolfgang Hofer; 1.1.29b; 2000/11/30

plug_in_gap_move_path2

Input:

INT32	run_mode	Interactive, non-interactive
IMAGE	dst_image	Destination image (one of the Anim Frames), where to insert the animated source layers
DRAWABLE	drawable	drawable (unused)
INT32	range_from	destination frame nr to start
INT32	range_to	destination frame nr to stop (can be lower than range_from)
INT32	nr	layerstack position where to insert source layer (0 == on top)
LAYER	src_layer_id	starting LayerID of SourceObject. (use any Multilayeranimated Image, or an AnimFrame of anoter Animation)
INT32	src_stepmode	0-5 derive inserted object as copy of one layer from a multilayer src_image 100-105 derive inserted object as copy of merged visible layers of a source animframe 0: Layer Loop 1: Layer Loop reverse 2: Layer Once 3: Layer Once reverse 4: Layer PingPong 5: None (use onle the selected src_layer) 100: Frame Loop 101: Frame Loop reverse 102: Frame Once 103: Frame Once reverse 104: Frame PingPong 105: Frame None (use onle the flat copy of the selected frame)
INT32	src_handle	0: handle left top 1: handle left bottom 2: handle right top 3: handle right bottom 4: handle center
INT32	src_paintmode	0: GIMP_NORMAL_MODE (see GimpLayerModeEffects -- libgimp/gimpenums.h -- for more information)
INT32	src_force_visible	1: Set inserted layres visible, 0: insert layers as is
INT32	clip_to_img	1: Clip inserted layers to Image size of the destination AnimFrame, 0: dont clip
INT32	rotation_follow	0: NO automatic calculation (use the rotation array parameters as it is) 1: Automatic calculation of rotation, following the path vectors, (Ignore rotation array parameters)
INT32	startangle	start angle for the first contolpoint (only used if rotation-follow is on)
STRING	pointfile	a file with contolpoints (readable text file with one line per controlpoint)

Returns: nothing
This plugin is just another Interface for the MovePath (plug_in_gap_move_path) using a File to specify Controlpoints (rather than Array parameters). Notes: - you can create a controlpoint file with in the MovePath Dialog (interactive call of plug_in_gap_move) - for more infos about controlpoints see help of (plug_in_gap_move_path)
Wolfgang Hofer; 1.1.29b; 2000/11/30

plug_in_sel2path

Input:

INT32	run_mode	Interactive, non-interactive
IMAGE	image	Input image (unused)
DRAWABLE	drawable	Input drawable

Returns: nothing
Converts a selection to a path
Andy Thomas; 1999

plug_in_sel2path_advanced

Input:

INT32	run_mode	Interactive, non-interactive
IMAGE	image	Input image (unused)
DRAWABLE	drawable	Input drawable
FLOAT	align_threshold	align_threshold
FLOAT	corner_always_threshold	corner_always_threshold
INT8	corner_surround	corner_surround
FLOAT	corner_threshold	corner_threshold
FLOAT	error_threshold	error_threshold
INT8	filter_alternative_surround	filter_alternative_surround
FLOAT	filter_epsilon	filter_epsilon
INT8	filter_iteration_count	filter_iteration_count
FLOAT	filter_percent	filter_percent
INT8	filter_secondary_surround	filter_secondary_surround
INT8	filter_surround	filter_surround
INT8	keep_knees	{1-Yes, 0-No}
FLOAT	line_reversion_threshold	line_reversion_threshold
FLOAT	line_threshold	line_threshold
FLOAT	reparameterize_improvement	reparameterize_improvement
FLOAT	reparameterize_threshold	reparameterize_threshold
FLOAT	subdivide_search	subdivide_search
INT8	subdivide_surround	subdivide_surround
FLOAT	subdivide_threshold	subdivide_threshold
INT8	tangent_surround	tangent_surround

Returns: nothing
Converts a selection to a path (with advanced user menu)
Andy Thomas; 1999

The Gimp 1.2.5 (win32)	Documentation fresh from PDB	12:10:09 Do 19.06.03
Generated by pdb2doc.py* written by Hans Breuer <Hans(at)Breuer.org>*