FeatureWriter.FeatureWriter Class Reference
Detailed Description
FeatureWriter is used for writing the data of a particular feature.
A new class must be derived for each feature that requires writing, and furthermore, the write() method must be implemented. Any pre- processing should be done in preWrite(), and any post-processing in postWrite().
#include
<class_feature_writer_1_1_feature_writer.h>
Public Member Functions |
|
| __init__ () | |
| writeSource () | |
| Override this method in derived classes.
|
|
| write () | |
| Override this method in derived classes.
|
|
| preWrite () | |
| Override this method for doing any
processing before writing. |
|
| postWrite () | |
| Override this method for doing any
processing after writing. |
|
| setTargetFilename () | |
| Sets the filename of the target. |
|
| getTargetFilename () | |
| Returns the filename of the target. |
|
| setSearchPaths () | |
| Sets the search paths for this feature.
|
|
| getSearchPaths () | |
| Returns the search paths. |
|
| unqualifyPath () | |
| Given a path, returns a path relative to the
first search path to which it is relative. |
|
| setOptions () | |
| Sets the write options for this reader.
|
|
| getOptions () | |
| Returns the currently used write options.
|
|
| setFinalIdMaps () | |
| Sets the maps from which one can find and
store the final ids of objects that were remapped. |
|
| getFinalIdMapsObject () | |
| Gets the maps from which one can find and
store the final ids of objects that were remapped. |
|
| isFinalId () | |
| Returns True if the given object id relevant
to the given feature, is the final id; False otherwise. |
|
| getFinalId () | |
| Returns the final id for the given object
id, relevant to the given feature. |
|
| setFinalId () | |
| Sets the final object id to the given object
id for the feature for which this reader is responsible. |
|
| includeNodeInExport () | |
| setCompactSaveOptions () | |
| getCompactSaveOptions () | |
Member Function Documentation
| FeatureWriter.FeatureWriter.__init__ | ( | ) |
| FeatureWriter.FeatureWriter.writeSource | ( | ) |
Override this method in derived classes.
This method is responsible for writing out the source for this feature. It should return True if the write was successful; False otherwise.
Reimplemented in EnvironmentHeaderIO.XMLEnvironmentHeaderWriter, EnvironmentMaterialIO.XMLEnvironmentMaterialWriter, EnvironmentModelIO.XMLEnvironmentModelWriter, LightingIO.XMLLightingWriter, MaterialAssignmentIO.XMLMaterialAssignmentWriter, and ShadowIO.XMLShadowWriter.
| FeatureWriter.FeatureWriter.write | ( | ) |
Override this method in derived classes.
This method is responsible for writing the feature's data (stored in the document), into the provided output. It should return True if the write was successful; False otherwise.
Reimplemented in AlternativeIO.XMLAlternativeWriter, BackgroundIO.XMLBackgroundWriter, BookmarkIO.XMLBookmarkWriter, CalibrationPreferenceIO.XMLCalibrationPreferenceWriter, ClusterPreferenceIO.XMLClusterPreferenceWriter, CustomUIIO.XMLCustomUIWriter, EnvironmentHeaderIO.XMLEnvironmentHeaderWriter, EnvironmentPreferenceIO.XMLEnvironmentPreferenceWriter, HotkeyIO.XMLHotkeyWriter, ImportSettingsIO.XMLImportSettingsWriter, LightAssignmentIO.XMLLightAssignmentWriter, LightingIO.XMLLightingWriter, MaterialAssignmentIO.XMLMaterialAssignmentWriter, MaterialIO.XMLMaterialWriter, MaterialLibraryIO.XMLMaterialLibraryWriter, MetaDataIO.XMLMetaDataWriter, ModelIO.XMLModelWriter, ModelImportIO.XMLModelImportWriter, NavigationIO.XMLNavigationWriter, NetworkPreferenceIO.XMLNetworkPreferenceWriter, ObjectAssociationsIO.XMLObjectAssociationsWriter, ObjectPropertiesIO.XMLObjectPropertiesWriter, OptionPreferenceIO.XMLOptionPreferenceWriter, PathListPreferenceIO.XMLBehaviorDirectoryPreferenceWriter, PathListPreferenceIO.XMLEnvironmentDirectoryPreferenceWriter, PathListPreferenceIO.XMLEnvironmentGeometryDirectoryPreferenceWriter, PathListPreferenceIO.XMLHelpDirectoryPreferenceWriter, PathListPreferenceIO.XMLImageDirectoryPreferenceWriter, PathListPreferenceIO.XMLMaterialDirectoryPreferenceWriter, PathListPreferenceIO.XMLRapidPresetsDirectoryPreferenceWriter, PathListPreferenceIO.XMLSceneHistoryDirectoryPreferenceWriter, PathListPreferenceIO.XMLShadowPresetsDirectoryPreferenceWriter, PathListPreferenceIO.XMLTessellationDirectoryPreferenceWriter, PathListPreferenceIO.XMLWelcomeDirectoryPreferenceWriter, ScenePreferenceIO.XMLScenePreferenceWriter, SelectionSetIO.XMLSelectionSetWriter, ShadowIO.XMLShadowWriter, ShotIO.XMLShotWriter, StoryboardIO.XMLStoryboardWriter, TranslationIO.XMLTranslationWriter, TriggerIO.XMLTriggerWriter, UiPrefsIO.XMLUiPrefsWriter, and WindowPreferenceIO.XMLWindowPreferenceWriter.
| FeatureWriter.FeatureWriter.preWrite | ( | ) |
Override this method for doing any processing before writing.
Reimplemented in ModelIO.XMLModelWriter, and ModelImportIO.XMLModelImportWriter.
| FeatureWriter.FeatureWriter.postWrite | ( | ) |
Override this method for doing any processing after writing.
Reimplemented in AlternativeIO.XMLAlternativeWriter, EnvironmentHeaderIO.XMLEnvironmentHeaderWriter, EnvironmentMaterialIO.XMLEnvironmentMaterialWriter, EnvironmentModelIO.XMLEnvironmentModelWriter, LightingIO.XMLLightingWriter, MaterialIO.XMLMaterialWriter, ModelIO.XMLModelWriter, ModelImportIO.XMLModelImportWriter, ObjectPropertiesIO.XMLObjectPropertiesWriter, and ShotIO.XMLShotWriter.
| FeatureWriter.FeatureWriter.setTargetFilename | ( | ) |
Sets the filename of the target.
| FeatureWriter.FeatureWriter.getTargetFilename | ( | ) |
Returns the filename of the target.
| FeatureWriter.FeatureWriter.setSearchPaths | ( | ) |
Sets the search paths for this feature.
Invalid search paths are ignored.
| FeatureWriter.FeatureWriter.getSearchPaths | ( | ) |
Returns the search paths.
| FeatureWriter.FeatureWriter.unqualifyPath | ( | ) |
Given a path, returns a path relative to the first search path to which it is relative.
If it is not relative to any of the search paths, then the original path is returned.
Reimplemented in CompanionFeatureIO.CompanionFeatureWriter.
| FeatureWriter.FeatureWriter.setOptions | ( | ) |
Sets the write options for this reader.
| FeatureWriter.FeatureWriter.getOptions | ( | ) |
Returns the currently used write options.
| FeatureWriter.FeatureWriter.setFinalIdMaps | ( | ) |
Sets the maps from which one can find and store the final ids of objects that were remapped.
| FeatureWriter.FeatureWriter.getFinalIdMapsObject | ( | ) |
Gets the maps from which one can find and store the final ids of objects that were remapped.
| FeatureWriter.FeatureWriter.isFinalId | ( | ) |
Returns True if the given object id relevant to the given feature, is the final id; False otherwise.
| FeatureWriter.FeatureWriter.getFinalId | ( | ) |
Returns the final id for the given object id, relevant to the given feature.
Note, be sure to call isFinalId(), and that it returns False before calling this method.
| FeatureWriter.FeatureWriter.setFinalId | ( | ) |
Sets the final object id to the given object id for the feature for which this reader is responsible.
| FeatureWriter.FeatureWriter.includeNodeInExport | ( | ) |
| FeatureWriter.FeatureWriter.setCompactSaveOptions | ( | ) |
| FeatureWriter.FeatureWriter.getCompactSaveOptions | ( | ) |
