oxygine::Resource Class Reference

Inheritance diagram for oxygine::Resource:

Public Member Functions
void	load (LoadResourcesContext *context=0)
void	unload ()
pugi::xml_attribute	getAttribute (const char *attr) const
pugi::xml_node	getNode () const
bool	getUseLoadCounter () const
Resource *	getParent () const
void	setUseLoadCounter (bool v)
void	setParent (Resource *p)
Public Member Functions inherited from oxygine::Object
	Object (const Object &src)
	Object (bool assignUniqueID=true)
Public Member Functions inherited from oxygine::ref_counter
void	addRef ()
void	releaseRef ()
Public Member Functions inherited from oxygine::ObjectBase
	ObjectBase (const ObjectBase &src)
	ObjectBase (bool assignID=true)
const std::string &	getName () const
const void *	getUserData () const
int	getObjectID () const
bool	isName (const std::string &name) const
bool	isName (const char *name) const
void	setName (const std::string &name)
void	setUserData (const void *data)
void	dumpObject () const
void	__removeFromDebugList ()

Static Public Member Functions
static std::string	extractID (const pugi::xml_node &node, const std::string &file, const std::string &def)
static std::string	extractID (const std::string &file)
Static Public Member Functions inherited from oxygine::ObjectBase
static void	dumpCreatedObjects ()
static void	showAssertInCtor (int id)
static void	showAssertInDtor (int id)
static __createdObjects &	__getCreatedObjects ()
static void	__startTracingLeaks ()
static void	__stopTracingLeaks ()

Protected Member Functions
virtual void	_load (LoadResourcesContext *context=0)=0
virtual void	_unload ()=0
Protected Member Functions inherited from oxygine::Object
void	__doCheck ()
Protected Member Functions inherited from oxygine::ObjectBase
void	__generateID ()
std::string *	__getName () const
void	__freeName () const

Static Protected Member Functions
static void	setNode (Resource *res, const pugi::xml_node &node)
Static Protected Member Functions inherited from oxygine::ObjectBase
static void	__addToDebugList (ObjectBase *base)
static void	__removeFromDebugList (ObjectBase *base)

Protected Attributes
Resource *	_parent
int	_loadCounter
bool	_useLoadCounter
pugi::xml_node	_node
Protected Attributes inherited from oxygine::ObjectBase
std::string	__name
int	__id
const void *	__userData

Additional Inherited Members
Public Types inherited from oxygine::ObjectBase
typedef std::vector< ObjectBase * >	__createdObjects
Public Attributes inherited from oxygine::ref_counter
int	_ref_counter
Static Protected Attributes inherited from oxygine::ObjectBase
static int	_lastID
static int	_assertCtorID
static int	_assertDtorID

Member Function Documentation

extractID()

static std::string oxygine::Resource::extractID ( const pugi::xml_node &  node, const std::string &  file, const std::string &  def  )

static

returns id from xml node. Function is helper

getAttribute()

pugi::xml_attribute oxygine::Resource::getAttribute

(

const char *

attr

)

const

Returns any attribute from xml resource definition. You could use it for defining for example per animation constants like duration, specific offsets, delays.

load()

void oxygine::Resource::load

(

LoadResourcesContext *

context = 0

)

Loads resource heavy data into memory

unload()

void oxygine::Resource::unload

(

)

Unloads heavy data from memory. All internal Objects (fonts, textures, sounds etc) remain valid but not usable (can't be displayed, played etc).

---

The documentation for this class was generated from the following file:

• oxygine/src/res/Resource.h