GraphicFile Class Reference

The GraphicFile class defines the equivalent object from JugiMap Editor. More...

#include <jmSourceGraphics.h>

Inherited by GraphicFileAGK, GraphicFileCC, GraphicFileNC, and GraphicFileSFML.

Public Member Functions
virtual void	Init ()
	Initialize this GraphicFile. More...
FileKind	GetKind ()
	Returns the kind of this file. More...
std::string	GetRelativeFilePath ()
	Returns the relative file path of this file. More...
Vec2i	GetSize ()
	Returns the size of image if this file is an image. More...
std::vector< GraphicItem * > &	GetItems ()
	Returns a reference to the vector of stored graphic items in this file. More...
std::string	GetSpineAtlasRelativeFilePath ()
	Returns the relative file path of the spine atlas if this file is a Spine file. More...

Static Public Attributes
static std::string	pathPrefix
	An optional string attached to stored file paths. It must end with slash '/'! More...

Protected Member Functions
	GraphicFile ()
	Constructor. More...
virtual	~GraphicFile ()
	Destructor. More...

Detailed Description

The GraphicFile class defines the equivalent object from JugiMap Editor.

A graphic file stores GraphicItem objects and is their owner.

Constructor & Destructor Documentation

GraphicFile()

GraphicFile ( )

inlineprotected

Constructor.

~GraphicFile()

~GraphicFile ( )

protectedvirtual

Destructor.

Member Function Documentation

Init()

virtual void Init ( )

inlinevirtual

Initialize this GraphicFile.

This function is called by GraphicItem::Init and should not be called manually.

Reimplemented in GraphicFileAGK, GraphicFileNC, GraphicFileSFML, and GraphicFileCC.

GetKind()

FileKind GetKind ( )

inline

Returns the kind of this file.

GetRelativeFilePath()

std::string GetRelativeFilePath ( )

inline

Returns the relative file path of this file.

GetSize()

Vec2i GetSize ( )

inline

Returns the size of image if this file is an image.

GetItems()

std::vector<GraphicItem*>& GetItems ( )

inline

Returns a reference to the vector of stored graphic items in this file.

GetSpineAtlasRelativeFilePath()

std::string GetSpineAtlasRelativeFilePath ( )

inline

Returns the relative file path of the spine atlas if this file is a Spine file.

Member Data Documentation

pathPrefix

std::string pathPrefix

static

An optional string attached to stored file paths. It must end with slash '/'!

---

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

• C:/Development/JugiMapProject/JugiMapFRM/framework_c++/jugimap/jmSourceGraphics.h
• C:/Development/JugiMapProject/JugiMapFRM/framework_c++/jugimap/jmSourceGraphics.cpp