AlphaFramework API  1.0.3
Public Member Functions | Protected Member Functions | Events | List of all members
AlphaFramework.Editor.World.Dialogs.MapPropertiesTool Class Reference

Allows the user to modify the properties of a IUniverse. More...

Inheritance diagram for AlphaFramework.Editor.World.Dialogs.MapPropertiesTool:

Public Member Functions

 MapPropertiesTool (IUniverse universe)
 Creates a new map properties tool window. More...
 
void UpdateUniverse (IUniverse universe)
 Updates the IUniverse object being represented by this window. More...
 

Protected Member Functions

override void Dispose (bool disposing)
 Clean up any resources being used. More...
 

Events

Action< IUndoCommandExecuteCommand
 Occurs when a command is to be executed by the owning tab. More...
 

Detailed Description

Allows the user to modify the properties of a IUniverse.

This is a non-modal floating toolbox window. Communication is handled via events (ExecuteCommand).

Constructor & Destructor Documentation

◆ MapPropertiesTool()

AlphaFramework.Editor.World.Dialogs.MapPropertiesTool.MapPropertiesTool ( IUniverse  universe)
inline

Creates a new map properties tool window.

Parameters
universeThe map data to modify.

Member Function Documentation

◆ Dispose()

override void AlphaFramework.Editor.World.Dialogs.MapPropertiesTool.Dispose ( bool  disposing)
inlineprotected

Clean up any resources being used.

Parameters
disposingtrue if managed resources should be disposed; otherwise, false.

◆ UpdateUniverse()

void AlphaFramework.Editor.World.Dialogs.MapPropertiesTool.UpdateUniverse ( IUniverse  universe)
inline

Updates the IUniverse object being represented by this window.

Parameters
universeThe new IUniverse object. If it is the same object as the old one, cached values will be refreshed.

Event Documentation

◆ ExecuteCommand

Action<IUndoCommand> AlphaFramework.Editor.World.Dialogs.MapPropertiesTool.ExecuteCommand

Occurs when a command is to be executed by the owning tab.


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