Detailed Description

See also:: Class RestoreObj, Class Atmospheric, Class Effect, Class SpecialFX, Class INode.

Description:

This class is available in release 3.0 and later only.

This class enables implementing undo of Gizmo deletion in Atmosphere and Effects classes. This class provides implementations of the RestoreObj methods. An instance of this class can be put on the Hold when a Gizmo is deleted. For example:

if (theHold.Holding())
    theHold.Put(new DeleteGizmoRestore(this,nodes[i],i));

All methods of this class are implemented by the System.

Data Members:: SpecialFX *fx;

Points to the Atmosphere of Effect.

INode *node;

Points to the gizmo node.

int num;

The index of the gizmo which is being deleted.

#include <sfx.h>

Inheritance diagram for DeleteGizmoRestore:

[legend]

List of all members.

Public Member Functions
	DeleteGizmoRestore (SpecialFX a, INode n, int i)
void	Redo ()
void	Restore (int isUndo)
MSTR	Description ()
Public Attributes
SpecialFX *	fx
INode *	node
int	num

Constructor & Destructor Documentation

DeleteGizmoRestore	(	SpecialFX *	a,
		INode *	n,
		int	i
	)		`[inline]`

Remarks:: Constructor. The data members are initialized to the parameter passed.

{   fx = a; node = n; num = i;  }

Member Function Documentation

void Redo ( ) [inline, virtual]

Search for all occurrences

Remarks:: This method is called when the user selects the Redo command. The developer should restore the database to the state prior to the last Undo command.

Implements RestoreObj.

{ fx->DeleteGizmo(num); }

void Restore ( int isUndo ) [inline, virtual]

Search for all occurrences

Remarks:: The developer implements this method to restore the state of the database to as it was when theHold.Put() was called with this restore object.

Regardless of the value of the isUndo parameter, the method must restore the state of the scene to the one it was in when theHold.Put() was called with this restore object.

RestoreObj::Restore and RestoreObj::Redo may be called several times in a row: these methods must protect against any problems that may arise because of this, such as trying to undo multiple times in a row what has been undone already.

Parameters:

isUndo Nonzero if Restore() is being called in response to the Undo command; otherwise zero. If isUndo is nonzero, the developer needs to save whatever data they need to allow the user to redo the operation.

Implements RestoreObj.