Document.Document Class Reference
Detailed Description
Document is the base storage class for documents during a session.
At this level, it simply stores filename, format and version, with a list of supported features.
Derived classes would define their specific feature sets.
#include <class_document_1_1_document.h>
Public Member Functions |
|
| __init__ () | |
| version () | |
|
Document keeps the version of the application. |
|
| cut () | |
|
Document keeps the cut of the application. |
|
| format () | |
|
Document keeps the format number of the scene file. |
|
| close () | |
| setFilename () | |
| getFilename () | |
| setIsFromZipArchive () | |
| Used to flag documents that were extracted
out of a zip archive. |
|
| isFromZipArchive () | |
| Indicates if this document was extracted out
of a zip archive. |
|
| setZipArchive () | |
| Save the filename of the original zip
archive. |
|
| getZipArchive () | |
| Get the filename of the original zip
archive. |
|
| setOriginalFilename () | |
| getOriginalFilename () | |
| getOriginalCompanionDir () | |
| Returns the associated companion directory,
if it exists. |
|
| excludeFromDefaultGeneration () | |
| Given a list of feature ids, excludes the
corresponding features from processing when calling
populateWithDefaults() or
repairWithDefaults(). |
|
| populateWithDefaults () | |
| Use the default IO generator to generate
defaults for all features in the feature set. |
|
| repairWithDefaults () | |
| Use the default IO generator to generate
defaults for all invalid features in the feature set. |
|
| generateDocumentID () | |
| setDocumentID () | |
| getDocumentID () | |
| Return the document ID #. |
|
| getCompanionDirectory () | |
| Returns a companion directory based on the
filename. |
|
| setStatus () | |
| hasStatus () | |
| setSource () | |
| getSource () | |
| clearSource () | |
| setSourceVersion () | |
| getSourceVersion () | |
Public Attributes |
|
| int | kDirty = 1 |
Member Function Documentation
| Document.Document.__init__ | ( | ) |
Reimplemented from Document.FeatureMixin.
Reimplemented in Document.DrawCacheDocument, Document.EnvironmentDocument, Document.EnvironmentHeaderDocument, Document.MaterialDocument, Document.SceneDocument, and Document.UserPreferenceDocument.
| Document.Document.version | ( | ) |
Document keeps the version of the application.
| Document.Document.cut | ( | ) |
Document keeps the cut of the application.
| Document.Document.format | ( | ) |
Document keeps the format number of the scene file.
| Document.Document.close | ( | ) |
| Document.Document.setFilename | ( | ) |
| Document.Document.getFilename | ( | ) |
| Document.Document.setIsFromZipArchive | ( | ) |
Used to flag documents that were extracted out of a zip archive.
| Document.Document.isFromZipArchive | ( | ) |
Indicates if this document was extracted out of a zip archive.
| Document.Document.setZipArchive | ( | ) |
Save the filename of the original zip archive.
| Document.Document.getZipArchive | ( | ) |
Get the filename of the original zip archive.
| Document.Document.setOriginalFilename | ( | ) |
| Document.Document.getOriginalFilename | ( | ) |
| Document.Document.getOriginalCompanionDir | ( | ) |
Returns the associated companion directory, if it exists.
If it does not exist, then None is returned. The companion directory is based on this document's original filename.
Reimplemented in Document.EnvironmentDocument.
| Document.Document.excludeFromDefaultGeneration | ( | ) |
Given a list of feature ids, excludes the corresponding features from processing when calling populateWithDefaults() or repairWithDefaults().
| Document.Document.populateWithDefaults | ( | ) |
Use the default IO generator to generate defaults for all features in the feature set.
| Document.Document.repairWithDefaults | ( | ) |
Use the default IO generator to generate defaults for all invalid features in the feature set.
| Document.Document.generateDocumentID | ( | ) |
Reimplemented in Document.SceneDocument.
| Document.Document.setDocumentID | ( | ) |
| Document.Document.getDocumentID | ( | ) |
Return the document ID #.
| Document.Document.getCompanionDirectory | ( | ) |
Returns a companion directory based on the filename.
If createIt is True, then the companion directory will be created if it does not already exist.
| Document.Document.setStatus | ( | ) |
| Document.Document.hasStatus | ( | ) |
| Document.Document.setSource | ( | ) |
| Document.Document.getSource | ( | ) |
| Document.Document.clearSource | ( | ) |
| Document.Document.setSourceVersion | ( | ) |
| Document.Document.getSourceVersion | ( | ) |
