Gorgon Game Engine
Gorgon::Resource Namespace Reference

This namespace contains all Gorgon resources. More...

Namespaces

 GID
 
 internal
 

Classes

class  Animation
 This class represents an animation resource. More...
 
class  AnimationStorage
 This class denotes the resource is an image animation storage. More...
 
class  Base
 This class is the base for all Gorgon Resources. More...
 
class  Blob
 This is sound resource. More...
 
class  BoundsData
 
class  Data
 
class  DataItem
 
class  File
 This class represents a logical resource file. More...
 
class  FileReader
 This is a file reader. Allows a Gorgon Resource to be loaded from a file. More...
 
class  FileWriter
 Allows data to be written to a file. More...
 
class  FloatData
 
class  Folder
 This is basic folder resource, it contains other resources. More...
 
class  Font
 Font resource. More...
 
class  Image
 This resource contains images. More...
 
class  IntegerData
 
class  Line
 This is a line resource, it stores a Graphics::LineProvider. More...
 
class  Loader
 This class defines a resource loader. More...
 
class  LoadError
 This class represents a loading error. More...
 
class  MarginData
 
class  MaskedObject
 This is a masked object resource. More...
 
class  Null
 This is a null resource, it can be used in places where a resource is required but it is not wanted. More...
 
class  ObjectData
 
class  PointData
 
class  Pointer
 Pointer resource that can be used to create a new pointer to be displayed. More...
 
class  PointfData
 
class  Reader
 This class allows resource objects to read data from a stream. More...
 
class  Rectangle
 
class  RectangleData
 
class  ScalableObject
 This is a tinted object resource. More...
 
class  SizeData
 
class  Sound
 This is sound resource. More...
 
class  StackedObject
 This is a stacked object resource. More...
 
class  TextData
 
class  TintedObject
 This is a tinted object resource. More...
 
class  WriteError
 This error is fired to a write operations. More...
 
class  Writer
 This class allows resource objects to save their data to a stream. More...
 

Functions

template<>
Geometry::Bounds Data::Get< Geometry::Bounds > (int index) const
 
template<>
Geometry::Margin Data::Get< Geometry::Margin > (int index) const
 
template<>
Geometry::Point Data::Get< Geometry::Point > (int index) const
 
template<>
Geometry::Pointf Data::Get< Geometry::Pointf > (int index) const
 
template<>
Geometry::Rectangle Data::Get< Geometry::Rectangle > (int index) const
 
template<>
Geometry::Size Data::Get< Geometry::Size > (int index) const
 
template<>
std::string Data::Get< std::string > (int index) const
 
template<>
Geometry::Bounds DataItem::Get< Geometry::Bounds > () const
 
template<>
Geometry::Margin DataItem::Get< Geometry::Margin > () const
 
template<>
Geometry::Point DataItem::Get< Geometry::Point > () const
 
template<>
Geometry::Pointf DataItem::Get< Geometry::Pointf > () const
 
template<>
Geometry::Rectangle DataItem::Get< Geometry::Rectangle > () const
 
template<>
Geometry::Size DataItem::Get< Geometry::Size > () const
 
template<>
std::string DataItem::Get< std::string > () const
 
void Initialize ()
 
std::ostream & operator<< (std::ostream &out, const DataItem &item)
 
void SaveAnimation (Writer &writer, const Graphics::RectangularAnimationProvider &object)
 Saves a given generic rectangular animation as resource. More...
 
void SaveAnimation (Writer &writer, const Graphics::RectangularAnimationProvider *object)
 Saves a given generic rectangular animation as resource. More...
 

Detailed Description

This namespace contains all Gorgon resources.

Function Documentation

◆ Data::Get< Geometry::Bounds >()

◆ Data::Get< Geometry::Margin >()

◆ Data::Get< Geometry::Point >()

◆ Data::Get< Geometry::Pointf >()

◆ Data::Get< Geometry::Rectangle >()

◆ Data::Get< Geometry::Size >()

◆ Data::Get< std::string >()

std::string Gorgon::Resource::Data::Get< std::string > ( int  index) const

References DataItem::Get().

◆ DataItem::Get< Geometry::Bounds >()

◆ DataItem::Get< Geometry::Margin >()

◆ DataItem::Get< Geometry::Point >()

◆ DataItem::Get< Geometry::Pointf >()

◆ DataItem::Get< Geometry::Rectangle >()

◆ DataItem::Get< Geometry::Size >()

◆ DataItem::Get< std::string >()

std::string Gorgon::Resource::DataItem::Get< std::string > ( ) const

References DataItem::Get().

◆ Initialize()

void Initialize ( )

Gorgon system requires every module to have initialization function even if they are not used. Currently used for following tasks:

  • Set startup directory

    There is a mechanism to ensure initialization is performed once.

References DataItem::InitializeLoaders().

◆ operator<<()

std::ostream& Gorgon::Resource::operator<< ( std::ostream &  out,
const DataItem item 
)

References DataItem::ToString().

◆ SaveAnimation() [1/2]

void SaveAnimation ( Writer writer,
const Graphics::RectangularAnimationProvider object 
)

Saves a given generic rectangular animation as resource.

Only known animation types can be saved.

References Image::SaveThis(), Animation::SaveThis(), Line::SaveThis(), MaskedObject::SaveThis(), Rectangle::SaveThis(), ScalableObject::SaveThis(), StackedObject::SaveThis(), and TintedObject::SaveThis().

◆ SaveAnimation() [2/2]

void SaveAnimation ( Writer writer,
const Graphics::RectangularAnimationProvider object 
)

Saves a given generic rectangular animation as resource.

Only known animation types can be saved. In this version, if the object is null, it will be saved as Null object.

References SaveAnimation(), and Null::SaveThis().