wc3lib  0.1.0
Namespaces | Classes | Enumerations | Functions
wc3lib::editor Namespace Reference

Editor module More...

Namespaces

 mapsettingseditor
 

Classes

class  AbilityData
 
class  AbilityEditor
 
class  AbilityTreeModel
 
class  AiEditor
 
class  ArchiveInfoDialog
 Information dialog for MPQ archives. More...
 
class  BlpCodec
 
class  BlpIOHandler
 
class  BlpIOPlugin
 
class  BlpTest
 
class  Brush
 
class  BuffData
 
class  BuffEditor
 
class  BuffTreeModel
 
class  CampaignEditor
 
class  CollisionShape
 
class  ColorPaletteDialog
 
class  DestructableData
 
class  DestructableEditor
 
class  DestructableTreeModel
 
class  DoodadData
 
class  DoodadEditor
 
class  DoodadTreeModel
 
class  Editor
 This class emulates the Warcraft III World Editor. It provides all necessary editor modules. More...
 
class  Environment
 
class  FileInfoDialog
 Information dialog for one single file entry of an MPQ archive. More...
 
class  ImportManager
 
class  ItemData
 
class  ItemEditor
 
class  ItemTreeModel
 
class  ListfilesDialog
 A simple dialog which allows you to select listfiles when openeing an MPQ archive. More...
 
class  Map
 
class  MapScriptWidget
 
class  MapStringsTextSource
 
class  MetaData
 Base class for all possible meta data formats (units, abilities, upgrades etc.). More...
 
class  MiscData
 Stores all data for custom and standard misc data. More...
 
class  MiscEditor
 
class  MiscTreeModel
 The concrete tree model for misc data. More...
 
class  ModelEditor
 
class  ModelEditorSettings
 
class  ModelEditorSettingsDialog
 
class  ModelEditorView
 
class  ModelView
 
class  ModelViewSettings
 
class  Module
 Abstract class for module implementation such as model or terrain editors. Implement the pure virtual member functions to customize your module's menu, actions and tool buttons. More...
 
class  ModuleMenu
 
class  ModuleToolBar
 
class  MpqEditor
 Simple file editor which can handle multiple MPQ archives. More...
 
class  MpqPriorityList
 File source handling class which orders sources by their priorities to access files. More...
 
class  MpqPriorityListEntry
 Entry of an MPQ priority list. An entry can either be an archive or a URL of a directory. Each entry has its own priority. Entries with higher priority will be returned more likely than those with less priority. More...
 
class  MpqSlave
 KDE I/O slave for MPQ archives. More...
 
class  MpqTreeItem
 One single item of a MpqTreeModel which might represent a file, an archive or a folder. More...
 
class  MpqTreeModel
 Tree model for MPQ archives and corresponding files. More...
 
class  MpqTreeProxyModel
 Orders tree items by type and name which means that directories are listed before files. More...
 
class  NewMapDialog
 
class  ObjectData
 Unifies all meta, default and custom data of objects such as units, items, abilities etc. in one class and allows fast access by hashing. More...
 
class  ObjectEditor
 
class  ObjectEditorTab
 A single tab of the Object Editor which theoretically could be used as standalone application as well. It supports a specific set of predefined data and meta data (objectData()) and lists the standard objects by default. More...
 
class  ObjectIdDialog
 Simple line edit dialog to select an ID for a newly created object. More...
 
class  ObjectListDialog
 Dialog to select a list of objects or literal values. More...
 
class  ObjectManager
 
class  ObjectTableModel
 
class  ObjectTableView
 Table view of the object editor which lists all values of the currently selected object. More...
 
class  ObjectTreeItem
 An item representing one single object or folder in a tree model. More...
 
class  ObjectTreeModel
 Abstract tree model for object data. More...
 
class  ObjectTreeSortFilterProxyModel
 This sort filter proxy model allows to filter an object tree model for a certain expression. The default QSortFilterProxyModel does not support filtering trees properly. For example if the filter expression matches a child item of another item if the parent item does not match nothing will be shown. This class passes filter expressions down for folder items in the tree model and looks for matching child items. If at least one child item of a folder item matches, it won't be hidden. More...
 
class  ObjectTreeView
 A tree view for a list of standard and custom objects. More...
 
class  ObjectValueDialog
 GUI dialog which allows selection of an field value for a specific object. More...
 
class  OgreEnvironment
 Combines wc3lib::map::Environment and OGRE's terrain system to provide a 3D rendering of a Warcraft's map environment. More...
 
class  OgreMdlx
 This class can be used to display MDLX models by using the OGRE 3D rendering engine. It maintains multiple mesh instances which contains all converted data of the original MDLX model's geosets. More...
 
class  OgreMdlxEntity
 
class  PolygonModeComboBox
 
class  RenderStatsWidget
 
class  RenderSystemSettings
 
class  Resource
 Abstract base class for all kind of resources. Provides virtual load, reload and save member functions and dynamic type information. Besides each resource has its corresponding file URL and data source which makes all resource instance completly independent from each other. Resources depend on MpqPriorityList instances, called sources, when being loaded or saved. Therefore one single source instance can be assigned to each resource. More...
 
class  ResourcesDialog
 
class  Root
 Wrapper class for Ogre::Root which handles the configuration paths. More...
 
class  Settings
 
class  SettingsInterface
 
class  SharedObjectData
 Stores and resolves object data of all different types such as units, abilities, items etc. More...
 
class  SkinData
 Stores all data for custom and standard skin data. More...
 
class  SkinEditor
 
class  SkinTreeModel
 The concrete tree model for skin data. More...
 
class  SlaveTest
 
class  SlkTextSource
 
class  SoundEditor
 
class  SourcesDialog
 GUI dialog which allows selection of sources based on class MpqPriorityList. More...
 
class  SplashScreen
 
class  TeamColorDialog
 
class  TerrainBrush
 
class  TerrainEditor
 
class  TextSourceInterface
 
class  Texture
 
class  TextureEditor
 
class  TriggerEditor
 The trigger editor is one of the most important modules of the World Editor when creating non-melee maps since it offers you the possibility to react on game events and therefore to define a completely new behaviour of the game. More...
 
class  TriggerFunctionDialog
 
class  TriggerTreeWidgetItem
 
class  TriggerWidget
 Widget for displaying and editing common triggers and custom text triggers. For both types, common triggers (with functions) and custom text triggers (with script code) there is a top widget which provides you a text edit for the trigger's comment and some buttons for enabling or disabling the trigger (enableTrigger()) and setting it initially on (setTriggerInitiallyOn()). The difference between common triggers and custom text triggers is that common triggers have functions displayed in a tree widget (functionsTreeWidget()) separated into events, conditions and actions. All functions of the shown trigger do have exactly one corresponding tree widget item in the tree widget which can be accessed via functions(). In contrast, custom text triggers do only need a text edit for their script code which can be accessed via textEdit(). More...
 
class  TxtTextSource
 
class  UnitData
 Stores all data for custom and standard units and unit meta data. More...
 
class  UnitEditor
 The Frozen Throne Unit Editor module of the Object Editor. More...
 
class  UnitSelectionDialog
 An icon listing dialog which allows the user to select a standard unit. More...
 
class  UnitTreeModel
 The concrete tree model for units. More...
 
class  UpgradeData
 
class  UpgradeEditor
 
class  UpgradeTreeModel
 
class  VariableDialog
 
class  VariablesDialog
 
class  ViewPortSettings
 Each view port includes one camera (and of course its settings). More...
 
class  WarcraftIIIShared
 Provides shared data such as standard textures, TXT and SLK files which are used by Warcraft III. More...
 
class  WaterData
 
class  WaterEditor
 
class  WaterTreeModel
 
class  WeatherData
 
class  WeatherEditor
 
class  WeatherTreeModel
 
class  WindowsMenu
 

Enumerations

enum  TeamColor {
  TeamColor::Red, TeamColor::Blue, TeamColor::Teal, TeamColor::Purple,
  TeamColor::Yellow, TeamColor::Orange, TeamColor::Green, TeamColor::Pink,
  TeamColor::Gray, TeamColor::LightBlue, TeamColor::DarkGreen, TeamColor::Brown,
  TeamColor::Black
}
 

Functions

int KDE_EXPORT kdemain (int argc, char **argv)
 
blp::color argbToColor (QRgb argb)
 
QRgb colorToArgb (blp::color c)
 
QVariant valueToVariant (const map::Value &value)
 
QString valueToString (const map::Value &value)
 
QColor teamColor (TeamColor teamColor)
 
TeamColor teamColor (const QColor &color)
 
KUrl teamColorUrl (TeamColor teamColor)
 
KUrl teamGlowUrl (TeamColor teamGlow)
 
QVariant registryEntry (const QString &key)
 
KUrl installUrl ()
 
KUrl installXUrl ()
 
KUrl war3Url ()
 
KUrl war3XUrl ()
 
KUrl war3PatchUrl ()
 
KUrl war3XLocalUrl ()
 
Ogre::Real ogreReal (float32 value)
 Global type cast function. More...
 
Ogre::Vector3 ogreVector3 (const mdlx::VertexData &vertexData)
 Global type cast function. More...
 
Ogre::Vector2 ogreVector2 (const Vertex2d< float32 > &textureVertexData)
 Global type cast function. More...
 
template<typename R , typename ValueType , std::size_t N>
ogreVertex (const BasicVertex< ValueType, N > &)
 
template<>
Ogre::Vector2 ogreVertex< Ogre::Vector2, float32, 2 > (const BasicVertex< float32, 2 > &vertex)
 
template<>
Ogre::Vector3 ogreVertex< Ogre::Vector3, float32, 3 > (const BasicVertex< float32, 3 > &vertex)
 
template<>
Ogre::Vector4 ogreVertex< Ogre::Vector4, float32, 4 > (const BasicVertex< float32, 4 > &vertex)
 
template<>
Ogre::Quaternion ogreVertex< Ogre::Quaternion, float32, 4 > (const BasicVertex< float32, 4 > &vertex)
 
QString mapFilter ()
 Returns the filter string for GUI dialogs which is required for Warcraft III map files. More...
 
QString objectsCollectionFilter ()
 Returns the filter string for GUI dialogs which is required for Warcraft III object collection files. More...
 
QString triggersFilter ()
 Returns the filter string for GUI dialogs which is required for Warcraft III trigger files. More...
 
QString customTextTriggersFilter ()
 Returns the filter string for GUI dialogs which is required for Warcraft III custom text trigger files. More...
 
void destroyAllAttachedMovableObjects (Ogre::SceneNode *node)
 Destroys node and all attached movable objects recursively. More...
 
void destroySceneNode (Ogre::SceneNode *node)
 From http://www.ogre3d.org/forums/viewtopic.php?f=2&t=53647. More...
 
QFileInfoList installedListfiles ()
 
bool removeDirRecursively (const QString &dirName)
 

Detailed Description

Editor module

Enumeration Type Documentation

Enumerator
Red 
Blue 
Teal 
Purple 
Yellow 
Orange 
Green 
Pink 
Gray 
LightBlue 
DarkGreen 
Brown 
Black 

Function Documentation

void wc3lib::editor::destroyAllAttachedMovableObjects ( Ogre::SceneNode *  node)
inline

Destroys node and all attached movable objects recursively.

From http://www.ogre3d.org/forums/viewtopic.php?f=2&t=53647

void wc3lib::editor::destroySceneNode ( Ogre::SceneNode *  node)
inline
QFileInfoList wc3lib::editor::installedListfiles ( )
inline

wc3lib brings some standard listfiles which are installed in a directory. These can be used if an MPQ archive does not contain its own listfile.

KUrl wc3lib::editor::installUrl ( )
inline
KUrl wc3lib::editor::installXUrl ( )
inline
int KDE_EXPORT wc3lib::editor::kdemain ( int  argc,
char **  argv 
)
Ogre::Real wc3lib::editor::ogreReal ( float32  value)
inline

Global type cast function.

Ogre::Vector2 wc3lib::editor::ogreVector2 ( const Vertex2d< float32 > &  textureVertexData)
inline

Global type cast function.

Ogre::Vector3 wc3lib::editor::ogreVector3 ( const mdlx::VertexData vertexData)
inline

Global type cast function.

template<typename R , typename ValueType , std::size_t N>
R wc3lib::editor::ogreVertex ( const BasicVertex< ValueType, N > &  )
inline
template<>
Ogre::Quaternion wc3lib::editor::ogreVertex< Ogre::Quaternion, float32, 4 > ( const BasicVertex< float32, 4 > &  vertex)
inline
template<>
Ogre::Vector2 wc3lib::editor::ogreVertex< Ogre::Vector2, float32, 2 > ( const BasicVertex< float32, 2 > &  vertex)
inline
template<>
Ogre::Vector3 wc3lib::editor::ogreVertex< Ogre::Vector3, float32, 3 > ( const BasicVertex< float32, 3 > &  vertex)
inline
template<>
Ogre::Vector4 wc3lib::editor::ogreVertex< Ogre::Vector4, float32, 4 > ( const BasicVertex< float32, 4 > &  vertex)
inline
QVariant wc3lib::editor::registryEntry ( const QString &  key)
inline

Reads Windows registry entry with key and returns the result. If wc3lib is compiled on a Unix system this will try to load the Windows registry provided by wine. Otherwise it returns just QVariant(). This function is mostly used for World Editor settings which are tried to reproduce by the editor module.

Todo:
Fix wine implementation http://www.c-plusplus.de/forum/292394
bool wc3lib::editor::removeDirRecursively ( const QString &  dirName)
inline
KUrl wc3lib::editor::teamColorUrl ( TeamColor  teamColor)
inline

Required by textures which use replaceable id mdlx::ReplaceableId::TeamColor.

See also
mdlx::ReplaceableId, mdlx::Texture
KUrl wc3lib::editor::teamGlowUrl ( TeamColor  teamGlow)
inline

Required by textures which use replaceable id mdlx::ReplaceableId::TeamGlow.

See also
mdlx::ReplaceableId, mdlx::Texture
QString wc3lib::editor::valueToString ( const map::Value value)
inline

Converts a Warcraft III object data value into a QString.

Parameters
valueThe value which is converted into a QString.
Returns
Returns a QString with the value's content.
See also
valueToVariant()
QVariant wc3lib::editor::valueToVariant ( const map::Value value)
inline

Converts a Warcraft III object data value into a QVariant keeping the type.

Parameters
valueThe value which is converted into a QVariant.
Returns
Returns a QVariant with the value's content keeping its underlying type.
See also
valueToString()
KUrl wc3lib::editor::war3PatchUrl ( )
inline
KUrl wc3lib::editor::war3Url ( )
inline
KUrl wc3lib::editor::war3XLocalUrl ( )
inline
KUrl wc3lib::editor::war3XUrl ( )
inline