StoryboardIO.XMLStoryboardReader Class Reference
#include
<class_storyboard_i_o_1_1_x_m_l_storyboard_reader.h>
Public Member Functions |
|
| getConverters () | |
| Override this method to supply feature data
converters. |
|
| to_v2011_02 () | |
| Set the start time for the items to zero.
|
|
| to_v2012_01 () | |
| Environments ids was saved as absolute
paths: C:
Files\Autodesk\Showcase2011\support\Environments\WhiteRoom\WhiteRoom.a3e
C: Documents Showcase 2011\Something\WhiteRoom\WhiteRoom.a3e
C:.a3e. |
|
| read () | |
| Override this method in derived classes.
|
|
Member Function Documentation
| StoryboardIO.XMLStoryboardReader.getConverters | ( | ) |
Override this method to supply feature data converters.
Return a tuple containing ( method, version ) pairs. The order in which you specify the pairs is important, that is the oldest converter must be listed first, and the most recent converter listed last.
The method must have the following signature:
def <some_name>( self, xmlData ): # Convert data to a particular version.
The version indicates when the data converter method is applied.
For example:
class YourFeatureReader( FeatureReader ):
def getConverters( self ): return ( ( self.convert_to_v2, theVersionManager[ VersionLabel.v2 ] ) , ( self.convert_to_v4, theVersionManager[ VersionLabel.v4 ] ) )
def convert_to_v2( self, xmlData ): # # Convert the given xml data to whatever is required # by version 2 of the application. # pass
def convert_to_v4( self, xmlData ): # # Convert the given xml data to whatever is required # by version 4 of the application. # # Note the convert_to_v2 converter will have already # been applied to the xmlData. # pass
Note that all necessary converters will be applied to bring the document data up to what's needed. That is if a version 1 file is opened then the v2 converter will be applied followed by the v4 converter. If a version 3 file is opened then only the v4 converter is applied. If a version 4 file is opened then no converters will need to be called.
Reimplemented from FeatureReader.FeatureReader.
| StoryboardIO.XMLStoryboardReader.to_v2011_02 | ( | ) |
Set the start time for the items to zero.
For shots, set it tp -1 since if there are more then one shot we will need to calculate their start times.
| StoryboardIO.XMLStoryboardReader.to_v2012_01 | ( | ) |
Environments ids was saved as absolute paths: C: Files\Autodesk\Showcase2011\support\Environments\WhiteRoom\WhiteRoom.a3e C: Documents Showcase 2011\Something\WhiteRoom\WhiteRoom.a3e C:.a3e.
We can convert the older library paths and companion directory to the proper format of relativePath + library
| StoryboardIO.XMLStoryboardReader.read | ( | ) |
Override this method in derived classes.
This method is responsible for populating the given document with the data provided in the given source. It should return True if the read was successful; False otherwise.
Reimplemented from FeatureReader.FeatureReader.
