Urho3D::SpriteSheet2D Class Reference
Public Member Functions |
Static Public Member Functions |
Private Member Functions |
Private Attributes |
List of all members
Urho3D::SpriteSheet2D Class Reference
#include <Urho3D/Urho2D/SpriteSheet2D.h>
Inheritance diagram for Urho3D::SpriteSheet2D:
Collaboration diagram for Urho3D::SpriteSheet2D:
Public Member Functions | |
| SpriteSheet2D (Context *context) | |
| Construct. | |
| ~SpriteSheet2D () override | |
| Destruct. | |
| 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. | |
| void | SetTexture (Texture2D *texture) |
| void | DefineSprite (const String &name, const IntRect &rectangle, const Vector2 &hotSpot=Vector2(0.5f, 0.5f), const IntVector2 &offset=IntVector2::ZERO) |
| Define sprite. | |
| Texture2D * | GetTexture () const |
| Sprite2D * | GetSprite (const String &name) const |
| Return sprite. | |
| const HashMap< String, SharedPtr< Sprite2D > > & | GetSpriteMapping () const |
| Return sprite mapping. | |
 Public Member Functions inherited from Urho3D::Resource | |
| Resource (Context *context) | |
| Construct. | |
| 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 String &fileName) |
| virtual bool | SaveFile (const String &fileName) const |
| void | SetName (const 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. | |
| const String & | GetName () const |
| StringHash | GetNameHash () const |
| Return name hash. | |
| unsigned | GetMemoryUse () const |
| unsigned | GetUseTimer () |
| AsyncLoadState | GetAsyncLoadState () const |
| Return the asynchronous loading state. | |
| Public Member Functions inherited from Urho3D::Object | |
| Object (Context *context) | |
| Construct. | |
| ~Object () override | |
| Destruct. Clean up self from event sender & receiver structures. | |
| virtual StringHash | GetType () const =0 |
| virtual const String & | GetTypeName () const =0 |
| virtual const TypeInfo * | GetTypeInfo () const =0 |
| Return type info. | |
| virtual void | OnEvent (Object *sender, StringHash eventType, VariantMap &eventData) |
| Handle event. | |
| 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 | SubscribeToEvent (StringHash eventType, EventHandler *handler) |
| Subscribe to an event that can be sent by any sender. | |
| void | SubscribeToEvent (Object *sender, StringHash eventType, EventHandler *handler) |
| Subscribe to a specific sender's event. | |
| void | SubscribeToEvent (StringHash eventType, const std::function< void(StringHash, VariantMap &)> &function, void *userData=nullptr) |
| Subscribe to an event that can be sent by any sender. | |
| void | SubscribeToEvent (Object *sender, StringHash eventType, const std::function< void(StringHash, VariantMap &)> &function, void *userData=nullptr) |
| 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 PODVector< StringHash > &exceptions, bool onlyUserData) |
| Unsubscribe from all events except those listed, and optionally only those with userdata (script registered events). | |
| void | SendEvent (StringHash eventType) |
| Send event to all subscribers. | |
| void | SendEvent (StringHash eventType, VariantMap &eventData) |
| Send event with parameters to all subscribers. | |
| VariantMap & | GetEventDataMap () 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, Args... args) |
| Send event with variadic parameter pairs to all subscribers. The parameter pairs is a list of paramID and paramValue separated by comma, one pair after another. | |
| Context * | GetContext () const |
| Return execution context. | |
| const Variant & | GetGlobalVar (StringHash key) const |
| const VariantMap & | GetGlobalVars () const |
| void | SetGlobalVar (StringHash key, const Variant &value) |
| Object * | GetSubsystem (StringHash type) const |
| Return subsystem by type. | |
| Object * | GetEventSender () const |
| Return active event sender. Null outside event handling. | |
| EventHandler * | GetEventHandler () 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 String & | GetCategory () const |
| 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. | |
| RefCounted & | operator= (const RefCounted &rhs)=delete |
| Prevent assignment. | |
| void | AddRef () |
| Increment reference count. Can also be called outside of a SharedPtr for traditional reference counting. | |
| void | ReleaseRef () |
| Decrement reference count and delete self if no more references. Can also be called outside of a SharedPtr for traditional reference counting. | |
| int | Refs () const |
| int | WeakRefs () const |
| RefCount * | RefCountPtr () |
| Return pointer to the reference count structure. | |
Static Public Member Functions | |
| static void | RegisterObject (Context *context) |
| Register object factory. | |
| Static Public Member Functions inherited from Urho3D::Object | |
| static const TypeInfo * | GetTypeInfoStatic () |
| Return type info static. | |
Private Member Functions | |
| URHO3D_OBJECT (SpriteSheet2D, Resource) | |
| bool | BeginLoadFromPListFile (Deserializer &source) |
| Begin load from PList file. | |
| bool | EndLoadFromPListFile () |
| End load from PList file. | |
| bool | BeginLoadFromXMLFile (Deserializer &source) |
| Begin load from XML file. | |
| bool | EndLoadFromXMLFile () |
| End load from XML file. | |
| bool | BeginLoadFromJSONFile (Deserializer &source) |
| Begin load from JSON file. | |
| bool | EndLoadFromJSONFile () |
| End load from JSON file. | |
Private Attributes | |
| SharedPtr< Texture2D > | texture_ |
| Texture. | |
| HashMap< String, SharedPtr< Sprite2D > > | spriteMapping_ |
| Sprite mapping. | |
| SharedPtr< PListFile > | loadPListFile_ |
| PList file used while loading. | |
| SharedPtr< XMLFile > | loadXMLFile_ |
| XML file used while loading. | |
| SharedPtr< JSONFile > | loadJSONFile_ |
| JSON file used while loading. | |
| String | loadTextureName_ |
| Texture name used while loading. | |
Additional Inherited Members | |
| Protected Attributes inherited from Urho3D::Object | |
| Context * | context_ |
| Execution context. | |
Detailed Description
Sprite sheet.
Member Function Documentation
◆ GetTexture()
|
inline |
Return texture.
◆ SetTexture()
| void Urho3D::SpriteSheet2D::SetTexture | ( | Texture2D * | texture | ) |
Set texture.
Here is the call graph for this function:
The documentation for this class was generated from the following files:
- Source/Urho3D/Urho2D/SpriteSheet2D.h
- Source/Urho3D/Urho2D/SpriteSheet2D.cpp