pyffi :: spells :: nif :: fix :: SpellDelUnusedRoots :: Class SpellDelUnusedRoots
[hide private]
[frames] | no frames]

Class SpellDelUnusedRoots

source code

object --+        
         |        
     Spell --+    
             |    
      NifSpell --+
                 |
                SpellDelUnusedRoots

Remove root branches that shouldn't be root branches and are unused in the file such as NiProperty branches that are not properly parented.
Instance Methods [hide private]
bool
datainspect(self)
This is called after pyffi.object_models.FileFormat.Data.inspect has been called, and before pyffi.object_models.FileFormat.Data.read is called.
source code
bool
dataentry(self)
Called before all blocks are recursed.
source code

Inherited from NifSpell: inspectblocktype

Inherited from NifSpell (private): _datainspect

Inherited from Spell: __init__, branchentry, branchexit, branchinspect, dataexit, recurse

Inherited from Spell (private): _branchinspect

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Methods [hide private]

Inherited from Spell: get_toast_stream, toastentry, toastexit

Class Variables [hide private]
  SPELLNAME = 'fix_delunusedroots'
A str describing how to refer to the spell from the command line.
  READONLY = False
A bool which determines whether the spell is read only or not.

Inherited from Spell: changed, data, stream, toaster

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

datainspect(self)

source code 
This is called after pyffi.object_models.FileFormat.Data.inspect has been called, and before pyffi.object_models.FileFormat.Data.read is called. Override this function for customization.
Returns: bool
True if the file must be processed, False otherwise.
Overrides: Spell.datainspect
(inherited documentation)

dataentry(self)

source code 

Called before all blocks are recursed. The default implementation simply returns True. You can access the data via data, and unlike in the datainspect method, the full file has been processed at this stage.

Typically, you will override this function to perform a global operation on the file data.

Returns: bool
True if the children must be processed, False otherwise.
Overrides: Spell.dataentry
(inherited documentation)