< Previous | Contents | Manuals Home | Boris FX | Next >
โPicking and Drawing Functions
These allow you to pick points and rectangles in the camera view from a detached (only!) Sizzle dialog. It must be detached so that the user interface is unlocked to pick the points in the camera view!
You can also create on-screen overlay graphics for the duration of the dialog being open; multiple panels can be open at once with separate overlay features. If multiple instances of the same dialog are open, it must use SetGraphicsOwner with a random number or some other method to keep the graphics separate.
AddGroup(groupnm, color) Add a group with this name to contain lines,
they will all have the same color. Use different groups for different colors.
AddGroupLine(groupnm, pt1, pt2) Add a line to this group, from pt1 to pt2, both
in UV coordinates -1..+1.
ClearGroup(groupnm_spec) Remove all lines from the group. If the group
spec ends in an asterisk(*), it is a wild-card match.
DoesGroupExist(groupnm_spec) Returns 1 if the groupnm exists. If the group
spec ends in an asterisk(*), it is a wild-card match.
PickCancel() Cancel a point or rectangle picking operation.
The cancel callback functions will not be PickGraphic(pickName, cancelName) Initiate a graphics group pick mode in the
camera view(s). This dialog must be detached! Call the function named pickName when the user clicks a graphic, with the shot and graphicโs group name as arguments. Call the cancel function if the mode is cancelled due to a different mode being selected or the dialog being closed. See example at end.
PickPoint(pickName, cancelName) Initiate a point pick mode in the camera
view(s). This dialog must be detached! Call the function named pickName when the user clicks a point, with the shot and point as arguments. Call the cancel function if the mode is cancelled due to a different mode being selected or the dialog being closed.
See example at end.
PickRectangle(pickName, cancelName) Initiate a point pick mode in the camera
view(s). This dialog must be detached! Call the function named pickName when the user clicks a point, with the shot and two points as arguments. Call the cancel function if the mode is cancelled due to a different mode being selected or the dialog being closed.
See example at end.
RemoveGroup(groupnm_spec) Remove the named group of lines. If the
group spec ends in an asterisk(*), it is a wild-card match.
SetGraphicsOwner(nm) Sets an arbitrary string (initially the name of
the script) that identifies its graphics groups. SetGroupColor(groupnm_spec, color) Sets the color of the named group of lines.
If the group spec ends in an asterisk(*), it is a
wild-card match and can set the color of multiple groups..
SetGroupOverlayMask(groupnm_spec, image) Sets an overlay mask image.
ยฉ2026 Boris FX, Inc.ย โย UNOFFICIALย โย Converted from original PDF.
