EEditEditEffectToolbox Class Reference

This allows you to edit the effect. More...

#include <eeditediteffecttoolbox.h>

List of all members.

Public Types
enum	ANCHOR_TYPE {   AT_NONE = 0, AT_BASIC, AT_SPLINE, AT_SOCKET,   AT_COUNT }
Public Member Functions
	EEditEditEffectToolbox ()
virtual const char *	GetName () const
	Gets the name of the toolbox.
virtual size_t	GetType () const
	Gets the toolbox type.
void	LoadEffect (psEffect *effect)
	Loads the given effect tree.
virtual bool	OnButtonPressed (int mouseButton, int keyModifier, pawsWidget *widget)
	Called whenever a button is pressed.
virtual bool	OnSelected (pawsWidget *widget)
	Called whenever a widget is selected.
virtual void	OnUpdateData (const char *dataname, PAWSData &data)
virtual bool	PostSetup ()
	This is called after the widget and all of it's children have been created.
virtual void	Update (unsigned int elapsed)
	Updates the toobox.
virtual	~EEditEditEffectToolbox ()

---

Detailed Description

This allows you to edit the effect.

Definition at line 50 of file eeditediteffecttoolbox.h.

---

Member Enumeration Documentation

enum EEditEditEffectToolbox::ANCHOR_TYPE

Enumerator:

AT_NONE
AT_BASIC
AT_SPLINE
AT_SOCKET
AT_COUNT

Definition at line 81 of file eeditediteffecttoolbox.h.

---

Constructor & Destructor Documentation

EEditEditEffectToolbox::EEditEditEffectToolbox

(

)

virtual EEditEditEffectToolbox::~EEditEditEffectToolbox

(

)

[virtual]

---

Member Function Documentation

virtual const char* EEditEditEffectToolbox::GetName

(

)

const [virtual]

Gets the name of the toolbox.

Returns:

the toolbox name

Implements EEditToolbox.

virtual size_t EEditEditEffectToolbox::GetType

(

)

const [virtual]

Gets the toolbox type.

Returns:

the toolbox type

Implements EEditToolbox.

void EEditEditEffectToolbox::LoadEffect

(

psEffect *

effect

)

Loads the given effect tree.

Parameters:

effect

the effect to load

virtual bool EEditEditEffectToolbox::OnButtonPressed	(	int	button,
		int	keyModifier,
		pawsWidget *	widget
	)		[virtual]

Called whenever a button is pressed.

Parameters:

button	The button pressed.
keyModifier	Modifier key in effect.
widget	The widget the button belongs to.

Returns:

bool Parent's result or FALSE if no parent.

Reimplemented from pawsWidget.

virtual bool EEditEditEffectToolbox::OnSelected

(

pawsWidget *

widget

)

[virtual]

Called whenever a widget is selected.

Parameters:

widget

The selected widget.

Returns:

false.

Reimplemented from pawsWidget.

virtual void EEditEditEffectToolbox::OnUpdateData	(	const char *	dataname,
		PAWSData &	data
	)		[virtual]

Reimplemented from pawsWidget.

virtual bool EEditEditEffectToolbox::PostSetup

(

)

[virtual]

This is called after the widget and all of it's children have been created.

Remarks:

This can be useful for widgets that want to get pointers to some of it's children for quick access.

Reimplemented from pawsWidget.

virtual void EEditEditEffectToolbox::Update

(

unsigned int

elapsed

)

[virtual]

Updates the toobox.

Parameters:

elapsed

the time elapsed in milliseconds.

Reimplemented from EEditToolbox.

---

The documentation for this class was generated from the following file:

• eedit/eeditediteffecttoolbox.h