AlphaFramework API  1.0.3
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events
Public Member Functions | Protected Member Functions | List of all members
AlphaFramework.Editor.Graphics.CpuParticleSystemEditor Class Reference

Allows a user to tweak the parameters for a CpuParticleSystem More...

Inheritance diagram for AlphaFramework.Editor.Graphics.CpuParticleSystemEditor:
AlphaFramework.Editor.Graphics.ParticleSystemEditor AlphaFramework.Editor.UndoCommandTab AlphaFramework.Editor.UndoTab< T > AlphaFramework.Editor.Tab

Public Member Functions

 CpuParticleSystemEditor (string filePath, bool overwrite)
 Creates a new CPU particle system editor. More...
 
- Public Member Functions inherited from AlphaFramework.Editor.UndoTab< T >
override void Undo ()
 Hook to undo the last change
 
override void Redo ()
 Hook to redo the last undone change
 
- Public Member Functions inherited from AlphaFramework.Editor.Tab
void Open (IToastProvider toastProvider)
 Opens the tab. More...
 
new void Hide ()
 Hides this tab (so that another can be brought to the foreground) More...
 
bool RequestClose ()
 Requests the tab to close, displaying warnings about unsaved data, etc. allowing the user to cancel. More...
 
bool SaveFile ()
 Saves the content of this tab to a file - error-handling included! More...
 
void Delete ()
 Delete the currently selected object in this tab More...
 

Protected Member Functions

override void OnInitialize ()
 Called on startup to load the content for this tab.
Exceptions
NotSupportedExceptionAn unsupported graphics card feature is used.
FileNotFoundExceptionA file could not be located.
IOExceptionThere was a problem reading a file.
UnauthorizedAccessExceptionRead access to a file was denied.
InvalidOperationExceptionThere was a problem inside the engine.
InvalidDataExceptionA file contained invalid data.

 
override void OnSaveFile ()
 Called when the content of this tab is to be saved to a file.
Exceptions
ArgumentExceptionThe file path is invalid.
NotSupportedExceptionThe file path is invalid.
IOExceptionThere was a problem writing a file.
UnauthorizedAccessExceptionWrite access to a file was denied.

 
override void OnUpdate ()
 Called on startup, content updates and tab switch to refresh any on-screen displays
 
override void Dispose (bool disposing)
 Clean up any resources being used. More...
 
- Protected Member Functions inherited from AlphaFramework.Editor.Graphics.ParticleSystemEditor
 ParticleSystemEditor ()
 
override void OnInitialize ()
 Called on startup to load the content for this tab. More...
 
override void Dispose (bool disposing)
 Clean up any resources being used. More...
 
- Protected Member Functions inherited from AlphaFramework.Editor.UndoCommandTab
 UndoCommandTab ()
 
void ExecuteCommand (IUndoCommand command)
 Executes a IUndoCommand using this tab's undo stack. More...
 
void ExecuteCommandSafe (IUndoCommand command)
 Executes a IUndoCommand and automatically displays message boxes for common exception types. More...
 
override void OnUndo ()
 Hook to undo the last change
 
override void OnRedo ()
 Hook to redo the last undone change
 
- Protected Member Functions inherited from AlphaFramework.Editor.UndoTab< T >
 UndoTab ()
 
override void OnSaveFile ()
 Called when the content of this tab is to be saved to a file.
Exceptions
ArgumentExceptionThe file path is invalid.
NotSupportedExceptionThe file path is invalid.
IOExceptionThere was a problem writing a file.
UnauthorizedAccessExceptionWrite access to a file was denied.

 
override void OnChange ()
 Mark the content of this tab as changed (needs to be saved)
 
- Protected Member Functions inherited from AlphaFramework.Editor.Tab
 Tab ()
 
void FocusDefaultControl ()
 Set the focus back to the default control on the tab More...
 
virtual void OnDelete ()
 Hook to delete the currently selected object in this tab More...
 
virtual void OnClose ()
 Called when the tab needs to shutdown and close More...
 
void ForceClose ()
 Forces the tab to close, displaying warnings about unsaved data, etc. but not allowing the user to cancel. More...
 

Additional Inherited Members

- Protected Attributes inherited from AlphaFramework.Editor.Graphics.ParticleSystemEditor
readonly TrackCamera Camera = new TrackCamera(50, 2000) {Radius = 400}
 The camera used by the presenter More...
 
OmegaEngine.RenderPanel renderPanel
 The panel used by the engine for rendering. More...
 
- Protected Attributes inherited from AlphaFramework.Editor.UndoTab< T >
readonly Button buttonUndo
 The undo button. More...
 
readonly Button buttonRedo
 The redo button. More...
 
readonly Stack< T > UndoBackups = new Stack<T>()
 Entries used by the undo-system to undo changes More...
 
readonly Stack< T > RedoBackups = new Stack<T>()
 Entries used by the undo-system to redo changes previously undone More...
 
- Protected Attributes inherited from AlphaFramework.Editor.Tab
bool _overwrite
 true if an existing file supposed to be overwritten when SaveFile is called. More...
 
string _fullPath
 The complete (rooted) path to load and/or save the file from/to More...
 
bool Changed
 True when unsaved changes to the content exist More...
 
IToastProvider ToastProvider
 Provides a surface for displaying toast messages to the user. More...
 
- Properties inherited from AlphaFramework.Editor.Tab
string NameUI [get, set]
 The user-friendly name of this editor More...
 
string FilePath [get, set]
 The path to the file in this editor More...
 
- Events inherited from AlphaFramework.Editor.Tab
EventHandler TabClosed
 Occurs after the tab was closed More...
 

Detailed Description

Allows a user to tweak the parameters for a CpuParticleSystem

Constructor & Destructor Documentation

AlphaFramework.Editor.Graphics.CpuParticleSystemEditor.CpuParticleSystemEditor ( string  filePath,
bool  overwrite 
)
inline

Creates a new CPU particle system editor.

Parameters
filePathThe path to the file to be edited.
overwritetrue if an existing file supposed to be overwritten when Tab.SaveFile is called.

Member Function Documentation

override void AlphaFramework.Editor.Graphics.CpuParticleSystemEditor.Dispose ( bool  disposing)
inlineprotected

Clean up any resources being used.

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

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