shuffle_curve

Context: curves

Synopsis

Shuffles the rendering order of the curve within the depth.

Syntax

shuffle_curve([id,] [direction])

Description

id - an optional ChipsId structure containing values to modify the currency state for the command, or a string to specify the id of the curve to operate on.
direction - how to shuffle the object; options are chips_forward, chips_backward, chips_front, and chips_back. If not given then chips_forward is assumed.

By default, objects within a depth are ordered chonologically based on when they were added to that depth. The objects are stacked with the oldest item at the back of the list and the newest item at the front of the list. This order dictates how the objects overlap when drawn.

The shuffle_curve command modifies the location of the specified object within the depth. It may be used to position a curve in front of or behind other objects which are at the same depth.

The available "direction" options are:

chips_back - send to the back of the stack
chips_front - send to the front of the stack
chips_forward - moves one step closer to the front
chips_backward - moves one step further back

The shuffle routines can only operate on a single object. An error is returned if currency is set to "all".

Example 1

chips> add_curve([1,2,3],[3.5,3.5,3])
chips> add_curve([1,2.5,3],[3,3.5,3.5])
chips> add_region([1,2,3],[4,0,4],["opacity",1,"fill.style", "1"])
chips> shuffle_curve(chips_forward)

Create two curves and a region; the region initially obscures the curves. Move the current curve one step forward in the depth so that it appears on top of the region.

Example 2

chips> id=ChipsId()
chips> id.curve="crv1"
chips> shuffle_curve(id,chips_front)

Using a ChipsId structure to specify the id, move the curve "crv1" to the front of the stack.

Bugs

See the bugs pages on the ChIPS website for an up-to-date listing of known bugs.