Rebel Fork Framework
Urho3D::TmxFile2D Class Reference

Tile map file. More...

#include <Urho3D/Urho2D/TmxFile2D.h>

Inheritance diagram for Urho3D::TmxFile2D:
Urho3D::Resource Urho3D::Object Urho3D::RefCounted

Public Member Functions

 TmxFile2D (Context *context)
 ~TmxFile2D () override
bool BeginLoad (Deserializer &source) override
 Load resource from stream. May be called from a worker thread. Return true if successful.
bool EndLoad () override
 Finish resource loading. Always called from the main thread. Return true if successful.
bool SetInfo (Orientation2D orientation, int width, int height, float tileWidth, float tileHeight)
 Set Tilemap information.
void AddLayer (unsigned index, TmxLayer2D *layer)
 Add layer at index, if index > number of layers then append to end.
void AddLayer (Urho3D::TmxLayer2D *layer)
 Append layer to end.
const TileMapInfo2DGetInfo () const
 Return Tilemap information.
Sprite2DGetTileSprite (unsigned gid) const
 Return tile sprite by gid, if not exist return 0.
ea::vector< SharedPtr< TileMapObject2D > > GetTileCollisionShapes (unsigned gid) const
 Return tile collision shapes for a given gid.
PropertySet2DGetTilePropertySet (unsigned gid) const
 Return tile property set by gid, if not exist return 0.
unsigned GetNumLayers () const
 Return number of layers.
const TmxLayer2DGetLayer (unsigned index) const
 Return layer at index.
void SetSpriteTextureEdgeOffset (float offset)
float GetSpriteTextureEdgeOffset () const
- Public Member Functions inherited from Urho3D::Resource
 Resource (Context *context)
bool Load (Deserializer &source)
 Load resource synchronously. Call both BeginLoad() & EndLoad() and return true if both succeeded.
virtual bool Save (Serializer &dest) const
 Save resource. Return true if successful.
bool LoadFile (const FileIdentifier &fileName)
 Load resource from file.
virtual bool SaveFile (const FileIdentifier &fileName) const
 Save resource to file.
void SetName (const ea::string &name)
void SetMemoryUse (unsigned size)
 Set memory use in bytes, possibly approximate.
void ResetUseTimer ()
 Reset last used timer.
void SetAsyncLoadState (AsyncLoadState newState)
 Set the asynchronous loading state. Called by ResourceCache. Resources in the middle of asynchronous loading are not normally returned to user.
void SetAbsoluteFileName (const ea::string &fileName)
 Set absolute file name.
const ea::string & GetName () const
StringHash GetNameHash () const
 Return name hash.
unsigned GetMemoryUse () const
unsigned GetUseTimer ()
AsyncLoadState GetAsyncLoadState () const
 Return the asynchronous loading state.
const ea::string & GetAbsoluteFileName () const
 Return absolute file name.
- Public Member Functions inherited from Urho3D::Object
 Object (Context *context)
 ~Object () override
 Destruct. Clean up self from event sender & receiver structures.
virtual StringHash GetType () const =0
virtual const ea::string & GetTypeName () const =0
virtual const TypeInfoGetTypeInfo () const =0
 Return type info.
virtual void OnEvent (Object *sender, StringHash eventType, VariantMap &eventData)
 Handle event.
virtual void SerializeInBlock (Archive &archive)
 Serialize content from/to archive. May throw ArchiveException.
bool IsInstanceOf (StringHash type) const
 Check current instance is type of specified type.
bool IsInstanceOf (const TypeInfo *typeInfo) const
 Check current instance is type of specified type.
template<typename T >
bool IsInstanceOf () const
 Check current instance is type of specified class.
template<typename T >
T * Cast ()
 Cast the object to specified most derived class.
template<typename T >
const T * Cast () const
 Cast the object to specified most derived class.
void SubscribeToEventManual (StringHash eventType, EventHandler *handler)
 Subscribe to an event that can be sent by any sender.
void SubscribeToEventManual (Object *sender, StringHash eventType, EventHandler *handler)
 Subscribe to a specific sender's event.
template<class T >
void SubscribeToEvent (StringHash eventType, T handler)
 Subscribe to an event that can be sent by any sender.
template<class T >
void SubscribeToEvent (Object *sender, StringHash eventType, T handler)
 Subscribe to a specific sender's event.
void UnsubscribeFromEvent (StringHash eventType)
 Unsubscribe from an event.
void UnsubscribeFromEvent (Object *sender, StringHash eventType)
 Unsubscribe from a specific sender's event.
void UnsubscribeFromEvents (Object *sender)
 Unsubscribe from a specific sender's events.
void UnsubscribeFromAllEvents ()
 Unsubscribe from all events.
void UnsubscribeFromAllEventsExcept (const ea::vector< StringHash > &exceptions)
 Unsubscribe from all events except those listed.
void UnsubscribeFromAllEventsExcept (const ea::vector< Object * > &exceptions)
 Unsubscribe from all events except those with listed senders.
void SendEvent (StringHash eventType)
 Send event to all subscribers.
void SendEvent (StringHash eventType, VariantMap &eventData)
 Send event with parameters to all subscribers.
VariantMapGetEventDataMap () const
 Return a preallocated map for event data. Used for optimization to avoid constant re-allocation of event data maps.
template<typename... Args>
void SendEvent (StringHash eventType, const Args &... args)
 Send event with variadic parameter pairs to all subscribers. The parameters are (paramID, paramValue) pairs.
ContextGetContext () const
 Return execution context.
const VariantGetGlobalVar (StringHash key) const
const VariantMapGetGlobalVars () const
void SetGlobalVar (StringHash key, const Variant &value)
ObjectGetSubsystem (StringHash type) const
 Return subsystem by type.
ObjectGetEventSender () const
 Return active event sender. Null outside event handling.
EventHandlerGetEventHandler () const
 Return active event handler. Null outside event handling.
bool HasSubscribedToEvent (StringHash eventType) const
 Return whether has subscribed to an event without specific sender.
bool HasSubscribedToEvent (Object *sender, StringHash eventType) const
 Return whether has subscribed to a specific sender's event.
bool HasEventHandlers () const
 Return whether has subscribed to any event.
template<class T >
T * GetSubsystem () const
 Template version of returning a subsystem.
const ea::string & GetCategory () const
void SendEvent (StringHash eventType, const VariantMap &eventData)
 Send event with parameters to all subscribers.
void SetBlockEvents (bool block)
 Block object from sending and receiving events.
bool GetBlockEvents () const
 Return sending and receiving events blocking status.
- Public Member Functions inherited from Urho3D::RefCounted
 RefCounted ()
 Construct. Allocate the reference count structure and set an initial self weak reference.
virtual ~RefCounted ()
 Destruct. Mark as expired and also delete the reference count structure if no outside weak references exist.
 RefCounted (const RefCounted &rhs)=delete
 Prevent copy construction.
RefCountedoperator= (const RefCounted &rhs)=delete
 Prevent assignment.
int AddRef ()
int ReleaseRef ()
int Refs () const
int WeakRefs () const
RefCountRefCountPtr () const
 Return pointer to the reference count structure.
bool HasScriptObject () const
 Return true if script runtime object wrapping this native object exists.
bool IsScriptStrongRef () const
 Return true if script reference is strong.

Static Public Member Functions

static void RegisterObject (Context *context)
- Static Public Member Functions inherited from Urho3D::Resource
static ResourceLoadFromCache (Context *context, StringHash type, const ea::string &name)
 Load resource by reference.
- Static Public Member Functions inherited from Urho3D::Object
static const TypeInfoGetTypeInfoStatic ()
 Return type info static.

Private Member Functions

 URHO3D_OBJECT (TmxFile2D, Resource)
SharedPtr< XMLFileLoadTSXFile (const ea::string &source)
 Load TSX file.
bool LoadTileSet (const XMLElement &element)
 Load tile set.

Private Attributes

SharedPtr< XMLFileloadXMLFile_
 XML file used during loading.
ea::unordered_map< ea::string, SharedPtr< XMLFile > > tsxXMLFiles_
 TSX name to XML file mapping.
TileMapInfo2D info_ {}
 Tile map information.
ea::unordered_map< unsigned, SharedPtr< Sprite2D > > gidToSpriteMapping_
 Gid to tile sprite mapping.
ea::unordered_map< unsigned, SharedPtr< PropertySet2D > > gidToPropertySetMapping_
 Gid to tile property set mapping.
ea::unordered_map< unsigned, ea::vector< SharedPtr< TileMapObject2D > > > gidToCollisionShapeMapping_
 Gid to tile collision shape mapping.
ea::vector< TmxLayer2D * > layers_
float edgeOffset_
 Texture edge offset.

Additional Inherited Members

- Protected Attributes inherited from Urho3D::Object
WeakPtr< Contextcontext_
 Execution context.

Detailed Description

Tile map file.

Member Function Documentation

◆ GetSpriteTextureEdgeOffset()

float Urho3D::TmxFile2D::GetSpriteTextureEdgeOffset ( ) const

Return texture edge offset, in pixels.

◆ RegisterObject()

void Urho3D::TmxFile2D::RegisterObject ( Context context)

Register object factory.

◆ SetSpriteTextureEdgeOffset()

void Urho3D::TmxFile2D::SetSpriteTextureEdgeOffset ( float  offset)

Set texture edge offset for all sprites, in pixels.

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