The Beginner Guide to Resource Groups - Revision history

Capek: Bot: Automated text replacement (-\[\[(.?)\|.?\]\] +\1)

2011-03-03T23:52:40Z

Bot: Automated text replacement (-\[\[(.*?)\|.*?\]\] +\1)

Kulik at 16:32, 2 March 2011

2011-03-02T16:32:36Z

Kulik at 16:32, 2 March 2011

2011-03-02T16:32:21Z

Capek: Lets use instead of , it is much less typo-prone

2011-02-28T11:22:54Z

Lets use <source> instead of <syntaxhighlight>, it is much less typo-prone

Capek: Bot: Automated text replacement (-`[:space:]?(.*?)` +\1)

2011-02-27T12:48:39Z

Bot: Automated text replacement (-<code>[:space:]?<cpp/>(.*?)</code> +<syntaxhighlight lang="cpp">\1</syntaxhighlight>)

Capek: Robot: Cosmetic changes

2011-02-26T16:19:42Z

Robot: Cosmetic changes

Kulik at 12:04, 26 February 2011

2011-02-26T12:04:32Z

Makofierce at 09:43, 7 January 2011

2011-01-07T09:43:08Z

Kulik at 10:02, 1 October 2010

2010-10-01T10:02:11Z

Crazyeddie: Added version notice.

2009-09-14T13:53:22Z

Added version notice.

@@ Line 114: / Line 114: @@
 Here you have had a brief introduction to the DefaultResourceProvider class, you have seen how to create resource groups and assign directory locations to them, and you have also seen how to specify default resource groups for each resource type CEGUI uses.
-[[User:CrazyEddie|CrazyEddie]]
+[[User:CrazyEddie]]
 [[Category:Tutorials]]

@@ Line 1: / Line 1: @@
 {{VersionBadge|0.6}}
 {{Series|The Beginner Guide|2}}
 {{notice|message=This tutorial is for CEGUI versions up to 0.6.2.  For later releases, see the tutorials in the main documentation.}}

← Older revision		Revision as of 16:32, 2 March 2011
Line 1:		Line 1:
	{{VersionBadge\|0.6}}		{{VersionBadge\|0.6}}
		+	{{Series\|The Beginner Guide\|2}}
	{{notice\|message=This tutorial is for CEGUI versions up to 0.6.2. For later releases, see the tutorials in the main documentation.}}		{{notice\|message=This tutorial is for CEGUI versions up to 0.6.2. For later releases, see the tutorials in the main documentation.}}

@@ Line 24: / Line 24: @@
 A small code example is in order to clarify what has been said. Where as previously, without the use of resource groups, you might have done this:
-<syntaxhighlight lang="cpp">
+<source lang="cpp">
 Imageset* wlis = ImagesetManager::getSingleton().createImageset(
 	"./mygame/datafiles/gui/imagesets/WindowsLook.imageset");
-</syntaxhighlight>
+</source>
 Using resource groups, at initialisation time, you create the resource groups in the default resource provider, like this:
-<syntaxhighlight lang="cpp">
+<source lang="cpp">
 DefaultResourceProvider* rp = static_cast<DefaultResourceProvider*>(
 	CEGUI::System::getSingleton().getResourceProvider());
 rp->setResourceGroupDirectory("imagesets", "./mygame/datafiles/gui/imagesets/");
-</syntaxhighlight>
+</source>
 Then later on in the code, when you need to load the imageset, you can reference the resource group to be used, like this:
-<syntaxhighlight lang="cpp">
+<source lang="cpp">
 Imageset* wlis = ImagesetManager::getSingleton().createImageset(
 	"WindowsLook.imageset", "imagesets");
-</syntaxhighlight>
+</source>
 Note how you do not need to specify any path information; the path information is obtained from the resource group specified, in the example this is "imagesets". We will later show you how you set default resource groups for each of the resource types – then you do not have to specify the group when you load a resource (unless you're loading it from a group that is not the default, of course).
@@ Line 51: / Line 51: @@
 For each of the resource consuming classes, the static members are named the same (special exception is xerces – see below):
-<syntaxhighlight lang="cpp">
+<source lang="cpp">
 const String& getDefaultResourceGroup();
 void setDefaultResourceGroup(const String& groupname);
-</syntaxhighlight>
+</source>
 The following is a list of the core resource loading classes and the resources that they load:
@@ Line 66: / Line 66: @@
 There is one special exception, as mentioned above – that is the Xerces-C based XML parser. For this there is a special resource group setting to specify where the schema files can be found (these are the .xsd files used for xml validation). For this special case, the static members are:
-<syntaxhighlight lang="cpp">
+<source lang="cpp">
   const String& XercesParser::getSchemaDefaultResourceGroup();
   void XercesParser::setSchemaDefaultResourceGroup(const String& groupname);
-</syntaxhighlight>
+</source>
 One final thing to consider, is that the resource provider class also has a default group. This should be considered a 'global' default – it is used whenever a specific resource loading class has no default of its own specified. This could be useful if you have all your data in a single directory.
@@ Line 78: / Line 78: @@
 After initialising the core CEGUI::System object as usual, we then specify a set of resource groups and their target directories:
-<syntaxhighlight lang="cpp">
+<source lang="cpp">
 // initialise the required dirs for the DefaultResourceProvider
 CEGUI::DefaultResourceProvider* rp = static_cast<CEGUI::DefaultResourceProvider*>
@@ Line 93: / Line 93: @@
 // specify the schemas location
 rp->setResourceGroupDirectory("schemas", "../../XMLRefSchema/");
-</syntaxhighlight>
+</source>
 Now that is done, we have a nice set of resource groups defined with their target directories set. Finally, to get the system to use these new directories, we set the default resource groups to be used:
-<syntaxhighlight lang="cpp">
+<source lang="cpp">
 // set the default resource groups to be used
 CEGUI::Imageset::setDefaultResourceGroup("imagesets");
@@ Line 107: / Line 107: @@
 // defined a group for schemas.
 CEGUI::XercesParser::setSchemaDefaultResourceGroup("schemas");
-</syntaxhighlight>
+</source>
 == Conclusion ==

@@ Line 24: / Line 24: @@
 A small code example is in order to clarify what has been said. Where as previously, without the use of resource groups, you might have done this:
-<code><cpp/>
+<syntaxhighlight lang="cpp">
 Imageset* wlis = ImagesetManager::getSingleton().createImageset(
 	"./mygame/datafiles/gui/imagesets/WindowsLook.imageset");
-</code>
+</syntaxhighlight>
 Using resource groups, at initialisation time, you create the resource groups in the default resource provider, like this:
-<code><cpp/>
+<syntaxhighlight lang="cpp">
 DefaultResourceProvider* rp = static_cast<DefaultResourceProvider*>(
 	CEGUI::System::getSingleton().getResourceProvider());
 rp->setResourceGroupDirectory("imagesets", "./mygame/datafiles/gui/imagesets/");
-</code>
+</syntaxhighlight>
 Then later on in the code, when you need to load the imageset, you can reference the resource group to be used, like this:
-<code><cpp/>
+<syntaxhighlight lang="cpp">
 Imageset* wlis = ImagesetManager::getSingleton().createImageset(
 	"WindowsLook.imageset", "imagesets");
-</code>
+</syntaxhighlight>
 Note how you do not need to specify any path information; the path information is obtained from the resource group specified, in the example this is "imagesets". We will later show you how you set default resource groups for each of the resource types – then you do not have to specify the group when you load a resource (unless you're loading it from a group that is not the default, of course).
@@ Line 51: / Line 51: @@
 For each of the resource consuming classes, the static members are named the same (special exception is xerces – see below):
-<code><cpp/>
+<syntaxhighlight lang="cpp">
 const String& getDefaultResourceGroup();
 void setDefaultResourceGroup(const String& groupname);
-</code>
+</syntaxhighlight>
 The following is a list of the core resource loading classes and the resources that they load:
@@ Line 66: / Line 66: @@
 There is one special exception, as mentioned above – that is the Xerces-C based XML parser. For this there is a special resource group setting to specify where the schema files can be found (these are the .xsd files used for xml validation). For this special case, the static members are:
-<code><cpp/>
+<syntaxhighlight lang="cpp">
   const String& XercesParser::getSchemaDefaultResourceGroup();
   void XercesParser::setSchemaDefaultResourceGroup(const String& groupname);
-</code>
+</syntaxhighlight>
 One final thing to consider, is that the resource provider class also has a default group. This should be considered a 'global' default – it is used whenever a specific resource loading class has no default of its own specified. This could be useful if you have all your data in a single directory.
@@ Line 78: / Line 78: @@
 After initialising the core CEGUI::System object as usual, we then specify a set of resource groups and their target directories:
-<code><cpp/>
+<syntaxhighlight lang="cpp">
 // initialise the required dirs for the DefaultResourceProvider
 CEGUI::DefaultResourceProvider* rp = static_cast<CEGUI::DefaultResourceProvider*>
@@ Line 93: / Line 93: @@
 // specify the schemas location
 rp->setResourceGroupDirectory("schemas", "../../XMLRefSchema/");
-</code>
+</syntaxhighlight>
 Now that is done, we have a nice set of resource groups defined with their target directories set. Finally, to get the system to use these new directories, we set the default resource groups to be used:
-<code><cpp/>
+<syntaxhighlight lang="cpp">
 // set the default resource groups to be used
 CEGUI::Imageset::setDefaultResourceGroup("imagesets");
@@ Line 107: / Line 107: @@
 // defined a group for schemas.
 CEGUI::XercesParser::setSchemaDefaultResourceGroup("schemas");
-</code>
+</syntaxhighlight>
 == Conclusion ==

@@ Line 1: / Line 1: @@
-{{VersionBadge|0.6}} [[category: Tutorials]]
+{{VersionBadge|0.6}}
-−
 {{notice|message=This tutorial is for CEGUI versions up to 0.6.2.  For later releases, see the tutorials in the main documentation.}}
@@ Line 9: / Line 8: @@
 == What is a ResourceProvider? ==
-CEGUI makes use of a helper object which we call the ResourceProvider.  This object provides an interface between the core CEGUI library and any external file loading system.
+CEGUI makes use of a helper object which we call the ResourceProvider. This object provides an interface between the core CEGUI library and any external file loading system.
-For example, the Ogre and Irrlicht engines have their own resource manager / file loading sub-systems, by implementing and supplying a specialised ResourceProvider object, the renderer modules for these engines allow seamless integration with these systems so that CEGUI data files are loaded via these systems.  The lower level Direct3D and OpenGL libraries do not have their own resource systems as such, so for these you can use the CEGUI default resource provider.
+For example, the Ogre and Irrlicht engines have their own resource manager / file loading sub-systems, by implementing and supplying a specialised ResourceProvider object, the renderer modules for these engines allow seamless integration with these systems so that CEGUI data files are loaded via these systems. The lower level Direct3D and OpenGL libraries do not have their own resource systems as such, so for these you can use the CEGUI default resource provider.
 === DefaultResourceProvider Explained ===
-CEGUI's default resource provider, CEGUI::DefaultResourceProvider, supplies some basic functionality for those who do not yet have, or do not need, a more sophisticated alternative.  As well as supplying the functions required by CEGUI for actually loading files and data, DefaultResourceProvider also has some rudimentary support for 'resource groups'.  Here, a resource group is basically a label given to a directory or path on the system.  This allows us to have logical grouping of files within directories and then to be able to refer to those location via a simple label rather than hard coded paths.  In the simplest case this means that you just need to update the resource group location instead of updating path information throughout your code and in the XML files when you change the location of the data files.
+CEGUI's default resource provider, CEGUI::DefaultResourceProvider, supplies some basic functionality for those who do not yet have, or do not need, a more sophisticated alternative. As well as supplying the functions required by CEGUI for actually loading files and data, DefaultResourceProvider also has some rudimentary support for 'resource groups'. Here, a resource group is basically a label given to a directory or path on the system. This allows us to have logical grouping of files within directories and then to be able to refer to those location via a simple label rather than hard coded paths. In the simplest case this means that you just need to update the resource group location instead of updating path information throughout your code and in the XML files when you change the location of the data files.
 Before you can use the CEGUI::DefaultResourceProvider, you need to ensure you have included the correct header (usually at the start of your source file), for example:
 <code>
-#include <CEGUIDefaultResourceProvider.h>
+# include <CEGUIDefaultResourceProvider.h>
 </code>
 ==== Specifying Resource Groups and Directories ====
-The DefaultResourceProvider allows you to define any number of  named resource groups and to specify a directory to be used for each group.  What this means is that you can create a resource group, say “imagesets” and assign a directory to that, for example “./mygame/datafiles/gui/imagesets/”.  Then when loading an Imageset through the ImagesetManager, you could specify the resource group to be used as “imagesets” and the system will look in the predefined location.
+The DefaultResourceProvider allows you to define any number of named resource groups and to specify a directory to be used for each group. What this means is that you can create a resource group, say “imagesets” and assign a directory to that, for example “./mygame/datafiles/gui/imagesets/”. Then when loading an Imageset through the ImagesetManager, you could specify the resource group to be used as “imagesets” and the system will look in the predefined location.
 At present each resource group may only have a single directory assigned to it.
-A small code example is in order to clarify what has been said.  Where as previously, without the use of resource groups, you might have done this:
+A small code example is in order to clarify what has been said. Where as previously, without the use of resource groups, you might have done this:
 <code><cpp/>
 Imageset* wlis = ImagesetManager::getSingleton().createImageset(
@@ Line 44: / Line 43: @@
 </code>
-Note how you do not need to specify any path information; the path information is obtained from the resource group specified, in the example this is "imagesets".  We will later show you how you set default resource groups for each of the resource types – then you do not have to specify the group when you load a resource (unless you're loading it from a group that is not the default, of course).
+Note how you do not need to specify any path information; the path information is obtained from the resource group specified, in the example this is "imagesets". We will later show you how you set default resource groups for each of the resource types – then you do not have to specify the group when you load a resource (unless you're loading it from a group that is not the default, of course).
 Another important thing to consider is that using this approach, the data files should not contain relative path information – they should, in general, just have the actual file name.
 == Default Resource Groups ==
-Each of the system classes that represents a loadable resource has static members to set and get a default resource group.  This resource group will be used when loading the specific data files needed by a given class – in the case of the Imageset class, the default resource group should reference a directory holding the imageset xml and texture image files.
+Each of the system classes that represents a loadable resource has static members to set and get a default resource group. This resource group will be used when loading the specific data files needed by a given class – in the case of the Imageset class, the default resource group should reference a directory holding the imageset xml and texture image files.
 For each of the resource consuming classes, the static members are named the same (special exception is xerces – see below):
@@ Line 66: / Line 65: @@
   CEGUI::ScriptModule		- Script files in whichever scripted langauge.
-There is one special exception, as mentioned above – that is the Xerces-C based XML parser.  For this there is a special resource group setting to specify where the schema files can be found (these are the .xsd files used for xml validation).  For this special case, the static members are:
+There is one special exception, as mentioned above – that is the Xerces-C based XML parser. For this there is a special resource group setting to specify where the schema files can be found (these are the .xsd files used for xml validation). For this special case, the static members are:
 <code><cpp/>
   const String& XercesParser::getSchemaDefaultResourceGroup();
@@ Line 72: / Line 71: @@
 </code>
-One final thing to consider, is that the resource provider class also has a default group.  This should be considered a 'global' default – it is used whenever a specific resource loading class has no default of its own specified.  This could be useful if you have all your data in a single directory.
+One final thing to consider, is that the resource provider class also has a default group. This should be considered a 'global' default – it is used whenever a specific resource loading class has no default of its own specified. This could be useful if you have all your data in a single directory.
@@ Line 95: / Line 94: @@
 rp->setResourceGroupDirectory("schemas", "../../XMLRefSchema/");
 </code>
-Now that is done, we have a nice set of resource groups defined with their target directories set.  Finally, to get the system to use these new directories, we set the default resource groups to be used:
+Now that is done, we have a nice set of resource groups defined with their target directories set. Finally, to get the system to use these new directories, we set the default resource groups to be used:
 <code><cpp/>
 // set the default resource groups to be used
@@ Line 114: / Line 113: @@
 [[User:CrazyEddie|CrazyEddie]]

← Older revision		Revision as of 12:04, 26 February 2011
Line 1:		Line 1:
−	{{VersionBadge\|0.6}}	+	{{VersionBadge\|0.6}} [[category: Tutorials]]

	{{notice\|message=This tutorial is for CEGUI versions up to 0.6.2. For later releases, see the tutorials in the main documentation.}}		{{notice\|message=This tutorial is for CEGUI versions up to 0.6.2. For later releases, see the tutorials in the main documentation.}}

← Older revision		Revision as of 09:43, 7 January 2011
Line 72:		Line 72:
	</code>		</code>

−	One final thing to consider, is that the resource provider class also has a default group. This should be considered a 'global' default – it is used whenever a specific resource loading class has no default of ~~it's~~ own specified. This could be useful if you have all your data in a single directory.	+	One final thing to consider, is that the resource provider class also has a default group. This should be considered a 'global' default – it is used whenever a specific resource loading class has no default of its own specified. This could be useful if you have all your data in a single directory.

← Older revision		Revision as of 10:02, 1 October 2010
Line 1:		Line 1:
		+	{{VersionBadge\|0.6}}
		+
	{{notice\|message=This tutorial is for CEGUI versions up to 0.6.2. For later releases, see the tutorials in the main documentation.}}		{{notice\|message=This tutorial is for CEGUI versions up to 0.6.2. For later releases, see the tutorials in the main documentation.}}

← Older revision		Revision as of 13:53, 14 September 2009
Line 1:		Line 1:
		+	{{notice\|message=This tutorial is for CEGUI versions up to 0.6.2. For later releases, see the tutorials in the main documentation.}}
		+
	If you have read [[The Beginner Guide to Getting CEGUI Rendering]], you probably have your application set-up to perform the basic CEGUI initialisation steps and to call the System::renderGUI method, which is all very nice; but lets face it, you still can't get anything to draw!		If you have read [[The Beginner Guide to Getting CEGUI Rendering]], you probably have your application set-up to perform the basic CEGUI initialisation steps and to call the System::renderGUI method, which is all very nice; but lets face it, you still can't get anything to draw!

The Beginner Guide to Resource Groups - Revision history

Capek: Bot: Automated text replacement (-\[\[(.*?)\|.*?\]\] +\1)

Kulik at 16:32, 2 March 2011

Kulik at 16:32, 2 March 2011

Capek: Lets use instead of , it is much less typo-prone

Capek: Bot: Automated text replacement (-[:space:]?(.*?) +\1)

Capek: Robot: Cosmetic changes

Kulik at 12:04, 26 February 2011

Makofierce at 09:43, 7 January 2011

Kulik at 10:02, 1 October 2010

Crazyeddie: Added version notice.

Capek: Bot: Automated text replacement (-\[\[(.?)\|.?\]\] +\1)

Capek: Bot: Automated text replacement (-`[:space:]?(.*?)` +\1)