mirror of
https://github.com/OpenMW/openmw.git
synced 2025-06-20 21:41:35 +00:00
Add documentation.
This commit is contained in:
parent
11eae16645
commit
6d7a24224b
2 changed files with 19 additions and 2 deletions
|
@ -147,7 +147,8 @@ namespace CSMTools
|
||||||
///< Messages resulting from this stage will be appended to \a messages.
|
///< Messages resulting from this stage will be appended to \a messages.
|
||||||
};
|
};
|
||||||
|
|
||||||
/// Flattens the added land and land texture records.
|
/// During this stage, the complex process of combining LandTextures from
|
||||||
|
/// potentially multiple plugins is undertaken.
|
||||||
class FixLandsAndLandTexturesMergeStage : public CSMDoc::Stage
|
class FixLandsAndLandTexturesMergeStage : public CSMDoc::Stage
|
||||||
{
|
{
|
||||||
MergeState& mState;
|
MergeState& mState;
|
||||||
|
@ -163,7 +164,8 @@ namespace CSMTools
|
||||||
///< Messages resulting from this stage will be appended to \a messages.
|
///< Messages resulting from this stage will be appended to \a messages.
|
||||||
};
|
};
|
||||||
|
|
||||||
// Removes base LandTexture records.
|
/// Removes base LandTexture records. This gets rid of the base records previously
|
||||||
|
/// needed in FixLandsAndLandTexturesMergeStage.
|
||||||
class CleanupLandTexturesMergeStage : public CSMDoc::Stage
|
class CleanupLandTexturesMergeStage : public CSMDoc::Stage
|
||||||
{
|
{
|
||||||
MergeState& mState;
|
MergeState& mState;
|
||||||
|
|
|
@ -44,6 +44,15 @@ namespace CSMWorld
|
||||||
bool mChanged;
|
bool mChanged;
|
||||||
};
|
};
|
||||||
|
|
||||||
|
/// \brief Adds LandTexture records and modifies texture indices as needed.
|
||||||
|
///
|
||||||
|
/// LandTexture records are different from other types of records, because
|
||||||
|
/// they only effect the current plugin. Thus, when modifying or copying
|
||||||
|
/// a Land record, all of the LandTexture records referenced need to be
|
||||||
|
/// added to the current plugin. Since these newly added LandTextures could
|
||||||
|
/// have indices that conflict with pre-existing LandTextures in the current
|
||||||
|
/// plugin, the indices might have to be changed, both for the newly added
|
||||||
|
/// LandRecord and within the Land record.
|
||||||
class ImportLandTexturesCommand : public QUndoCommand
|
class ImportLandTexturesCommand : public QUndoCommand
|
||||||
{
|
{
|
||||||
public:
|
public:
|
||||||
|
@ -71,6 +80,9 @@ namespace CSMWorld
|
||||||
std::vector<std::string> mCreatedTextures;
|
std::vector<std::string> mCreatedTextures;
|
||||||
};
|
};
|
||||||
|
|
||||||
|
/// \brief This command is used to fix LandTexture records and texture
|
||||||
|
/// indices after cloning a Land. See ImportLandTexturesCommand for
|
||||||
|
/// details.
|
||||||
class CopyLandTexturesCommand : public ImportLandTexturesCommand
|
class CopyLandTexturesCommand : public ImportLandTexturesCommand
|
||||||
{
|
{
|
||||||
public:
|
public:
|
||||||
|
@ -90,6 +102,9 @@ namespace CSMWorld
|
||||||
std::string mDestId;
|
std::string mDestId;
|
||||||
};
|
};
|
||||||
|
|
||||||
|
/// \brief This command brings a land record into the current plugin, adding
|
||||||
|
/// LandTexture records and modifying texture indices as needed.
|
||||||
|
/// \note See ImportLandTextures for more details.
|
||||||
class TouchLandCommand : public ImportLandTexturesCommand
|
class TouchLandCommand : public ImportLandTexturesCommand
|
||||||
{
|
{
|
||||||
public:
|
public:
|
||||||
|
|
Loading…
Reference in a new issue