ObjectPropertiesIO.XMLObjectPropertiesReader Class Reference
Detailed Description
XML reader for the ObjectProperties feature.
#include
<class_object_properties_i_o_1_1_x_m_l_object_properties_reader.h>
Public Member Functions |
|
| getConverters () | |
| Override this method to supply feature data
converters. |
|
| to_v2012_00 () | |
| Check AO parameters in ObjectProperties and
set "AOType" to ScenePreference accordingly. |
|
| to_v2008_05 () | |
| Remove obsolete AO parameters. |
|
| preRead () | |
| Override this method for doing any
processing before reading. |
|
| read () | |
| Read the object properties into the
document, given the xml data. |
|
Member Function Documentation
| ObjectPropertiesIO.XMLObjectPropertiesReader.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.
| ObjectPropertiesIO.XMLObjectPropertiesReader.to_v2012_00 | ( | ) |
Check AO parameters in ObjectProperties and set "AOType" to ScenePreference accordingly.
"AOType" will be set to kBakedAO if that exists, otherwise it will be set to kSSAO.
| ObjectPropertiesIO.XMLObjectPropertiesReader.to_v2008_05 | ( | ) |
Remove obsolete AO parameters.
| ObjectPropertiesIO.XMLObjectPropertiesReader.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 FeatureReader.FeatureReader.
| ObjectPropertiesIO.XMLObjectPropertiesReader.read | ( | ) |
Read the object properties into the document, given the xml data.
Reimplemented from FeatureReader.FeatureReader.
