BrawlCrate.NodeWrappers.GenericWrapper Class Reference

Inheritance diagram for BrawlCrate.NodeWrappers.GenericWrapper:

Public Member Functions
	GenericWrapper (IWin32Window owner)
	GenericWrapper ()
virtual void	Sort ()
void	MoveUp ()
virtual void	MoveUp (bool select)
void	MoveDown ()
virtual void	MoveDown (bool select)
void	DeleteSelected ()
void	ExportSelected ()
virtual string	Export ()
virtual void	OnExport (string outPath)
virtual void	Replace ()
virtual void	OnReplace (string inStream)
void	Restore ()
virtual void	Delete ()
void	Rename ()
virtual ResourceNode	Duplicate ()
virtual ResourceNode	Duplicate (bool changeName)
Public Member Functions inherited from BrawlCrate.NodeWrappers.BaseWrapper
void	Link (ResourceNode res)
void	Unlink ()

Static Protected Member Functions
static void	MoveUpAction (object sender, EventArgs e)
static void	MoveDownAction (object sender, EventArgs e)
static void	ExportAction (object sender, EventArgs e)
static void	ExportSelectedAction (object sender, EventArgs e)
static void	DeleteSelectedAction (object sender, EventArgs e)
static void	DuplicateAction (object sender, EventArgs e)
static void	ReplaceAction (object sender, EventArgs e)
static void	RestoreAction (object sender, EventArgs e)
static void	DeleteAction (object sender, EventArgs e)
static void	RenameAction (object sender, EventArgs e)
static void	SortAction (object sender, EventArgs e)
Static Protected Member Functions inherited from BrawlCrate.NodeWrappers.BaseWrapper
static T	GetInstance< T > ()
static IEnumerable< T >	GetInstances< T > ()

Properties
virtual ContextMenuStrip	MultiSelectMenuStrip [get]
virtual string	DefaultName [get]
virtual string	ExportFilter [get]
virtual string	ImportFilter [get]
virtual string	ReplaceFilter [get]
Properties inherited from BrawlCrate.NodeWrappers.BaseWrapper
ResourceNode	Resource [get]
virtual ? Color	DefaultBackColor [get]
virtual ? Color	DefaultForeColor [get]
Properties inherited from BrawlCrate.NodeWrappers.MultiSelectableWrapper
ContextMenuStrip	MultiSelectMenuStrip [get]

Additional Inherited Members
Static Public Member Functions inherited from BrawlCrate.NodeWrappers.BaseWrapper
static BaseWrapper[]	GetAllNodes (BaseWrapper root)
static BaseWrapper	Wrap (ResourceNode node)
static BaseWrapper	Wrap (IWin32Window owner, ResourceNode node)
Static Public Attributes inherited from BrawlCrate.NodeWrappers.BaseWrapper
static IWin32Window	_owner
Protected Member Functions inherited from BrawlCrate.NodeWrappers.BaseWrapper
	BaseWrapper ()
Protected Attributes inherited from BrawlCrate.NodeWrappers.BaseWrapper
bool	_discovered
ResourceNode	_resource
Static Protected Attributes inherited from BrawlCrate.NodeWrappers.BaseWrapper
static readonly ContextMenuStrip	_emptyMenu = new ContextMenuStrip()

Constructor & Destructor Documentation

GenericWrapper() [1/2]

BrawlCrate.NodeWrappers.GenericWrapper.GenericWrapper ( IWin32Window  owner )

inline

        {
            _owner = owner;
            ContextMenuStrip = _menu;
        }

GenericWrapper() [2/2]

BrawlCrate.NodeWrappers.GenericWrapper.GenericWrapper ( )

inline

        {
            _owner = null;
            ContextMenuStrip = _menu;
        }

Member Function Documentation

Delete()

virtual void BrawlCrate.NodeWrappers.GenericWrapper.Delete ( )

inlinevirtual

Reimplemented in BrawlCrate.NodeWrappers.FolderWrapper.

        {
            if (Parent == null)
            {
                return;
            }
 
            _resource.Dispose();
            _resource.Remove();
        }

DeleteAction()

static void BrawlCrate.NodeWrappers.GenericWrapper.DeleteAction ( object  sender, EventArgs  e  )

inlinestaticprotected

        {
            GetInstance<GenericWrapper>().Delete();
        }

DeleteSelected()

void BrawlCrate.NodeWrappers.GenericWrapper.DeleteSelected ( )

inline

        {
            while (MainForm.Instance.resourceTree.SelectedNodes.Count > 0)
            {
                if (!(MainForm.Instance.resourceTree.SelectedNodes[0] is GenericWrapper g))
                {
                    break;
                }
 
                MainForm.Instance.resourceTree.SelectedNodes.RemoveAt(0);
                g.Delete();
            }
        }

DeleteSelectedAction()

static void BrawlCrate.NodeWrappers.GenericWrapper.DeleteSelectedAction ( object  sender, EventArgs  e  )

inlinestaticprotected

        {
            GetInstance<GenericWrapper>().DeleteSelected();
        }

Duplicate() [1/2]

virtual ResourceNode BrawlCrate.NodeWrappers.GenericWrapper.Duplicate ( )

inlinevirtual

Reimplemented in BrawlCrate.NodeWrappers.PAT0EntryWrapper, BrawlCrate.NodeWrappers.PAT0TextureWrapper, BrawlCrate.NodeWrappers.PAT0TextureEntryWrapper, BrawlCrate.NodeWrappers.RedirectWrapper, BrawlCrate.NodeWrappers.CollisionObjectWrapper, BrawlCrate.NodeWrappers.MDL0MaterialWrapper, BrawlCrate.NodeWrappers.MDL0MaterialRefWrapper, and BrawlCrate.NodeWrappers.MDL0PolygonWrapper.

        {
            return Duplicate(true);
        }

Duplicate() [2/2]

virtual ResourceNode BrawlCrate.NodeWrappers.GenericWrapper.Duplicate ( bool  changeName )

inlinevirtual

Reimplemented in BrawlCrate.NodeWrappers.MDL0BoneWrapper, and BrawlCrate.NodeWrappers.MDL0EntryWrapper.

        {
            if (_resource.Parent == null)
            {
                return null;
            }
 
            string tempPath = Path.GetTempFileName();
            _resource.Export(tempPath);
            // Initialize node as a child of the parent
            ResourceNode rNode2 = NodeFactory.FromFile(_resource is ARCEntryNode ? null : _resource.Parent, tempPath,
                _resource.GetType());
 
            if (rNode2 == null)
            {
                MessageBox.Show("The node could not be duplicated correctly.", "Error", MessageBoxButtons.OK,
                    MessageBoxIcon.Error);
                return null;
            }
            rNode2._name = "";
 
            // Remove the node from the parent temporarily
            rNode2.Remove();
 
            // Copy ARCEntryNode data, which is contained in the containing ARC, not the node itself
            if (rNode2 is ARCEntryNode node)
            {
                node.FileIndex = ((ARCEntryNode) _resource).FileIndex;
                node.FileType = ((ARCEntryNode) _resource).FileType;
                node.GroupID = ((ARCEntryNode) _resource).GroupID;
            }
 
            // Copy the name directly in cases where name isn't saved
            rNode2.Name = _resource.Name;
            // Set the name programatically (based on Windows' implementation)
            int index = _resource.Index;
            int n = 0;
            if (changeName)
            {
                while (_resource.Parent.FindChildrenByName(rNode2.Name).Length >= 1)
                {
                    // Get the last index of the last duplicated node in order to place it after that one
                    index = Math.Max(index, _resource.Parent.FindChildrenByName(rNode2.Name).Last().Index);
                    // Set the name based on the number of duplicate nodes found
                    rNode2.Name = $"{_resource.Name} ({++n})";
                }
            }
 
            // Place the node in the same containing parent, after the last duplicated node.
            _resource.Parent.InsertChild(rNode2, true, index + 1);
 
            // Copy redirect info as necessary
            if (rNode2 is ARCEntryNode entryNode)
            {
                entryNode.RedirectIndex = ((ARCEntryNode) _resource).RedirectIndex;
            }
 
            // Update name again in order to refresh things that need refreshing when name is updated
            rNode2.OnRenamed();
 
            return rNode2;
        }

DuplicateAction()

static void BrawlCrate.NodeWrappers.GenericWrapper.DuplicateAction ( object  sender, EventArgs  e  )

inlinestaticprotected

        {
            GetInstance<GenericWrapper>().Duplicate();
        }

Export()

virtual string BrawlCrate.NodeWrappers.GenericWrapper.Export ( )

inlinevirtual

Reimplemented in BrawlCrate.NodeWrappers.FolderWrapper.

        {
            if (Program.SaveFile(ExportFilter, DefaultName, out string outPath))
            {
                if (Parent == null)
                {
                    _resource.Merge(Control.ModifierKeys == (Keys.Control | Keys.Shift));
                }
 
                OnExport(outPath);
            }
 
            return outPath;
        }

ExportAction()

static void BrawlCrate.NodeWrappers.GenericWrapper.ExportAction ( object  sender, EventArgs  e  )

inlinestaticprotected

        {
            GetInstance<GenericWrapper>().Export();
        }

ExportSelected()

void BrawlCrate.NodeWrappers.GenericWrapper.ExportSelected ( )

inline

        {
            string folder = Program.ChooseFolder();
            if (string.IsNullOrEmpty(folder))
            {
                return;
            }
 
            Dictionary<Type, string> extensions = new Dictionary<Type, string>();
            List<GenericWrapper> nodes = new List<GenericWrapper>();
            foreach (TreeNode tNode in MainForm.Instance.resourceTree.SelectedNodes)
            {
                if (tNode is GenericWrapper g)
                {
                    nodes.Add(g);
                    if (!extensions.ContainsKey(g._resource.GetType()))
                    {
                        extensions.Add(g._resource.GetType(), g.ExportFilter);
                    }
                }
            }
 
            Dictionary<Type, string> chosenExtensions = new Dictionary<Type, string>();
            foreach (KeyValuePair<Type, string> ext in extensions)
            {
                ExportAllFormatDialog dialog = new ExportAllFormatDialog("Export Selected", ext.Key, ext.Value);
 
                DialogResult? d = null;
                if (dialog.AutoSelect || dialog.Valid && (d = dialog.ShowDialog()) == DialogResult.OK)
                {
                    chosenExtensions.Add(ext.Key, dialog.SelectedExtension);
                }
                else if (d != null)
                {
                    return;
                }
            }
 
            string invalidChars = Regex.Escape(new string(Path.GetInvalidFileNameChars()));
            string invalidRegStr = string.Format(@"([{0}]*\.+$)|([{0}]+)", invalidChars);
            foreach (GenericWrapper n in nodes)
            {
                chosenExtensions.TryGetValue(n._resource.GetType(), out string ext);
                if (!string.IsNullOrEmpty(ext) && !ext.StartsWith("."))
                {
                    ext = ext.Insert(0, ".");
                }
 
                n.OnExport($"{folder}\\{Regex.Replace($"{n.DefaultName}{ext ?? ""}", invalidRegStr, "")}");
            }
 
            MessageBox.Show($"{nodes.Count} nodes successfully exported to {folder}", "Export Selected");
        }

ExportSelectedAction()

static void BrawlCrate.NodeWrappers.GenericWrapper.ExportSelectedAction ( object  sender, EventArgs  e  )

inlinestaticprotected

        {
            GetInstance<GenericWrapper>().ExportSelected();
        }

MoveDown() [1/2]

void BrawlCrate.NodeWrappers.GenericWrapper.MoveDown ( )

inline

        {
            MoveDown(true);
        }

MoveDown() [2/2]

virtual void BrawlCrate.NodeWrappers.GenericWrapper.MoveDown ( bool  select )

inlinevirtual

Reimplemented in BrawlCrate.NodeWrappers.MDL0ShaderWrapper, and BrawlCrate.NodeWrappers.TEVStageWrapper.

        {
            if (NextVisibleNode == null)
            {
                return;
            }
 
            if (_resource.MoveDown())
            {
                int index = Index + 1;
                TreeNode parent = Parent;
                TreeView.BeginUpdate();
                Remove();
                parent.Nodes.Insert(index, this);
                _resource.OnMoved();
                if (select)
                {
                    TreeView.SelectedNode = this;
                }
 
                TreeView.EndUpdate();
            }
        }

MoveDownAction()

static void BrawlCrate.NodeWrappers.GenericWrapper.MoveDownAction ( object  sender, EventArgs  e  )

inlinestaticprotected

        {
            GetInstance<GenericWrapper>().MoveDown();
        }

MoveUp() [1/2]

void BrawlCrate.NodeWrappers.GenericWrapper.MoveUp ( )

inline

        {
            MoveUp(true);
        }

MoveUp() [2/2]

virtual void BrawlCrate.NodeWrappers.GenericWrapper.MoveUp ( bool  select )

inlinevirtual

Reimplemented in BrawlCrate.NodeWrappers.MDL0ShaderWrapper, and BrawlCrate.NodeWrappers.TEVStageWrapper.

        {
            if (PrevVisibleNode == null)
            {
                return;
            }
 
            if (_resource.MoveUp())
            {
                int index = Index - 1;
                TreeNode parent = Parent;
                TreeView.BeginUpdate();
                Remove();
                parent.Nodes.Insert(index, this);
                _resource.OnMoved();
                if (select)
                {
                    TreeView.SelectedNode = this;
                }
 
                TreeView.EndUpdate();
            }
        }

MoveUpAction()

static void BrawlCrate.NodeWrappers.GenericWrapper.MoveUpAction ( object  sender, EventArgs  e  )

inlinestaticprotected

        {
            GetInstance<GenericWrapper>().MoveUp();
        }

OnExport()

virtual void BrawlCrate.NodeWrappers.GenericWrapper.OnExport ( string  outPath )

inlinevirtual

Reimplemented in BrawlCrate.NodeWrappers.U8Wrapper.

        {
            _resource.Export(outPath);
        }

OnReplace()

virtual void BrawlCrate.NodeWrappers.GenericWrapper.OnReplace ( string  inStream )

inlinevirtual

Reimplemented in BrawlCrate.NodeWrappers.REFTImageWrapper, BrawlCrate.NodeWrappers.TEX0Wrapper, and BrawlCrate.NodeWrappers.TPLTextureNodeWrapper.

        {
            _resource.Replace(inStream);
        }

Rename()

void BrawlCrate.NodeWrappers.GenericWrapper.Rename ( )

inline

        {
            using (RenameDialog dlg = new RenameDialog())
            {
                dlg.ShowDialog(MainForm.Instance, _resource);
            }
        }

RenameAction()

static void BrawlCrate.NodeWrappers.GenericWrapper.RenameAction ( object  sender, EventArgs  e  )

inlinestaticprotected

        {
            GetInstance<GenericWrapper>().Rename();
        }

Replace()

virtual void BrawlCrate.NodeWrappers.GenericWrapper.Replace ( )

inlinevirtual

        {
            if (Parent == null)
            {
                return;
            }
 
            if (Program.OpenFile(ReplaceFilter, out string inPath))
            {
                OnReplace(inPath);
                Link(_resource);
            }
        }

ReplaceAction()

static void BrawlCrate.NodeWrappers.GenericWrapper.ReplaceAction ( object  sender, EventArgs  e  )

inlinestaticprotected

        {
            GetInstance<GenericWrapper>().Replace();
        }

Restore()

void BrawlCrate.NodeWrappers.GenericWrapper.Restore ( )

inline

        {
            _resource.Restore();
        }

RestoreAction()

static void BrawlCrate.NodeWrappers.GenericWrapper.RestoreAction ( object  sender, EventArgs  e  )

inlinestaticprotected

        {
            GetInstance<GenericWrapper>().Restore();
        }

Sort()

virtual void BrawlCrate.NodeWrappers.GenericWrapper.Sort ( )

inlinevirtual

        {
            _resource.SortChildren();
            RefreshView(_resource);
        }

SortAction()

static void BrawlCrate.NodeWrappers.GenericWrapper.SortAction ( object  sender, EventArgs  e  )

inlinestaticprotected

        {
            GetInstance<GenericWrapper>().Sort();
        }

Property Documentation

DefaultName

virtual string BrawlCrate.NodeWrappers.GenericWrapper.DefaultName

get

ExportFilter

virtual string BrawlCrate.NodeWrappers.GenericWrapper.ExportFilter

get

ImportFilter

virtual string BrawlCrate.NodeWrappers.GenericWrapper.ImportFilter

get

MultiSelectMenuStrip

virtual ContextMenuStrip BrawlCrate.NodeWrappers.GenericWrapper.MultiSelectMenuStrip

get

Implements BrawlCrate.NodeWrappers.MultiSelectableWrapper.

ReplaceFilter

virtual string BrawlCrate.NodeWrappers.GenericWrapper.ReplaceFilter

get

---

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

• BrawlCrate/NodeWrappers/GenericWrapper.cs