FeatureSet.Feature Class Reference
Detailed Description
A feature defines a functional area in an application.
It is added to a Document via a FeatureSet, and essentially defines what data the Document can contain. A feature has an:
- id
- container class
- a set of features that it depends on
The id uniquely identifies the feature, and allows one to:
- create dependencies between features, and
- retrieve its container object from a Document that has the feature.
The container class is a data structure instantiated when a feature is added to a document. It is this instantiated object that the application operates on. The container class' interface should be designed in such a way as to make it easy to retrieve and manipulate its contained data. It should not contain or reference any IO specific functionality.
The dependencies define the features on which this feature depends. For example, if FEATURE_2 depends on FEATURE_1, creating a dependency of FEATURE_2 on FEATURE_1 will ensure that FEATURE_1 is loaded and saved prior to loading and saving FEATURE_2. Be careful not to create any circular dependencies!
A feature is meant to be modular, meaning that a given feature can be added to several different document types. For example, a feature, MaterialPaths, may define the search paths used to find material definitions. Two document types, MaterialDocument, and SceneDocument, may need material search paths, thus both of these document types should include the MaterialPaths feature.
#include
<class_feature_set_1_1_feature.h>
Public Member Functions |
|
| __init__ () | |
| id () | |
| dependencies () | |
| containerType () | |
| defaultGenerator () | |
Member Function Documentation
| FeatureSet.Feature.__init__ | ( | ) |
| FeatureSet.Feature.id | ( | ) |
| FeatureSet.Feature.dependencies | ( | ) |
| FeatureSet.Feature.containerType | ( | ) |
| FeatureSet.Feature.defaultGenerator | ( | ) |
