IDLitManipulator::RecordUndoValues

Syntax | Return Value | Arguments | Keywords | Version History

The IDLitManipulator::RecordUndoValues function method is used to begin recording the transaction that is occurring as a result of the manipulator interaction. This method works in conjunction with the CommitUndoValues method.

To capture information for the undo-redo system of the tools framework, the initial and final values for the items that the manipulator will adjust must be recorded. This recording process is accomplished with the RecordUndoValues and CommitUndoValues methods.

These two methods make use of the operation that is associated with this manipulator (specified by the OPERATION_IDENTIFIER keyword to the Init method) to capture the needed information. When the RecordUndoValues method is called, the manipulator will retrieve the operation associated with this manipulator and call the RecordInitialValues method on this operation. The RecordInitialValues method is called with a command set, the list of currently selected items (which the manipulator is operating on) and the value that was provided by the PARAMETER_IDENTIFIER keyword to this manipulator. This method will record any information needed to undo the operation and place the values in the provided command set. See IDLitOperation for more information on operations.

For interactive manipulators, the RecordUndoValues method is called as part of the OnMouseDown method.

Syntax

Result = Obj->[IDLitManipulator::]RecordUndoValues()

Return Value

Returns a 1 if recording was successful, or 0 otherwise.

Arguments

None

Keywords

None

Version History