jpatchline

A patch cord. More...

+ Collaboration diagram for jpatchline:

Functions

t_max_err jpatchline_get_startpoint (t_object *l, double *x, double *y)
 Retrieve a patchline's starting point.
t_max_err jpatchline_get_endpoint (t_object *l, double *x, double *y)
 Retrieve a patchline's ending point.
long jpatchline_get_nummidpoints (t_object *l)
 Determine the number of midpoints (segments) in a patchline.
t_objectjpatchline_get_box1 (t_object *l)
 Return the object box from which a patchline originates.
long jpatchline_get_outletnum (t_object *l)
 Return the outlet number of the originating object box from which a patchline begins.
t_objectjpatchline_get_box2 (t_object *l)
 Return the destination object box for a patchline.
long jpatchline_get_inletnum (t_object *l)
 Return the inlet number of the destination object box to which a patchline is connected.
t_objectjpatchline_get_nextline (t_object *b)
 Given a patchline, traverse to the next patchline in the (linked) list.
char jpatchline_get_hidden (t_object *l)
 Determine if a patch line is hidden.
t_max_err jpatchline_set_hidden (t_object *l, char c)
 Set a patchline's visibility.
t_max_err jpatchline_get_color (t_object *l, t_jrgba *prgba)
 Get the color of a patch line.
t_max_err jpatchline_set_color (t_object *l, t_jrgba *prgba)
 Set the color of a patch line.

Detailed Description

A patch cord.


Function Documentation

t_object* jpatchline_get_box1 ( t_object l)

Return the object box from which a patchline originates.

Parameters:
lA pointer to the patchline's instance.
Returns:
The object box from which the patchline originates.
t_object* jpatchline_get_box2 ( t_object l)

Return the destination object box for a patchline.

Parameters:
lA pointer to the patchline's instance.
Returns:
The destination object box for a patchline.
t_max_err jpatchline_get_color ( t_object l,
t_jrgba prgba 
)

Get the color of a patch line.

Parameters:
lA patchline instance.
prgbaThe address of a valid t_jrgba struct that will be filled with the color values of the patch line.
Returns:
An error code.
t_max_err jpatchline_get_endpoint ( t_object l,
double *  x,
double *  y 
)

Retrieve a patchline's ending point.

Parameters:
lA pointer to the patchline's instance.
xThe address of a variable to hold the x-coordinate of the ending point's position upon return.
yThe address of a variable to hold the y-coordinate of the ending point's position upon return.
Returns:
A Max error code.
char jpatchline_get_hidden ( t_object l)

Determine if a patch line is hidden.

Parameters:
lA patchline instance.
Returns:
Zero if the patchline is visible, non-zero if it is hidden.
long jpatchline_get_inletnum ( t_object l)

Return the inlet number of the destination object box to which a patchline is connected.

Parameters:
lA pointer to the patchline's instance.
Returns:
The inlet number.
t_object* jpatchline_get_nextline ( t_object b)

Given a patchline, traverse to the next patchline in the (linked) list.

Parameters:
bA patchline instance.
Returns:
The next patchline. If the current patchline is at the end (tail) of the list, then NULL is returned.
long jpatchline_get_nummidpoints ( t_object l)

Determine the number of midpoints (segments) in a patchline.

Parameters:
lA pointer to the patchline's instance.
Returns:
The number of midpoints in the patchline.
long jpatchline_get_outletnum ( t_object l)

Return the outlet number of the originating object box from which a patchline begins.

Parameters:
lA pointer to the patchline's instance.
Returns:
The outlet number.
t_max_err jpatchline_get_startpoint ( t_object l,
double *  x,
double *  y 
)

Retrieve a patchline's starting point.

Parameters:
lA pointer to the patchline's instance.
xThe address of a variable to hold the x-coordinate of the starting point's position upon return.
yThe address of a variable to hold the y-coordinate of the starting point's position upon return.
Returns:
A Max error code.
t_max_err jpatchline_set_color ( t_object l,
t_jrgba prgba 
)

Set the color of a patch line.

Parameters:
lA patchline instance.
prgbaThe address of a valid t_jrgba struct containing the color to use.
Returns:
An error code.
t_max_err jpatchline_set_hidden ( t_object l,
char  c 
)

Set a patchline's visibility.

Parameters:
lA patchline instance.
cPass 0 to make a patchline visible, or non-zero to hide it.
Returns:
An error code.