ResidualVM logo ResidualVM website - Forums - Contact us BuildBot - Doxygen - Wiki curved edge

Stark::ResourceReference Class Reference

A reference to a resource. More...

#include <resourcereference.h>

Collaboration diagram for Stark::ResourceReference:

List of all members.

Classes

class  PathElement

Public Member Functions

 ResourceReference ()
Common::String describe () const
void loadFromStream (Common::ReadStream *stream)
 Read the reference from a stream.
void saveToStream (Common::WriteStream *stream)
 Write the reference to a stream.
void buildFromResource (Resources::Object *resource)
 Make the reference point to the specified object.
template<class T >
T * resolve () const
 Resolve the reference to the actual resource.
bool empty () const
 Return true if this reference is a null pointer.
bool canResolve () const
 Can this reference be resolved using currently loaded archives?

Private Member Functions

void addPathElement (Resources::Type type, uint16 index)
Resources::Objectresolve () const

Private Attributes

Common::Array< PathElement_path

Detailed Description

A reference to a resource.

Internally, the referenced resource is designed by its path in the resource tree.

Definition at line 40 of file resourcereference.h.


Constructor & Destructor Documentation

Stark::ResourceReference::ResourceReference (  ) 

Definition at line 44 of file resourcereference.cpp.


Member Function Documentation

void Stark::ResourceReference::addPathElement ( Resources::Type  type,
uint16  index 
) [private]

Definition at line 47 of file resourcereference.cpp.

void Stark::ResourceReference::buildFromResource ( Resources::Object resource  ) 

Make the reference point to the specified object.

Definition at line 161 of file resourcereference.cpp.

bool Stark::ResourceReference::canResolve (  )  const

Can this reference be resolved using currently loaded archives?

Definition at line 100 of file resourcereference.cpp.

Common::String Stark::ResourceReference::describe (  )  const

Definition at line 147 of file resourcereference.cpp.

bool Stark::ResourceReference::empty (  )  const

Return true if this reference is a null pointer.

Definition at line 143 of file resourcereference.cpp.

void Stark::ResourceReference::loadFromStream ( Common::ReadStream stream  ) 

Read the reference from a stream.

Definition at line 184 of file resourcereference.cpp.

Resources::Object* Stark::ResourceReference::resolve (  )  const [private]
template<class T >
T * Stark::ResourceReference::resolve (  )  const

Resolve the reference to the actual resource.

Definition at line 51 of file resourcereference.cpp.

void Stark::ResourceReference::saveToStream ( Common::WriteStream stream  ) 

Write the reference to a stream.

Definition at line 197 of file resourcereference.cpp.


Member Data Documentation


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


Generated on Sat Jan 19 2019 05:07:29 for ResidualVM by doxygen 1.7.1
curved edge   curved edge