NAME¶

AlignCmd, AlignToGridCmd - commands for aligning interactors to eachother and to a grid

SYNOPSIS¶

#include <Unidraw/Commands/align.h>

DESCRIPTION¶

AlignCmd is a purely interpretive command for aligning selectedcomponents with respect to one another. For example, it can align theleft sides of selected components so that they coincide.AlignToGridCmd is interpreted by selected GraphicView objects to alignthemselves to the grid (if any) associated with the viewer in whichthey appear. Each component can thus define what it means to alignitself to the grid.

ALIGNCMDPUBLICOPERATIONS¶

AlignCmd(

ControlInfo*,

Alignment reference = Left, Alignment affected = Left

)

AlignCmd(Editor* = nil, Alignment = Left, Alignment = Left)

The constructor takes optional arguments for specifying the alignmentdesired. The reference parameter specifies a point on a fixed reference component. The affected parameter specifies a point on components that will move to realize the alignment. The defaults for these parameters specify that all affected components should align their left sides to reference's left side.

void GetAlignment(Alignment&, Alignment&)

Return the alignment parameters specified in the constructor.

GraphicComp* GetReference(GraphicComp* affected)

Return the reference component given a potentially affected component.If affected appears in the AlignCmd's clipboard, then GetReference returns the GraphicComp preceding it in the clipboard. If affected is the first component in the clipboard or if it is not on the clipboard, then GetReference returns the first component on the clipboard.

ALIGNTOGRIDCMDPUBLICOPERATIONS¶

AlignToGridCmd(ControlInfo*)

AlignToGridCmd(Editor* = nil)

Construct an AlignToGridCmd.

virtual void Execute()

virtual void Unexecute()

AlignToGridCmd redefines Execute to let the selected GraphicViewobjects interpret the command the first time. This lets thecomponents determine the proper grid with which to align themselvesand the amount of movement required. Execute assumes that GraphicViewobjects will use the Align operation (described below) to compute theamount of movement, store it in a MoveData object, and finally issue aMoveCmd to the subject for interpretation. Unexecute simply callsUnmove (described below) to reverse the Align's effects.

virtual void Align(GraphicView*, float, float)

virtual void Unalign(GraphicView*)

GraphicView objects interpreting the AlignToGridCmd should use theAlign operation to specify a point to align to the grid that affectsthem. Align will effectively move the component so that the givenpoint falls on the grid. It will also store the amount of movement inthis by calling Store with a MoveData object. Finally, Align calls Move (described below) to actually move the component that amount. Unalign provides a public interface to reversing the effects of Align by simply calling Unmove with its argument's subject.

ALIGNTOGRIDCMDPROTECTEDOPERATIONS¶

void Move(GraphicComp*)

void Unmove(GraphicComp*)

Move produces a MoveCmd based on the MoveData stored for the givenGraphicComp and tells the GraphicComp to interpret the MoveCmd.Conversely, Unmove produces a MoveCmd based on the the sameinformation and tells the GraphicComp to uninterpret it.

SEEALSO¶

Command(3U), GraphicComp(3U), GraphicView(3U), Grid(3U), Viewer(3U),datas(3U), transforms(3U)