EnvironmentModelIO.XMLEnvironmentModelReader Class Reference
Detailed Description
Still read by the ModelIO since it is in model section.
#include
<class_environment_model_i_o_1_1_x_m_l_environment_model_reader.h>
Public Member Functions |
|
| getConverters () | |
| Override this method to supply feature data
converters. |
|
| to_v2012_01 () | |
| The apf files of the following environments
have been changed in 2012: WhiteRoom.apf, BlackRoom.apf and
Photostudio.apf Therefore any environments that have been saved in
2011 and have one of these three environments in the scene, have
incorrect ModelIO
section with respect to its apf file saved in the library. |
|
| preRead () | |
| Override this method for doing any
processing before reading. |
|
Member Function Documentation
| EnvironmentModelIO.XMLEnvironmentModelReader.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 ModelIO.XMLModelReader.
| EnvironmentModelIO.XMLEnvironmentModelReader.to_v2012_01 | ( | ) |
The apf files of the following environments have been changed in 2012: WhiteRoom.apf, BlackRoom.apf and Photostudio.apf Therefore any environments that have been saved in 2011 and have one of these three environments in the scene, have incorrect ModelIO section with respect to its apf file saved in the library.
Note: we only need to convert files from Showcase 2011. Any ealier version is Ok because we were not saving the a3e file into the companion directory.
| EnvironmentModelIO.XMLEnvironmentModelReader.preRead | ( | ) |
Override this method for doing any processing before reading.
Typically, this should be used for re-mapping object ids, such as in the case where there is a name conflict with an object already in the document.
Reimplemented from ModelIO.XMLModelReader.
