pyffi :: spells :: nif :: modify :: _SpellDelBranchClasses :: Class _SpellDelBranchClasses
[hide private]
[frames] | no frames]

Class _SpellDelBranchClasses

source code

object --+            
         |            
     Spell --+        
             |        
      NifSpell --+    
                 |    
  SpellDelBranches --+
                     |
                    _SpellDelBranchClasses
Known Subclasses:

Delete blocks that match a given list. Only useful as base class for other spells.
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
 
is_branch_to_be_deleted(self, branch)
Returns True for those branches that must be deleted.
source code

Inherited from SpellDelBranches: branchentry

Inherited from SpellDelBranches (private): _branchinspect

Inherited from NifSpell: inspectblocktype

Inherited from NifSpell (private): _datainspect

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

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]
  BRANCH_CLASSES_TO_BE_DELETED = ()
List of branch classes that have to be deleted.

Inherited from SpellDelBranches: READONLY, SPELLNAME

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)

is_branch_to_be_deleted(self, branch)

source code 
Returns True for those branches that must be deleted. The default implementation returns True for branches that are not admissible as specified by include/exclude options of the toaster. Override in subclasses that must delete specific branches.
Overrides: SpellDelBranches.is_branch_to_be_deleted
(inherited documentation)